org.apache.pluto.services.property
Interface PropertyManagerService

All Superinterfaces:
ContainerService

public interface PropertyManagerService
extends ContainerService

The PropertyManagerService interface is a container service providing the portlet container with external defined properties. This interface allows to associate properties with the portlet request and portlet response.
This service represents an abstract layer to make the property management independent of the portlet container and to allow diverse special implementations.

This SPI interface can be implemented by the portal.


Method Summary
 java.util.Map getRequestProperties(PortletWindow window, javax.servlet.http.HttpServletRequest request)
          Returns all properties for the given portlet window defined in the portal as String/String array map.
 void setResponseProperties(PortletWindow window, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.util.Map properties)
          Sets the given property map defined by the portlet window in its response.
 

Method Detail

setResponseProperties

void setResponseProperties(PortletWindow window,
                           javax.servlet.http.HttpServletRequest request,
                           javax.servlet.http.HttpServletResponse response,
                           java.util.Map properties)
Sets the given property map defined by the portlet window in its response.
The purpose of this method is to provide the portal framework with a new map of properties set by the portlet. The map can be empty, but not NULL
This method can be called multiple times during one request by the portlet container

Parameters:
window - the portlet window of this property
request - the servlet request
response - the servlet response
properties - the String/String array map containing the properties to be set.

getRequestProperties

java.util.Map getRequestProperties(PortletWindow window,
                                   javax.servlet.http.HttpServletRequest request)
Returns all properties for the given portlet window defined in the portal as String/String array map. They will be made available to the portlet through the portlet request.
The purpose of this method is to allow the portal framework to create a map of properties and make it available to the portlet container.
This method can be called multiple times during one request by the portlet container
The return value cannot be null.

Parameters:
window - the portlet window of this property
request - the servlet request
Returns:
a Map containing all properties. If there are no properties of that name returns an empty Map.


Copyright © 2003-2011 . All Rights Reserved.