org.jasig.portal.portlet.delegation
Interface IPortletDelegationManager

All Known Implementing Classes:

PortletDelegationLocatorImpl

public interface IPortletDelegationManager

Provides some utility methods for dealing with delegate rendering of portlets

Version:

$Revision$

Author:

Eric Dalquist

Field Summary

static String

DELEGATE_ACTION_REDIRECT_TOKEN

Method Summary

PortletUrl	getDelegatePortletActionRedirectUrl(HttpServletRequest request)
PortletUrl	getDelegatePortletActionRedirectUrl(PortletRequest request)
PortletUrl	getParentPortletUrl(HttpServletRequest request, IPortletWindowId parentPortletWindowId) Get the URL data to use for the delegation parent window
void	setDelegatePortletActionRedirectUrl(HttpServletRequest request, PortletUrl portletUrl) Pass the url generated after a delegates processAction
void	setParentPortletUrl(HttpServletRequest request, PortletUrl parentPortletUrl) Set the URL to use as parent data when generating delegate portlet URLs

Field Detail

DELEGATE_ACTION_REDIRECT_TOKEN

static final String DELEGATE_ACTION_REDIRECT_TOKEN

See Also:

Constant Field Values

Method Detail

setParentPortletUrl

void setParentPortletUrl(HttpServletRequest request,
                         PortletUrl parentPortletUrl)

Set the URL to use as parent data when generating delegate portlet URLs

Parameters:

parentPortletUrl - The parent URL data

getParentPortletUrl

PortletUrl getParentPortletUrl(HttpServletRequest request,
                               IPortletWindowId parentPortletWindowId)

Get the URL data to use for the delegation parent window

Parameters:

parentPortletWindowId - The ID of the portlet window to get the PortletUrl for

Returns:

The PortletUrl for the parent window, null if no base URL data is provided

setDelegatePortletActionRedirectUrl

void setDelegatePortletActionRedirectUrl(HttpServletRequest request,
                                         PortletUrl portletUrl)

Pass the url generated after a delegates processAction

Parameters:

request - The portlet adaptor request for the delegate

portletUrl - The URL to pass to the delegation dispatcher

getDelegatePortletActionRedirectUrl

PortletUrl getDelegatePortletActionRedirectUrl(HttpServletRequest request)

Parameters:

request - The portlet adapter request for the delgate parent

Returns:

The URL generated after the delegates processAction completes

getDelegatePortletActionRedirectUrl

PortletUrl getDelegatePortletActionRedirectUrl(PortletRequest request)

Parameters:

request - The portlet adapter request for the delgate parent

Returns:

The URL generated after the delegates processAction completes