org.jasig.portal.portlet.url
Class PortletRequestParameterManager

java.lang.Object
  org.jasig.portal.portlet.url.PortletRequestParameterManager

All Implemented Interfaces:

IPortletRequestParameterManager

public class PortletRequestParameterManager
extends Object
implements IPortletRequestParameterManager

Manages access to portlet request parameters using a request attribute.

Version:

$Revision$

Author:

Eric Dalquist

Field Summary

protected org.apache.commons.logging.Log	logger
protected static String	NO_PORTLET_URL_ATTRIBUTE
protected static String	PORTLET_URL_MAP_ATTRIBUTE
protected static String	TARGETED_PORTLET_URL_ATTRIBUTE

Constructor Summary

PortletRequestParameterManager()

Method Summary

protected PortletUrl	getAndCheckRequestInfoMap(HttpServletRequest request) Gets the List of urls from the request, throws a RequestParameterProcessingIncompleteException if no attribute exists in the request and returns null if the List is empty
IPortalRequestUtils	getPortalRequestUtils()
PortletUrl	getPortletRequestInfo(HttpServletRequest request, IPortletWindowId portletWindowId) Gets the request information for the specified portlet, returns null if the specified portlet was not targeted.
IPortletWindowId	getTargetedPortletWindowId(HttpServletRequest request) Gets the portlet window ID targeted by the request, returns null if no portlet was targeted.
void	setAdditionalPortletUrl(HttpServletRequest request, PortletUrl portletUrl) Set the PortletUrl for portlets that have data in this request but are not targeted
void	setPortalRequestUtils(IPortalRequestUtils portalRequestUtils)
void	setTargetedPortletUrl(HttpServletRequest request, PortletUrl portletUrl) Set the PortletUrl for the portlet that is targeted by the request

Methods inherited from class java.lang.Object

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

Field Detail

NO_PORTLET_URL_ATTRIBUTE

protected static final String NO_PORTLET_URL_ATTRIBUTE

TARGETED_PORTLET_URL_ATTRIBUTE

protected static final String TARGETED_PORTLET_URL_ATTRIBUTE

PORTLET_URL_MAP_ATTRIBUTE

protected static final String PORTLET_URL_MAP_ATTRIBUTE

logger

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

Constructor Detail

PortletRequestParameterManager

public PortletRequestParameterManager()

Method Detail

getPortalRequestUtils

public IPortalRequestUtils getPortalRequestUtils()

Returns:

the portalRequestUtils

setPortalRequestUtils

public void setPortalRequestUtils(IPortalRequestUtils portalRequestUtils)

Parameters:

portalRequestUtils - the portalRequestUtils to set

getTargetedPortletWindowId

public IPortletWindowId getTargetedPortletWindowId(HttpServletRequest request)

Description copied from interface: IPortletRequestParameterManager

Gets the portlet window ID targeted by the request, returns null if no portlet was targeted.

Specified by:

getTargetedPortletWindowId in interface IPortletRequestParameterManager

Parameters:

request - The current request.

Returns:

The IPortletWindowId of the portlet targeted by the request, null if no portlet was targeted.

getPortletRequestInfo

public PortletUrl getPortletRequestInfo(HttpServletRequest request,
                                        IPortletWindowId portletWindowId)

Description copied from interface: IPortletRequestParameterManager

Gets the request information for the specified portlet, returns null if the specified portlet was not targeted.

Specified by:

getPortletRequestInfo in interface IPortletRequestParameterManager

Parameters:

request - The current request.

portletWindowId - The id of the portlet to get request information for

Returns:

The PortletUrl for the specified IPortletWindowId, null if the specified portlet was not targeted.

setTargetedPortletUrl

public void setTargetedPortletUrl(HttpServletRequest request,
                                  PortletUrl portletUrl)

Description copied from interface: IPortletRequestParameterManager

Set the PortletUrl for the portlet that is targeted by the request

Specified by:

setTargetedPortletUrl in interface IPortletRequestParameterManager

Parameters:

request - The current request.

portletUrl - The PortletUrl for the targeted portlet, null if no portlet was targeted for the request

setAdditionalPortletUrl

public void setAdditionalPortletUrl(HttpServletRequest request,
                                    PortletUrl portletUrl)

Description copied from interface: IPortletRequestParameterManager

Set the PortletUrl for portlets that have data in this request but are not targeted

Specified by:

setAdditionalPortletUrl in interface IPortletRequestParameterManager

Parameters:

request - The current request

portletUrl - The PortletUrl for the additional portlet

getAndCheckRequestInfoMap

protected PortletUrl getAndCheckRequestInfoMap(HttpServletRequest request)

Gets the List of urls from the request, throws a RequestParameterProcessingIncompleteException if no attribute exists in the request and returns null if the List is empty

Parameters:

request - Current request.

Returns:

List of PortletUrls, null if the List is empty

Throws:

RequestParameterProcessingIncompleteException - if no portlet parameter processing has happened for the request yet.