You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jetspeed-dev@portals.apache.org by wo...@apache.org on 2009/04/14 13:14:52 UTC

svn commit: r764739 - in /portals/jetspeed-2/portal/trunk: components/jetspeed-registry/src/main/java/org/apache/jetspeed/om/window/impl/PortletWindowImpl.java jetspeed-api/src/main/java/org/apache/jetspeed/portlet/HeaderPhaseSupportConstants.java

Author: woonsan
Date: Tue Apr 14 11:14:52 2009
New Revision: 764739

URL: http://svn.apache.org/viewvc?rev=764739&view=rev
Log:
JS2-961: Portal is now optimizing the contributed head element by merging each elements with same merging hint key.

Added:
    portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/portlet/HeaderPhaseSupportConstants.java   (with props)
Modified:
    portals/jetspeed-2/portal/trunk/components/jetspeed-registry/src/main/java/org/apache/jetspeed/om/window/impl/PortletWindowImpl.java

Modified: portals/jetspeed-2/portal/trunk/components/jetspeed-registry/src/main/java/org/apache/jetspeed/om/window/impl/PortletWindowImpl.java
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/components/jetspeed-registry/src/main/java/org/apache/jetspeed/om/window/impl/PortletWindowImpl.java?rev=764739&r1=764738&r2=764739&view=diff
==============================================================================
--- portals/jetspeed-2/portal/trunk/components/jetspeed-registry/src/main/java/org/apache/jetspeed/om/window/impl/PortletWindowImpl.java (original)
+++ portals/jetspeed-2/portal/trunk/components/jetspeed-registry/src/main/java/org/apache/jetspeed/om/window/impl/PortletWindowImpl.java Tue Apr 14 11:14:52 2009
@@ -16,8 +16,8 @@
  */
 package org.apache.jetspeed.om.window.impl;
 
-import java.io.Serializable;
 import java.util.HashMap;
+import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
 
@@ -34,6 +34,7 @@
 import org.apache.jetspeed.factory.PortletInstance;
 import org.apache.jetspeed.om.page.ContentFragment;
 import org.apache.jetspeed.om.portlet.PortletDefinition;
+import org.apache.jetspeed.portlet.HeaderPhaseSupportConstants;
 import org.apache.jetspeed.request.RequestContext;
 import org.apache.jetspeed.util.KeyValue;
 import org.apache.pluto.container.PortletEntity;
@@ -306,6 +307,7 @@
             // Refer to description in the javadoc for details.
             headElements = new TreeList();
             aggregateHeadElements(getFragment(), headElements);
+            mergeHeadElementsByHint(headElements);
         }
         
         return headElements;
@@ -363,5 +365,59 @@
             }
         }
     }
+    
+    private static void mergeHeadElementsByHint( List<KeyValue<String, Element>> headElements )
+    {
+        Map<String, Element> firstElementByMergeHint = new HashMap<String, Element>();
+        Map<String, StringBuilder> mergedTextContents = new HashMap<String, StringBuilder>();
+        
+        for (Iterator<KeyValue<String, Element>> it = headElements.iterator(); it.hasNext(); )
+        {
+            KeyValue<String, Element> kvPair = it.next();
+            Element element = kvPair.getValue();
+            
+            if (element.hasAttribute(HeaderPhaseSupportConstants.HEAD_ELEMENT_CONTRIBUTION_MERGE_HINT_ATTRIBUTE))
+            {
+                String mergeHint = element.getAttribute(HeaderPhaseSupportConstants.HEAD_ELEMENT_CONTRIBUTION_MERGE_HINT_ATTRIBUTE);
+                String textContent = element.getTextContent();
+                
+                if (textContent != null)
+                {
+                    textContent = textContent.trim();
+                }
+                
+                if (firstElementByMergeHint.containsKey(mergeHint))
+                {
+                    if (textContent != null && !"".equals(textContent))
+                    {
+                        StringBuilder sb = mergedTextContents.get(mergeHint);
+                        sb.append(textContent).append("\r\n");
+                    }
+                    
+                    it.remove();
+                }
+                else
+                {
+                    firstElementByMergeHint.put(mergeHint, element);
+                    StringBuilder sb = new StringBuilder();
+                    
+                    if (textContent != null && !"".equals(textContent))
+                    {
+                        sb.append(textContent).append("\r\n");
+                    }
+                    
+                    mergedTextContents.put(mergeHint, sb);
+                }
+            }
+        }
+        
+        for (Map.Entry<String, Element> entry : firstElementByMergeHint.entrySet())
+        {
+            String mergeHint = entry.getKey();
+            Element firstElement = entry.getValue();
+            StringBuilder sb = mergedTextContents.get(mergeHint);
+            firstElement.setTextContent(sb.toString());
+        }
+    }
 
 }

Added: portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/portlet/HeaderPhaseSupportConstants.java
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/portlet/HeaderPhaseSupportConstants.java?rev=764739&view=auto
==============================================================================
--- portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/portlet/HeaderPhaseSupportConstants.java (added)
+++ portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/portlet/HeaderPhaseSupportConstants.java Tue Apr 14 11:14:52 2009
@@ -0,0 +1,43 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.jetspeed.portlet;
+
+public interface HeaderPhaseSupportConstants
+{
+
+    /**
+     * An attribute name of head element contributed to the portal page aggregation by a portlet.
+     * The value of this attribute can be used by portal to merge contents of each contributed head element
+     * into centralized element(s).
+     * <BR/>
+     * For example, if a contributed head element has an attribute value, 'dojo.require', with text content, 'dojo.lang.*'
+     * and another contributed element has the same attribute value, 'dojo.require', with text content, 'dojo.event.*', then
+     * a portal can merge those contents into a single script element for optimization.
+     */
+    public static final String HEAD_ELEMENT_CONTRIBUTION_MERGE_HINT_ATTRIBUTE = "org.apache.portals.portal.page.head.element.contribution.merge.hint";
+
+    /**
+     * An attribute value for key hint which can be used in head elements merging by portal.  
+     */
+    public static final String HEAD_ELEMENT_CONTRIBUTION_MERGE_HINT_KEY_DOJO_JS_INCLUDE = "dojo.js.include";
+    
+    /**
+     * An attribute value for key hint which can be used in head elements merging by portal.  
+     */
+    public static final String HEAD_ELEMENT_CONTRIBUTION_MERGE_HINT_KEY_DOJO_REQUIRE = "dojo.require";
+
+}

Propchange: portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/portlet/HeaderPhaseSupportConstants.java
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/portlet/HeaderPhaseSupportConstants.java
------------------------------------------------------------------------------
    svn:keywords = Id

Propchange: portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/portlet/HeaderPhaseSupportConstants.java
------------------------------------------------------------------------------
    svn:mime-type = text/plain



---------------------------------------------------------------------
To unsubscribe, e-mail: jetspeed-dev-unsubscribe@portals.apache.org
For additional commands, e-mail: jetspeed-dev-help@portals.apache.org