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 ta...@apache.org on 2014/03/10 21:31:11 UTC
svn commit: r1576070 - in /portals/jetspeed-2/portal/trunk:
components/jetspeed-header-resource/src/main/java/org/apache/jetspeed/headerresource/impl/
components/jetspeed-page-layout/src/main/java/org/apache/jetspeed/layout/impl/
components/jetspeed-pa...
Author: taylor
Date: Mon Mar 10 20:31:10 2014
New Revision: 1576070
URL: http://svn.apache.org/r1576070
Log:
JS2-874: continued progress on jetspeed api + generics
Modified:
portals/jetspeed-2/portal/trunk/components/jetspeed-header-resource/src/main/java/org/apache/jetspeed/headerresource/impl/HeaderResourceFactoryImpl.java
portals/jetspeed-2/portal/trunk/components/jetspeed-header-resource/src/main/java/org/apache/jetspeed/headerresource/impl/HeaderResourceImpl.java
portals/jetspeed-2/portal/trunk/components/jetspeed-page-layout/src/main/java/org/apache/jetspeed/layout/impl/PageLayoutComponentImpl.java
portals/jetspeed-2/portal/trunk/components/jetspeed-page-layout/src/main/java/org/apache/jetspeed/om/page/impl/ContentSecurityConstraint.java
portals/jetspeed-2/portal/trunk/components/jetspeed-page-layout/src/test/java/org/apache/jetspeed/layout/AbstractTestPageLayout.java
portals/jetspeed-2/portal/trunk/components/jetspeed-portal/src/main/java/org/apache/jetspeed/velocity/JetspeedPowerToolImpl.java
portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/events/PortletEventQueue.java
portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/headerresource/HeaderResource.java
portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/headerresource/HeaderResourceFactory.java
portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/layout/JetspeedPowerTool.java
portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/layout/PageLayoutComponent.java
portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/locator/TemplateDescriptor.java
portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/locator/TemplateLocator.java
portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/om/common/SecurityConstraint.java
portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/om/common/SecurityConstraints.java
portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/om/folder/Folder.java
portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/om/folder/MenuDefinition.java
Modified: portals/jetspeed-2/portal/trunk/components/jetspeed-header-resource/src/main/java/org/apache/jetspeed/headerresource/impl/HeaderResourceFactoryImpl.java
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/components/jetspeed-header-resource/src/main/java/org/apache/jetspeed/headerresource/impl/HeaderResourceFactoryImpl.java?rev=1576070&r1=1576069&r2=1576070&view=diff
==============================================================================
--- portals/jetspeed-2/portal/trunk/components/jetspeed-header-resource/src/main/java/org/apache/jetspeed/headerresource/impl/HeaderResourceFactoryImpl.java (original)
+++ portals/jetspeed-2/portal/trunk/components/jetspeed-header-resource/src/main/java/org/apache/jetspeed/headerresource/impl/HeaderResourceFactoryImpl.java Mon Mar 10 20:31:10 2014
@@ -41,7 +41,7 @@ public class HeaderResourceFactoryImpl i
{
return new HeaderResourceImpl(requestContext);
}
- public HeaderResource getHeaderResource(RequestContext requestContext, BasePortalURL baseUrlAccess, boolean isDesktop, Map headerConfiguration )
+ public HeaderResource getHeaderResource(RequestContext requestContext, BasePortalURL baseUrlAccess, boolean isDesktop, Map<String, Object> headerConfiguration )
{
return new HeaderResourceImpl(requestContext, baseUrlAccess, isDesktop, headerConfiguration );
}
Modified: portals/jetspeed-2/portal/trunk/components/jetspeed-header-resource/src/main/java/org/apache/jetspeed/headerresource/impl/HeaderResourceImpl.java
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/components/jetspeed-header-resource/src/main/java/org/apache/jetspeed/headerresource/impl/HeaderResourceImpl.java?rev=1576070&r1=1576069&r2=1576070&view=diff
==============================================================================
--- portals/jetspeed-2/portal/trunk/components/jetspeed-header-resource/src/main/java/org/apache/jetspeed/headerresource/impl/HeaderResourceImpl.java (original)
+++ portals/jetspeed-2/portal/trunk/components/jetspeed-header-resource/src/main/java/org/apache/jetspeed/headerresource/impl/HeaderResourceImpl.java Mon Mar 10 20:31:10 2014
@@ -16,23 +16,23 @@
*/
package org.apache.jetspeed.headerresource.impl;
-import java.util.ArrayList;
-import java.util.HashMap;
-import java.util.Iterator;
-import java.util.LinkedHashSet;
-import java.util.List;
-import java.util.Map;
-import java.util.Set;
-
import org.apache.commons.lang.StringUtils;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
import org.apache.jetspeed.PortalReservedParameters;
import org.apache.jetspeed.container.url.BasePortalURL;
import org.apache.jetspeed.headerresource.HeaderResource;
import org.apache.jetspeed.headerresource.HeaderResourceLib;
import org.apache.jetspeed.portlet.HeaderPhaseSupportConstants;
import org.apache.jetspeed.request.RequestContext;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.LinkedHashSet;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
/**
* Default implementation for HeaderResource
@@ -55,7 +55,7 @@ public class HeaderResourceImpl implemen
private boolean isDesktop;
- private Map headerConfiguration;
+ private Map<String, Object> headerConfiguration;
// ... mutable output tracking
@@ -81,7 +81,7 @@ public class HeaderResourceImpl implemen
{
this.requestContext = context;
}
- public HeaderResourceImpl( RequestContext context, BasePortalURL baseUrlAccess, boolean isDesktop, Map headerConfiguration )
+ public HeaderResourceImpl( RequestContext context, BasePortalURL baseUrlAccess, boolean isDesktop, Map<String, Object> headerConfiguration )
{
this.requestContext = context;
this.baseUrlAccess = baseUrlAccess;
@@ -684,7 +684,7 @@ public class HeaderResourceImpl implemen
*
* @return Map containing modifiable header configuration settings
*/
- public Map getHeaderDynamicConfiguration()
+ public Map<String, Object> getHeaderDynamicConfiguration()
{
if ( this.headerDynamicConfiguration == null )
{
@@ -760,7 +760,7 @@ public class HeaderResourceImpl implemen
*
* @return unmodifiable Map containing complete header configuration settings
*/
- public Map getHeaderConfiguration()
+ public Map<String, Object> getHeaderConfiguration()
{
return this.headerConfiguration;
}
@@ -1078,7 +1078,7 @@ public class HeaderResourceImpl implemen
* @see org.apache.jetspeed.headerresource.impl.HeaderResource#addHeaderInfo(java.lang.String,
* java.util.Map,java.lang.String)
*/
- public void addHeaderInfo(String elementName, Map attributes, String text)
+ public void addHeaderInfo(String elementName, Map<String, String> attributes, String text)
{
HeaderInfo headerInfo = new HeaderInfo(elementName, attributes, text);
if (!containsHeaderInfo(headerInfo))
Modified: portals/jetspeed-2/portal/trunk/components/jetspeed-page-layout/src/main/java/org/apache/jetspeed/layout/impl/PageLayoutComponentImpl.java
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/components/jetspeed-page-layout/src/main/java/org/apache/jetspeed/layout/impl/PageLayoutComponentImpl.java?rev=1576070&r1=1576069&r2=1576070&view=diff
==============================================================================
--- portals/jetspeed-2/portal/trunk/components/jetspeed-page-layout/src/main/java/org/apache/jetspeed/layout/impl/PageLayoutComponentImpl.java (original)
+++ portals/jetspeed-2/portal/trunk/components/jetspeed-page-layout/src/main/java/org/apache/jetspeed/layout/impl/PageLayoutComponentImpl.java Mon Mar 10 20:31:10 2014
@@ -16,15 +16,6 @@
*/
package org.apache.jetspeed.layout.impl;
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.HashMap;
-import java.util.Iterator;
-import java.util.List;
-import java.util.ListIterator;
-import java.util.Locale;
-import java.util.Map;
-
import org.apache.jetspeed.JetspeedActions;
import org.apache.jetspeed.layout.PageLayoutComponent;
import org.apache.jetspeed.om.common.SecurityConstraint;
@@ -62,6 +53,15 @@ import org.apache.pluto.container.Portle
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.List;
+import java.util.ListIterator;
+import java.util.Locale;
+import java.util.Map;
+
/**
* Page layout component implementation.
*
@@ -658,7 +658,7 @@ public class PageLayoutComponentImpl imp
/* (non-Javadoc)
* @see org.apache.jetspeed.layout.PageLayoutComponent#newContentPage(org.apache.jetspeed.om.page.BaseFragmentsElement, org.apache.jetspeed.om.page.PageTemplate, java.util.Map)
*/
- public ContentPage newContentPage(BaseFragmentsElement pageOrTemplate, PageTemplate pageTemplate, Map fragmentDefinitions)
+ public ContentPage newContentPage(BaseFragmentsElement pageOrTemplate, PageTemplate pageTemplate, Map<String, FragmentDefinition> fragmentDefinitions)
{
// generate content page
BaseConcretePageElement concretePage = ((pageOrTemplate instanceof BaseConcretePageElement) ? (BaseConcretePageElement)pageOrTemplate : null);
@@ -1646,7 +1646,7 @@ public class PageLayoutComponentImpl imp
/* (non-Javadoc)
* @see org.apache.jetspeed.layout.PageLayoutComponent#updatePreferences(org.apache.jetspeed.om.page.ContentFragment, java.util.Map)
*/
- public void updatePreferences(ContentFragment contentFragment, Map preferences)
+ public void updatePreferences(ContentFragment contentFragment, Map<String, Object> preferences)
{
log.debug("PageLayoutComponentImpl.updatePreferences() invoked");
try
@@ -2367,7 +2367,6 @@ public class PageLayoutComponentImpl imp
* @param pageOrTemplate PSML page or template
* @param definition PSML fragment page, page template, or fragments definition
* @param fragmentReference PSML fragment
- * @param fragmentFragment referenced root PSML fragment from fragment definition
* @return content fragment hierarchy or null if undefined
*/
private ContentFragmentImpl newContentFragment(String parentId, BaseFragmentsElement pageOrTemplate, BaseFragmentsElement definition, FragmentReference fragmentReference)
@@ -2393,7 +2392,6 @@ public class PageLayoutComponentImpl imp
* @param definition PSML fragment page, page template, or fragments definition
* @param fragment PSML fragment
* @param reference PSML fragment reference
- * @param pageReference page fragment reference flag
* @param template template fragment flag
* @param locked locked fragment flag
* @return content fragment hierarchy or null if undefined
Modified: portals/jetspeed-2/portal/trunk/components/jetspeed-page-layout/src/main/java/org/apache/jetspeed/om/page/impl/ContentSecurityConstraint.java
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/components/jetspeed-page-layout/src/main/java/org/apache/jetspeed/om/page/impl/ContentSecurityConstraint.java?rev=1576070&r1=1576069&r2=1576070&view=diff
==============================================================================
--- portals/jetspeed-2/portal/trunk/components/jetspeed-page-layout/src/main/java/org/apache/jetspeed/om/page/impl/ContentSecurityConstraint.java (original)
+++ portals/jetspeed-2/portal/trunk/components/jetspeed-page-layout/src/main/java/org/apache/jetspeed/om/page/impl/ContentSecurityConstraint.java Mon Mar 10 20:31:10 2014
@@ -16,10 +16,10 @@
*/
package org.apache.jetspeed.om.page.impl;
-import java.util.List;
-
import org.apache.jetspeed.om.common.SecurityConstraint;
+import java.util.List;
+
/**
* Content security constraint implementation.
*
@@ -29,10 +29,10 @@ import org.apache.jetspeed.om.common.Sec
public class ContentSecurityConstraint implements SecurityConstraint
{
private boolean mutable;
- private List groups;
- private List permissions;
- private List roles;
- private List users;
+ private List<String> groups;
+ private List<String> permissions;
+ private List<String> roles;
+ private List<String> users;
/**
* Construct new security constraint implementation.
@@ -55,7 +55,7 @@ public class ContentSecurityConstraint i
/* (non-Javadoc)
* @see org.apache.jetspeed.om.common.SecurityConstraint#getGroups()
*/
- public List getGroups()
+ public List<String> getGroups()
{
return groups;
}
@@ -63,7 +63,7 @@ public class ContentSecurityConstraint i
/* (non-Javadoc)
* @see org.apache.jetspeed.om.common.SecurityConstraint#getPermissions()
*/
- public List getPermissions()
+ public List<String> getPermissions()
{
return permissions;
}
@@ -71,7 +71,7 @@ public class ContentSecurityConstraint i
/* (non-Javadoc)
* @see org.apache.jetspeed.om.common.SecurityConstraint#getRoles()
*/
- public List getRoles()
+ public List<String> getRoles()
{
return roles;
}
@@ -79,7 +79,7 @@ public class ContentSecurityConstraint i
/* (non-Javadoc)
* @see org.apache.jetspeed.om.common.SecurityConstraint#getUsers()
*/
- public List getUsers()
+ public List<String> getUsers()
{
return users;
}
@@ -87,7 +87,7 @@ public class ContentSecurityConstraint i
/* (non-Javadoc)
* @see org.apache.jetspeed.om.common.SecurityConstraint#setGroups(java.util.List)
*/
- public void setGroups(List groups)
+ public void setGroups(List<String> groups)
{
if (!mutable)
{
@@ -99,7 +99,7 @@ public class ContentSecurityConstraint i
/* (non-Javadoc)
* @see org.apache.jetspeed.om.common.SecurityConstraint#setPermissions(java.util.List)
*/
- public void setPermissions(List permissions)
+ public void setPermissions(List<String> permissions)
{
if (!mutable)
{
@@ -111,7 +111,7 @@ public class ContentSecurityConstraint i
/* (non-Javadoc)
* @see org.apache.jetspeed.om.common.SecurityConstraint#setRoles(java.util.List)
*/
- public void setRoles(List roles)
+ public void setRoles(List<String> roles)
{
if (!mutable)
{
Modified: portals/jetspeed-2/portal/trunk/components/jetspeed-page-layout/src/test/java/org/apache/jetspeed/layout/AbstractTestPageLayout.java
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/components/jetspeed-page-layout/src/test/java/org/apache/jetspeed/layout/AbstractTestPageLayout.java?rev=1576070&r1=1576069&r2=1576070&view=diff
==============================================================================
--- portals/jetspeed-2/portal/trunk/components/jetspeed-page-layout/src/test/java/org/apache/jetspeed/layout/AbstractTestPageLayout.java (original)
+++ portals/jetspeed-2/portal/trunk/components/jetspeed-page-layout/src/test/java/org/apache/jetspeed/layout/AbstractTestPageLayout.java Mon Mar 10 20:31:10 2014
@@ -572,7 +572,7 @@ public abstract class AbstractTestPageLa
Page page = pageManager.getPage("/page.psml");
assertNotNull(page);
- ContentPage pageContentPage = pageLayout.newContentPage(page, pageManager.getPageTemplate("/template.tpsml"), Collections.emptyMap());
+ ContentPage pageContentPage = pageLayout.newContentPage(page, pageManager.getPageTemplate("/template.tpsml"), Collections.<String, FragmentDefinition>emptyMap());
assertNotNull(pageContentPage);
ContentFragment contentFrag = pageContentPage.getFragmentByFragmentId("fake-portlet");
assertNotNull(contentFrag);
Modified: portals/jetspeed-2/portal/trunk/components/jetspeed-portal/src/main/java/org/apache/jetspeed/velocity/JetspeedPowerToolImpl.java
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/components/jetspeed-portal/src/main/java/org/apache/jetspeed/velocity/JetspeedPowerToolImpl.java?rev=1576070&r1=1576069&r2=1576070&view=diff
==============================================================================
--- portals/jetspeed-2/portal/trunk/components/jetspeed-portal/src/main/java/org/apache/jetspeed/velocity/JetspeedPowerToolImpl.java (original)
+++ portals/jetspeed-2/portal/trunk/components/jetspeed-portal/src/main/java/org/apache/jetspeed/velocity/JetspeedPowerToolImpl.java Mon Mar 10 20:31:10 2014
@@ -16,24 +16,6 @@
*/
package org.apache.jetspeed.velocity;
-import java.io.IOException;
-import java.io.PrintWriter;
-import java.io.Writer;
-import java.security.Principal;
-import java.util.HashSet;
-import java.util.List;
-import java.util.Locale;
-import java.util.Map;
-import java.util.Set;
-
-import javax.portlet.PortletConfig;
-import javax.portlet.PortletMode;
-import javax.portlet.RenderRequest;
-import javax.portlet.RenderResponse;
-import javax.portlet.WindowState;
-import javax.security.auth.Subject;
-import javax.servlet.http.HttpServletRequest;
-
import org.apache.commons.configuration.Configuration;
import org.apache.commons.configuration.PropertiesConfiguration;
import org.apache.jetspeed.Jetspeed;
@@ -63,6 +45,23 @@ import org.apache.velocity.context.Conte
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+import javax.portlet.PortletConfig;
+import javax.portlet.PortletMode;
+import javax.portlet.RenderRequest;
+import javax.portlet.RenderResponse;
+import javax.portlet.WindowState;
+import javax.security.auth.Subject;
+import javax.servlet.http.HttpServletRequest;
+import java.io.IOException;
+import java.io.PrintWriter;
+import java.io.Writer;
+import java.security.Principal;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Locale;
+import java.util.Map;
+import java.util.Set;
+
/**
* <p>
* JetspeedPowerTool
@@ -697,7 +696,7 @@ public class JetspeedPowerToolImpl imple
* </p>
* Returns the appropriate for the title based on locale prferences
*
- * @param entity
+ * @param f
* @return
*/
public String getTitle(ContentFragment f)
@@ -831,7 +830,7 @@ public class JetspeedPowerToolImpl imple
*
* @param name
* to store the attribute under.
- * @param obj
+ * @param object
* object to set.
*/
protected void setAttribute(String name, Object object)
Modified: portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/events/PortletEventQueue.java
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/events/PortletEventQueue.java?rev=1576070&r1=1576069&r2=1576070&view=diff
==============================================================================
--- portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/events/PortletEventQueue.java (original)
+++ portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/events/PortletEventQueue.java Mon Mar 10 20:31:10 2014
@@ -16,10 +16,10 @@
*/
package org.apache.jetspeed.events;
-import java.util.List;
-
import org.apache.jetspeed.container.PortletWindow;
+import java.util.List;
+
/**
* @author <a href="mailto:taylor@apache.org">David Sean Taylor</a>
@@ -27,6 +27,18 @@ import org.apache.jetspeed.container.Por
*/
public interface PortletEventQueue
{
+ /**
+ * Publish a Portlet API Event internally in Jetspeed
+ *
+ * @param event
+ */
void publishEvent(ProcessEvent event);
+
+ /**
+ * Remove an event from Portlet API queue
+ *
+ * @param window
+ * @return List of remaining events
+ */
List<ProcessEvent> dequeueEvents(PortletWindow window);
}
\ No newline at end of file
Modified: portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/headerresource/HeaderResource.java
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/headerresource/HeaderResource.java?rev=1576070&r1=1576069&r2=1576070&view=diff
==============================================================================
--- portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/headerresource/HeaderResource.java (original)
+++ portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/headerresource/HeaderResource.java Mon Mar 10 20:31:10 2014
@@ -16,10 +16,10 @@
*/
package org.apache.jetspeed.headerresource;
-import java.util.Map;
-
import org.apache.jetspeed.portlet.HeaderPhaseSupportConstants;
+import java.util.Map;
+
/**
* HeaderResource has tags information to put them into <head> tag.
*
@@ -229,14 +229,14 @@ public interface HeaderResource
*
* @return Map containing modifiable header configuration settings
*/
- public Map getHeaderDynamicConfiguration();
+ public Map<String, Object> getHeaderDynamicConfiguration();
/**
* Access complete header configuration settings
*
* @return unmodifiable Map containing complete header configuration settings
*/
- public Map getHeaderConfiguration();
+ public Map<String, Object> getHeaderConfiguration();
/**
* Is request for /desktop rather than /portal
@@ -368,7 +368,7 @@ public interface HeaderResource
* @param attributes Tag's attributes
* @param text Tag's content
*/
- public void addHeaderInfo(String elementName, Map attributes, String text);
+ public void addHeaderInfo(String elementName, Map<String, String> attributes, String text);
/**
* Add text as-is to this instance.
Modified: portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/headerresource/HeaderResourceFactory.java
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/headerresource/HeaderResourceFactory.java?rev=1576070&r1=1576069&r2=1576070&view=diff
==============================================================================
--- portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/headerresource/HeaderResourceFactory.java (original)
+++ portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/headerresource/HeaderResourceFactory.java Mon Mar 10 20:31:10 2014
@@ -16,13 +16,12 @@
*/
package org.apache.jetspeed.headerresource;
-import java.util.Map;
-
-import javax.portlet.PortletRequest;
-
import org.apache.jetspeed.container.url.BasePortalURL;
import org.apache.jetspeed.request.RequestContext;
+import javax.portlet.PortletRequest;
+import java.util.Map;
+
/**
* HeaderResourceFactory provides HeaderResource instance to manage tags, such
* as <link> and <script>, in <head> tag.
@@ -51,7 +50,8 @@ public interface HeaderResourceFactory
* @param requestContext
* @return
*/
- public abstract HeaderResource getHeaderResource( RequestContext requestContext, BasePortalURL baseUrlAccess, boolean isDesktop, Map headerConfiguration );
+ public abstract HeaderResource getHeaderResource( RequestContext requestContext, BasePortalURL baseUrlAccess,
+ boolean isDesktop, Map<String, Object> headerConfiguration );
/**
* Provides HeaderResource instance from PortletRequest.
Modified: portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/layout/JetspeedPowerTool.java
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/layout/JetspeedPowerTool.java?rev=1576070&r1=1576069&r2=1576070&view=diff
==============================================================================
--- portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/layout/JetspeedPowerTool.java (original)
+++ portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/layout/JetspeedPowerTool.java Mon Mar 10 20:31:10 2014
@@ -16,24 +16,23 @@
*/
package org.apache.jetspeed.layout;
-import java.io.IOException;
-import java.util.List;
-import java.util.Map;
-
-import javax.portlet.PortletMode;
-import javax.portlet.WindowState;
-import javax.security.auth.Subject;
-
import org.apache.jetspeed.administration.PortalConfiguration;
import org.apache.jetspeed.container.PortletWindow;
+import org.apache.jetspeed.decoration.DecoratorAction;
import org.apache.jetspeed.locator.TemplateDescriptor;
import org.apache.jetspeed.locator.TemplateLocatorException;
import org.apache.jetspeed.om.page.ContentFragment;
import org.apache.jetspeed.om.page.ContentPage;
import org.apache.jetspeed.portlet.HeadElement;
-import org.apache.jetspeed.request.RequestContext;
import org.apache.jetspeed.util.KeyValue;
+import javax.portlet.PortletMode;
+import javax.portlet.WindowState;
+import javax.security.auth.Subject;
+import java.io.IOException;
+import java.util.List;
+import java.util.Map;
+
/**
* JetspeedPowerTool
*
@@ -91,66 +90,79 @@ public interface JetspeedPowerTool
PortletMode getMappedPortletMode() throws Exception;
/**
- *
- * @return
+ * The Power Tool tracks which fragment is being rendered. This method returns the current fragment.
+ *
+ * @return the current fragment being rendered
*/
ContentFragment getCurrentFragment();
/**
- *
- * @param f
+ * The Power Tool tracks which fragment is being rendered. This method sets the current fragment
+ *
+ * @param fragment current fragment to render
*/
- void setCurrentFragment(ContentFragment f);
+ void setCurrentFragment(ContentFragment fragment);
+ /**
+ * The Power Tool tracks which layout is being rendered. This method sets the current layout to the current fragment,
+ * if the current fragment is a layout
+ */
void setCurrentLayout();
/**
- *
- * @return
+ * The Power Tool tracks which layout is being rendered. This method gets the current layout
+ * @return the current layout
*/
ContentFragment getCurrentLayout();
/**
- *
- * @return
+ * The Power Tool tracks which page is being rendered. This method gets the current page
+ *
+ * @return the current page being rendered
*/
ContentPage getPage();
/**
- *
- * @return
+ * For tabular layouts, the Power Tool can provide the set of columns being rendered for layout
+ *
+ * @deprecated
+ * @return an array of lists of content {@link org.apache.jetspeed.om.page.ContentFragment}
*/
List[] getColumns();
- List getColumnSizes();
+ /**
+ * For tabular layouts, return the column sizes, usually as percentages but can be any table sizing such pixels
+ *
+ * @return list of column sizes, usually percentages
+ */
+ List<String> getColumnSizes();
/**
- *
- * @param f
+ * Return the associated PortletWindow for a given fragment
+ *
+ * @param fragment
* Fragment whose <code>PortletWindow</code> we want to
* retrieve.
* @return The PortletWindow represented by the current fragment.
* @throws Exception
*/
- PortletWindow getPortletWindow(ContentFragment f) throws Exception;
+ PortletWindow getPortletWindow(ContentFragment fragment) throws Exception;
/**
* Checks the the visibilty of this fragment with respect to the current
* RenderReqeust.
*
- * @param f
+ * @param fragment
* Fragment
* @return whether or not the Fragment in question should be considered
* visible during rendering.
*/
- boolean isHidden(ContentFragment f);
+ boolean isHidden(ContentFragment fragment);
/**
- * Retreives a template using Jetspeed's
- *
+ * Retrieves a template using the Jetspeed template locator algorithm
* @see org.apache.jetspeed.locator.TemplateLocator
- *
- *
+ *
* @param path
* Expected to the template. This may actually be changed by the
* TL service based the capability and localization information
@@ -165,99 +177,159 @@ public interface JetspeedPowerTool
TemplateDescriptor getTemplate(String path, String templateType)
throws TemplateLocatorException;
+ /**
+ * Retrieves a decorator using the Jetspeed template locator algorithm
+ * @see org.apache.jetspeed.locator.TemplateLocator
+ *
+ * @param path
+ * Expected to the template. This may actually be changed by the
+ * TL service based the capability and localization information
+ * provided by the client.
+ * @param templateType
+ * Type off template we are interested in.
+ * @return Template object containing the pertinent information required to
+ * inlcude the request template path in the current response
+ * @throws TemplateLocatorException
+ * if the <code>path</code> does not exist.
+ */
TemplateDescriptor getDecoration(String path, String templateType)
throws TemplateLocatorException;
+ /**
+ * Include a template into the rendering stream at the current position in layout
+ *
+ * @param template name of template to include
+ * @param templateType the type either portlet or layout
+ * @return the content of the layout
+ * @throws IOException
+ */
String includeTemplate(String template, String templateType)
throws IOException;
+ /**
+ * Include a decorator into the rendering stream at the current position in layout
+ *
+ * @param template name of template to include
+ * @param templateType the type either portlet or layout
+ * @return the content of the layout
+ * @throws IOException
+ */
String includeDecoration(String template, String templateType)
throws IOException;
/**
- * <p>
* Decorate and include fragment content.
- * </p>
- *
- * @param f
+ *
+ * @param fragment
* Fragment to include and decorate
* @throws Exception
* @return String path to the decorator.
*/
- String decorateAndInclude(ContentFragment f) throws Exception;
+ String decorateAndInclude(ContentFragment fragment) throws Exception;
/**
* Gets the list of decorator actions for a window. Each window (on each
* page) has its own collection of actionAccess flags associated with it.
*
- * @return A list of actions available to the current window, filtered by
- * securty access and current state.
+ * @return A list of {@link org.apache.jetspeed.decoration.DecoratorAction} available to the current window, filtered by
+ * security access and current state.
* @throws Exception
*/
- List getDecoratorActions();
+ List<DecoratorAction> getDecoratorActions();
/**
* Gets the list of decorator actions for a page. Each layout fragment on a
* page has its own collection of actionAccess flags associated with it.
*
* @return A list of actions available to the current window, filtered by
- * securty access and current state.
+ * security access and current state.
* @throws Exception
*/
- List getPageDecoratorActions() throws Exception;
+ List<DecoratorAction> getPageDecoratorActions() throws Exception;
/**
+ * Returns the appropriate for the title based on locale preferences
*
- * <p>
- * getTitle
- * </p>
- * Returns the appropriate for the title based on locale prferences
- *
- * @param f
- * @return
+ * @param fragment
+ * @return the title of the fragment
*/
- String getTitle(ContentFragment f);
+ String getTitle(ContentFragment fragment);
/**
+ * Returns the appropriate for the title based on locale preferences
*
- * <p>
- * getTitle
- * </p>
- * Returns the appropriate for the title based on locale prferences
- *
- * @return
+ * @return the title of the current fragment
*/
String getTitle();
+ /**
+ * Shortcut convenience method to lookup a Jetspeed service via {@link org.apache.jetspeed.components.ComponentManagement#lookupComponent(Class)}
+ *
+ * @param name the name of the component service
+ * @return a component service from container
+ */
Object getComponent(String name);
+ /**
+ * Return the absolute portal URL from a given relative url
+ *
+ * @param relativePath
+ * @return the full portal URL
+ */
String getAbsoluteUrl(String relativePath);
+ /**
+ * Returns the current secure subject for the current request thread
+ *
+ * @return A Java {@link javax.security.auth.Subject}
+ */
Subject getSubject();
+ /**
+ * Is the current request being made by a logged on user
+ * @return true if user is logged on
+ */
boolean getLoggedOn();
+ /**
+ * Gets the Portal Base Path
+ * @see {@link org.apache.jetspeed.container.url.PortalURL#getBasePath()}
+ *
+ * @return the base path portion of the URL
+ */
String getBasePath();
- String getPageBasePath();
-
+ /**
+ * Returns the current Portal Page base path without possible encoded NavigationalState parameter.
+ * @see {@link org.apache.jetspeed.container.url.PortalURL#getBasePath()}
+ * @return
+ */
+ String getPageBasePath();
+
+ /**
+ * For given window and portlet ids, render a portlet window
+ *
+ * @param windowId
+ * @param portletId
+ * @return the rendered content
+ */
String renderPortletWindow(String windowId, String portletId);
/**
- * Returns stringified one from the element
+ * Returns string representation of a head HTML DOM element
*
* @param element
- * @return
+ * @return string representation
*/
String getElementHtmlString(HeadElement element);
/**
* Returns all the contributed head elements from the fragment and its child fragments.
- * @param f
+ * @param fragment
* @return
* @throws Exception
*/
- List<KeyValue<String, HeadElement>> getHeadElements(ContentFragment f) throws Exception;;
+ List<KeyValue<String, HeadElement>> getHeadElements(ContentFragment fragment) throws Exception;;
/**
* Returns all the contributed head elements from the current fragment and its child fragments.
@@ -288,7 +360,11 @@ public interface JetspeedPowerTool
* @return the value for the User "info" attribute or the provided defaultValue if not authenticated or if the attribute is undefined
*/
String getUserAttribute(String attributeName, String defaultValue);
-
+
+ /**
+ * Helper to retrieve the {@link org.apache.jetspeed.administration.PortalConfiguration}
+ * @return the portal configuration
+ */
PortalConfiguration getPortalConfiguration();
}
\ No newline at end of file
Modified: portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/layout/PageLayoutComponent.java
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/layout/PageLayoutComponent.java?rev=1576070&r1=1576069&r2=1576070&view=diff
==============================================================================
--- portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/layout/PageLayoutComponent.java (original)
+++ portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/layout/PageLayoutComponent.java Mon Mar 10 20:31:10 2014
@@ -16,14 +16,15 @@
*/
package org.apache.jetspeed.layout;
-import java.util.Map;
-
import org.apache.jetspeed.om.common.SecurityConstraints;
import org.apache.jetspeed.om.page.BaseFragmentsElement;
import org.apache.jetspeed.om.page.ContentFragment;
import org.apache.jetspeed.om.page.ContentPage;
+import org.apache.jetspeed.om.page.FragmentDefinition;
import org.apache.jetspeed.om.page.PageTemplate;
+import java.util.Map;
+
/**
* Page layout component interface.
*
@@ -196,7 +197,7 @@ public interface PageLayoutComponent
* by page and/or page template
* @return new content page
*/
- ContentPage newContentPage(BaseFragmentsElement pageOrTemplate, PageTemplate pageTemplate, Map fragmentDefinitions);
+ ContentPage newContentPage(BaseFragmentsElement pageOrTemplate, PageTemplate pageTemplate, Map<String, FragmentDefinition> fragmentDefinitions);
/**
* Create a new sibling folder with specified configuration and
@@ -384,11 +385,14 @@ public interface PageLayoutComponent
* Map of strings, string arrays, FragmentPreference or
* PortletPreference. Existing preferences are removed and
* replaced with the specified preferences.
- *
+ *
+ * preferences values are normally {@link org.apache.pluto.container.PortletPreference} but can also be String, String[], or
+ * {@link org.apache.jetspeed.om.preference.FragmentPreference}
+ *
* @param contentFragment content fragment context
* @param preferences map of new preferences set.
*/
- void updatePreferences(ContentFragment contentFragment, Map preferences);
+ void updatePreferences(ContentFragment contentFragment, Map<String, Object> preferences);
/**
* Update global fragment property.
Modified: portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/locator/TemplateDescriptor.java
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/locator/TemplateDescriptor.java?rev=1576070&r1=1576069&r2=1576070&view=diff
==============================================================================
--- portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/locator/TemplateDescriptor.java (original)
+++ portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/locator/TemplateDescriptor.java Mon Mar 10 20:31:10 2014
@@ -34,7 +34,7 @@ public interface TemplateDescriptor exte
/**
* The absolute file system path to the template
*
- * @param absolute path
+ * @param path the absolute path
*/
void setAbsolutePath(String path);
Modified: portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/locator/TemplateLocator.java
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/locator/TemplateLocator.java?rev=1576070&r1=1576069&r2=1576070&view=diff
==============================================================================
--- portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/locator/TemplateLocator.java (original)
+++ portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/locator/TemplateLocator.java Mon Mar 10 20:31:10 2014
@@ -43,7 +43,7 @@ public interface TemplateLocator
* <code>portlet</code>
* <code>email</code>
*
- * @param The type of locator to create
+ * @param type of locator to create
* @return a general template locator of the given type
* @throws TemplateLocatorException if factory exception or if not valid locator type
*/
@@ -61,11 +61,8 @@ public interface TemplateLocator
LocatorDescriptor createFromString(String string)
throws TemplateLocatorException;
- /**
- * Query for a collection of templates given template locator criteria.
- *
- * @param locator The template locator criteria.
- * @return The result list of {@link Template} objects matching the locator criteria.
+ /**
+ * @deprecated Do not use this method as it is not supported
*/
public Iterator query(LocatorDescriptor locator);
Modified: portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/om/common/SecurityConstraint.java
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/om/common/SecurityConstraint.java?rev=1576070&r1=1576069&r2=1576070&view=diff
==============================================================================
--- portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/om/common/SecurityConstraint.java (original)
+++ portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/om/common/SecurityConstraint.java Mon Mar 10 20:31:10 2014
@@ -42,7 +42,7 @@ public interface SecurityConstraint
*
* @return constraint users list as List of String
*/
- List getUsers();
+ List<String> getUsers();
/**
* <p>
@@ -51,7 +51,7 @@ public interface SecurityConstraint
*
* @param users constraint users list as List of String
*/
- void setUsers(List users);
+ void setUsers(List<String> users);
/**
* <p>
@@ -60,7 +60,7 @@ public interface SecurityConstraint
*
* @return constraint roles list as List of String
*/
- List getRoles();
+ List<String> getRoles();
/**
* <p>
@@ -69,7 +69,7 @@ public interface SecurityConstraint
*
* @param roles constraint roles list as List of String
*/
- void setRoles(List roles);
+ void setRoles(List<String> roles);
/**
* <p>
@@ -78,7 +78,7 @@ public interface SecurityConstraint
*
* @return constraint groups list as List of String
*/
- List getGroups();
+ List<String> getGroups();
/**
* <p>
@@ -87,7 +87,7 @@ public interface SecurityConstraint
*
* @param groups constraint groups list as List of String
*/
- void setGroups(List groups);
+ void setGroups(List<String> groups);
/**
* <p>
@@ -96,7 +96,7 @@ public interface SecurityConstraint
*
* @return constraint permissions list as List of String
*/
- List getPermissions();
+ List<String> getPermissions();
/**
* <p>
@@ -105,5 +105,5 @@ public interface SecurityConstraint
*
* @param permissions constraint permissions list as List of String
*/
- void setPermissions(List permissions);
+ void setPermissions(List<String> permissions);
}
Modified: portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/om/common/SecurityConstraints.java
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/om/common/SecurityConstraints.java?rev=1576070&r1=1576069&r2=1576070&view=diff
==============================================================================
--- portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/om/common/SecurityConstraints.java (original)
+++ portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/om/common/SecurityConstraints.java Mon Mar 10 20:31:10 2014
@@ -57,7 +57,7 @@ public interface SecurityConstraints
*
* @return security constraints list for resource
*/
- List getSecurityConstraints();
+ List<SecurityConstraint> getSecurityConstraints();
/**
* <p>
@@ -66,7 +66,7 @@ public interface SecurityConstraints
*
* @param constraints security constraints for resource
*/
- void setSecurityConstraints(List constraints);
+ void setSecurityConstraints(List<SecurityConstraint> constraints);
/**
* <p>
@@ -75,7 +75,7 @@ public interface SecurityConstraints
*
* @return security constraints references for resource
*/
- List getSecurityConstraintsRefs();
+ List<String> getSecurityConstraintsRefs();
/**
* <p>
@@ -84,7 +84,7 @@ public interface SecurityConstraints
*
* @param constraintsRefs security constraints references for resource
*/
- void setSecurityConstraintsRefs(List constraintsRefs);
+ void setSecurityConstraintsRefs(List<String> constraintsRefs);
/**
* <p>
Modified: portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/om/folder/Folder.java
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/om/folder/Folder.java?rev=1576070&r1=1576069&r2=1576070&view=diff
==============================================================================
--- portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/om/folder/Folder.java (original)
+++ portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/om/folder/Folder.java Mon Mar 10 20:31:10 2014
@@ -16,8 +16,6 @@
*/
package org.apache.jetspeed.om.folder;
-import java.util.List;
-
import org.apache.jetspeed.om.common.SecuredResource;
import org.apache.jetspeed.om.page.DynamicPage;
import org.apache.jetspeed.om.page.FragmentDefinition;
@@ -32,6 +30,8 @@ import org.apache.jetspeed.page.document
import org.apache.jetspeed.page.document.NodeException;
import org.apache.jetspeed.page.document.NodeSet;
+import java.util.List;
+
/**
* Folder
*
@@ -120,14 +120,14 @@ public interface Folder extends Node, Se
*
* @return list of ordered document names in folder
*/
- List getDocumentOrder();
+ List<String> getDocumentOrder();
/**
* setDocumentOrder
*
* @param docIndexes list of ordered document names in folder
*/
- void setDocumentOrder(List docIndexes);
+ void setDocumentOrder(List<String> docIndexes);
/**
*
@@ -313,7 +313,6 @@ public interface Folder extends Node, Se
* getPageSecurity
* </p>
*
- * @param name
* @return A PageSecurity referenced by this folder.
* @throws DocumentNotFoundException if the document requested could not be found.
* @throws NodeException
@@ -337,7 +336,7 @@ public interface Folder extends Node, Se
*
* @return definition list
*/
- List getMenuDefinitions();
+ List<MenuDefinition> getMenuDefinitions();
/**
* newMenuDefinition - creates a new empty menu definition
@@ -379,7 +378,7 @@ public interface Folder extends Node, Se
*
* @param definitions definition list
*/
- void setMenuDefinitions(List definitions);
+ void setMenuDefinitions(List<MenuDefinition> definitions);
/**
* Determines if a folder is a reserved folder.
Modified: portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/om/folder/MenuDefinition.java
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/om/folder/MenuDefinition.java?rev=1576070&r1=1576069&r2=1576070&view=diff
==============================================================================
--- portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/om/folder/MenuDefinition.java (original)
+++ portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/om/folder/MenuDefinition.java Mon Mar 10 20:31:10 2014
@@ -16,12 +16,12 @@
*/
package org.apache.jetspeed.om.folder;
+import org.apache.jetspeed.om.portlet.GenericMetadata;
+
import java.io.Serializable;
import java.util.List;
import java.util.Locale;
-import org.apache.jetspeed.om.portlet.GenericMetadata;
-
/**
* This interface describes the object used to define
* portal site menus comprised of nested menus, options,
@@ -61,7 +61,7 @@ public interface MenuDefinition extends
/**
* setOptions - set comma separated menu options if not specified as elements
*
- * @param option option paths specification
+ * @param options paths specification
*/
void setOptions(String options);
---------------------------------------------------------------------
To unsubscribe, e-mail: jetspeed-dev-unsubscribe@portals.apache.org
For additional commands, e-mail: jetspeed-dev-help@portals.apache.org