org.jasig.portal.portlet.container.properties
Interface IRequestPropertiesManager

All Known Implementing Classes:

BaseRequestPropertiesManager, CacheRequestPropertiesManager, HttpRequestPropertiesManager, RequestPropertiesManagerBroker

public interface IRequestPropertiesManager

Encapsulates logic related to handling properties that can be retrieved from and set on PortletRequest and PortletResponse objects. get -add select servlet request properties to map add/set -react to setting cache timeout

Version:

$Revision$

Author:

Eric Dalquist

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

Method Detail

setResponseProperty

void setResponseProperty(HttpServletRequest portletRequest,
                         IPortletWindow portletWindow,
                         String property,
                         String value)

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.

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.

addResponseProperty

void addResponseProperty(HttpServletRequest portletRequest,
                         IPortletWindow portletWindow,
                         String property,
                         String value)

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.

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

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().

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.