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

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

All Implemented Interfaces:

IRequestPropertiesManager

public class CacheRequestPropertiesManager
extends BaseRequestPropertiesManager

Deals with seting and retrieving the RenderResponse.EXPIRATION_CACHE property.

Version:

$Revision$

Author:

Eric Dalquist

Field Summary

Fields inherited from class org.jasig.portal.portlet.container.properties.BaseRequestPropertiesManager

logger

Constructor Summary

CacheRequestPropertiesManager()

Method Summary

IPortalRequestUtils	getPortalRequestUtils()
IPortletDefinitionRegistry	getPortletDefinitionRegistry()
protected org.apache.pluto.descriptors.portlet.PortletDD	getPortletDeployment(HttpServletRequest httpServletRequest, IPortletWindow portletWindow) Gets the Portlet Deployment for a IPortletWindow object
IPortletEntityRegistry	getPortletEntityRegistry()
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	setPortalRequestUtils(IPortalRequestUtils portalRequestUtils)
void	setPortletDefinitionRegistry(IPortletDefinitionRegistry portletDefinitionRegistry)
void	setPortletEntityRegistry(IPortletEntityRegistry portletEntityRegistry)
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 org.jasig.portal.portlet.container.properties.BaseRequestPropertiesManager

addResponseProperty

Methods inherited from class java.lang.Object

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

Constructor Detail

CacheRequestPropertiesManager

public CacheRequestPropertiesManager()

Method Detail

getPortalRequestUtils

public IPortalRequestUtils getPortalRequestUtils()

Returns:

the portalRequestUtils

setPortalRequestUtils

public void setPortalRequestUtils(IPortalRequestUtils portalRequestUtils)

Parameters:

portalRequestUtils - the portalRequestUtils to set

getPortletEntityRegistry

public IPortletEntityRegistry getPortletEntityRegistry()

Returns:

the portletEntityRegistry

setPortletEntityRegistry

public void setPortletEntityRegistry(IPortletEntityRegistry portletEntityRegistry)

Parameters:

portletEntityRegistry - the portletEntityRegistry to set

getPortletDefinitionRegistry

public IPortletDefinitionRegistry getPortletDefinitionRegistry()

Returns:

the portletDefinitionRegistry

setPortletDefinitionRegistry

public void setPortletDefinitionRegistry(IPortletDefinitionRegistry portletDefinitionRegistry)

Parameters:

portletDefinitionRegistry - the portletDefinitionRegistry to set

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

Overrides:

getRequestProperties in class BaseRequestPropertiesManager

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

Overrides:

setResponseProperty in class BaseRequestPropertiesManager

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.

getPortletDeployment

protected org.apache.pluto.descriptors.portlet.PortletDD getPortletDeployment(HttpServletRequest httpServletRequest,
                                                                              IPortletWindow portletWindow)

Gets the Portlet Deployment for a IPortletWindow object

Parameters:

httpServletRequest - The portal's request (not the portlet context request)

portletWindow - The window to get the parent PortletDD for.

Returns:

The parent portlet descriptor for the window

Throws:

PortalException - if the PortletDD fails to load.