org.jasig.portal.portlet.container.properties
Class RequestPropertiesManagerBroker

java.lang.Object
  org.jasig.portal.portlet.container.properties.RequestPropertiesManagerBroker

All Implemented Interfaces:

IRequestPropertiesManager

public class RequestPropertiesManagerBroker
extends Object
implements IRequestPropertiesManager

Delegates properties related calls to a List of IRequestPropertiesManagers in order. No exception handling is done so any exception in a child IRequestPropertiesManager will cause the call to fail.

When getRequestProperties(HttpServletRequest, IPortletWindow) is called the returned Maps are overlayed in order to produce the final Map that is returned. This means IRequestPropertiesManagers lower in the propertiesManagers List can over-write properties from IRequestPropertiesManagers higher in the list.

Version:

$Revision$

Author:

Eric Dalquist

Field Summary

protected org.apache.commons.logging.Log

logger

Constructor Summary

RequestPropertiesManagerBroker()

Method Summary

void	addResponseProperty(HttpServletRequest request, IPortletWindow portletWindow, String property, String value) Called when a portlet sets a property via PortletResponse.addProperty(String, String).
List<IRequestPropertiesManager>	getPropertiesManagers()
Map<String,String[]>	getRequestProperties(HttpServletRequest request, IPortletWindow portletWindow) Called when a portlet gets the request properties via PortletRequest.getProperties(String), PortletRequest.getProperty(String), or PortletRequest.getPropertyNames().
void	setPropertiesManagers(List<IRequestPropertiesManager> propertiesManagers)
void	setResponseProperty(HttpServletRequest request, IPortletWindow portletWindow, String property, String value) Called when a portlet sets a property via PortletResponse.setProperty(String, String).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

protected final org.apache.commons.logging.Log logger

Constructor Detail

RequestPropertiesManagerBroker

public RequestPropertiesManagerBroker()

Method Detail

getPropertiesManagers

public List<IRequestPropertiesManager> getPropertiesManagers()

Returns:

the propertiesManagers

setPropertiesManagers

public void setPropertiesManagers(List<IRequestPropertiesManager> propertiesManagers)

Parameters:

propertiesManagers - the propertiesManagers to set

addResponseProperty

public void addResponseProperty(HttpServletRequest request,
                                IPortletWindow portletWindow,
                                String property,
                                String value)

Description copied from interface: IRequestPropertiesManager

Called when a portlet sets a property via PortletResponse.addProperty(String, String). This method should follow the same rules as the PortletResponse method and add the value to any existing property of the same name.

Specified by:

addResponseProperty in interface IRequestPropertiesManager

Parameters:

request - The request the addProperty call was made during

portletWindow - The PortletWindow representing the portlet calling addProperty

property - The name of the property to add, will not be null.

value - The value of the property to add, may be null.

setResponseProperty

public void setResponseProperty(HttpServletRequest request,
                                IPortletWindow portletWindow,
                                String property,
                                String value)

Description copied from interface: IRequestPropertiesManager

Called when a portlet sets a property via PortletResponse.setProperty(String, String). This method should follow the same rules as the PortletResponse method and overwrite any existing property of the same name.

Specified by:

setResponseProperty in interface IRequestPropertiesManager

Parameters:

request - The request the setProperty call was made during

portletWindow - The PortletWindow representing the portlet calling setProperty

property - The name of the property to set, will not be null.

value - The value of the property to set, may be null.

getRequestProperties

public Map<String,String[]> getRequestProperties(HttpServletRequest request,
                                                 IPortletWindow portletWindow)

Description copied from interface: IRequestPropertiesManager

Called when a portlet gets the request properties via PortletRequest.getProperties(String), PortletRequest.getProperty(String), or PortletRequest.getPropertyNames().

Specified by:

getRequestProperties in interface IRequestPropertiesManager

Parameters:

request - The request the call was made during

portletWindow - The PortletWindow representing the portlet requesting properties.

Returns:

A Map of properties to present to the portlet, must not be null.