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

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

All Implemented Interfaces:

IRequestPropertiesManager

Direct Known Subclasses:

CacheRequestPropertiesManager, HttpRequestPropertiesManager

public abstract class BaseRequestPropertiesManager
extends Object
implements IRequestPropertiesManager

Do nothing base class for IRequestPropertiesManager impls. getRequestProperties(HttpServletRequest, IPortletWindow) returns Collections.emptyList()

Version:

$Revision$

Author:

Eric Dalquist

Field Summary

protected org.apache.commons.logging.Log

logger

Constructor Summary

BaseRequestPropertiesManager()

Method Summary

void	addResponseProperty(HttpServletRequest portletRequest, IPortletWindow portletWindow, String property, String value) Called when a portlet sets a property via PortletResponse.addProperty(String, String).
Map<String,String[]>	getRequestProperties(HttpServletRequest portletRequest, IPortletWindow portletWindow) Called when a portlet gets the request properties via PortletRequest.getProperties(String), PortletRequest.getProperty(String), or PortletRequest.getPropertyNames().
void	setResponseProperty(HttpServletRequest portletRequest, 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

BaseRequestPropertiesManager

public BaseRequestPropertiesManager()

Method Detail

addResponseProperty

public void addResponseProperty(HttpServletRequest portletRequest,
                                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:

portletRequest - 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.

getRequestProperties

public Map<String,String[]> getRequestProperties(HttpServletRequest portletRequest,
                                                 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:

portletRequest - 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.

setResponseProperty

public void setResponseProperty(HttpServletRequest portletRequest,
                                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:

portletRequest - 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.