org.jasig.portal.api.portlet
Interface PortletDelegationDispatcher

All Known Implementing Classes:

PortletDelegationDispatcherImpl

public interface PortletDelegationDispatcher

Used to dispatch requests to a delegate portlet window. Also provides information about the state of the delegate portlet window.

Version:

$Revision$

Author:

Eric Dalquist

Method Summary

DelegationActionResponse	doAction(ActionRequest actionRequest, ActionResponse actionResponse) Calls doAction(ActionRequest, ActionResponse, DelegationRequest) with no DelegationRequest data
DelegationActionResponse	doAction(ActionRequest actionRequest, ActionResponse actionResponse, DelegationRequest delegationRequest) Executes a portlet action request on the delegate window.
DelegationResponse	doRender(RenderRequest renderRequest, RenderResponse renderResponse) Calls doRender(RenderRequest, RenderResponse, DelegationRequest, Writer) with no DelegationRequest data and uses RenderResponse.getWriter() for the writer.,
DelegationResponse	doRender(RenderRequest renderRequest, RenderResponse renderResponse, DelegationRequest delegationRequest) Calls doRender(RenderRequest, RenderResponse, DelegationRequest, Writer) using RenderResponse.getWriter() for the writer.,
DelegationResponse	doRender(RenderRequest renderRequest, RenderResponse renderResponse, DelegationRequest delegationRequest, Writer writer) Executes a portlet render request on the delegate window.
DelegationResponse	doRender(RenderRequest renderRequest, RenderResponse renderResponse, Writer writer) Calls doRender(RenderRequest, RenderResponse, DelegationRequest, Writer) with no DelegationRequest data.
DelegateState	getDelegateState()
IPortletWindowId	getPortletWindowId()

Method Detail

getPortletWindowId

IPortletWindowId getPortletWindowId()

Returns:

The ID of the delegate portlet window, useful for retrieving this dispatcher again from the PortletDelegationLocator

getDelegateState

DelegateState getDelegateState()

Returns:

The current sate of the delegate window

doAction

DelegationActionResponse doAction(ActionRequest actionRequest,
                                  ActionResponse actionResponse)
                                  throws IOException

Calls doAction(ActionRequest, ActionResponse, DelegationRequest) with no DelegationRequest data

Throws:

IOException

See Also:

doAction(ActionRequest, ActionResponse, DelegationRequest)

doAction

DelegationActionResponse doAction(ActionRequest actionRequest,
                                  ActionResponse actionResponse,
                                  DelegationRequest delegationRequest)
                                  throws IOException

Executes a portlet action request on the delegate window. The state, mode and parameters in the delegation request (if set) are used by the delegate.

Parameters:

actionRequest - The current portlet's action request

actionResponse - The current portlet's action response

delegationRequest - The state to set for the delegate and the basis for generated URLs

Returns:

The delegation response state, will indicate if the delegate sent a redirect

Throws:

IOException

doRender

DelegationResponse doRender(RenderRequest renderRequest,
                            RenderResponse renderResponse)
                            throws IOException

Calls doRender(RenderRequest, RenderResponse, DelegationRequest, Writer) with no DelegationRequest data and uses RenderResponse.getWriter() for the writer.,

Throws:

IOException

See Also:

doRender(RenderRequest, RenderResponse, DelegationRequest, Writer)

doRender

DelegationResponse doRender(RenderRequest renderRequest,
                            RenderResponse renderResponse,
                            Writer writer)
                            throws IOException

Calls doRender(RenderRequest, RenderResponse, DelegationRequest, Writer) with no DelegationRequest data.

Throws:

IOException

See Also:

doRender(RenderRequest, RenderResponse, DelegationRequest, Writer)

doRender

DelegationResponse doRender(RenderRequest renderRequest,
                            RenderResponse renderResponse,
                            DelegationRequest delegationRequest)
                            throws IOException

Calls doRender(RenderRequest, RenderResponse, DelegationRequest, Writer) using RenderResponse.getWriter() for the writer.,

Throws:

IOException

See Also:

doRender(RenderRequest, RenderResponse, DelegationRequest, Writer)

doRender

DelegationResponse doRender(RenderRequest renderRequest,
                            RenderResponse renderResponse,
                            DelegationRequest delegationRequest,
                            Writer writer)
                            throws IOException

Executes a portlet render request on the delegate window. The state, mode and parameters in the delegation request (if set) are used by the delegate. The output of the portlet's rendering is written to the provided Writer

Parameters:

renderRequest - The current portlet's render request

renderResponse - The current portlet's render response

delegationRequest - The state to set for the delegate and the basis for generated URLs

writer - The Writer to send all content from the delegate portlet to

Returns:

The delegation response state, will indicate if the delegate sent a redirect

Throws:

IOException