javax.portlet.filter

Class ActionResponseWrapper

java.lang.Object

javax.portlet.filter.PortletResponseWrapper

javax.portlet.filter.StateAwareResponseWrapper

javax.portlet.filter.ActionResponseWrapper

All Implemented Interfaces:

ActionResponse, Mutable, MutableRenderState, PortletResponse, RenderState, StateAwareResponse

public class ActionResponseWrapper
extends StateAwareResponseWrapper
implements ActionResponse

The ActionResponseWrapper provides a convenient implementation of the ActionResponse interface that can be subclassed by developers. This class implements the Wrapper or Decorator pattern. Methods default to calling through to the wrapped response object.

Since:

2.0

See Also:

ActionResponse

Constructor Summary

Constructors

Constructor and Description
ActionResponseWrapper(ActionResponse response) Creates an ActionResponse adaptor wrapping the given response object.

Method Summary

Methods

Modifier and Type	Method and Description
RenderURL	createRedirectURL(MimeResponse.Copy option) call wrapped object.
ActionResponse	getResponse() Return the wrapped response object.
void	sendRedirect(String location) The default behavior of this method is to call sendRedirect(location) on the wrapped response object.
void	sendRedirect(String location, String renderUrlParamName) The default behavior of this method is to call sendRedirect(location, renderUrlParamName) on the wrapped response object.
void	setResponse(ActionResponse response) Sets the response object being wrapped.

Methods inherited from class javax.portlet.filter.StateAwareResponseWrapper

getPortletMode, getRenderParameterMap, getRenderParameters, getWindowState, removePublicRenderParameter, setEvent, setEvent, setPortletMode, setRenderParameter, setRenderParameter, setRenderParameters, setResponse, setWindowState

Methods inherited from class javax.portlet.filter.PortletResponseWrapper

addProperty, addProperty, addProperty, createElement, encodeURL, getNamespace, getProperty, getPropertyNames, getPropertyValues, setProperty, setResponse

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.portlet.StateAwareResponse

getRenderParameterMap, removePublicRenderParameter, setEvent, setEvent, setRenderParameter, setRenderParameter, setRenderParameters

Methods inherited from interface javax.portlet.PortletResponse

addProperty, addProperty, addProperty, createElement, encodeURL, getNamespace, getProperty, getPropertyNames, getPropertyValues, setProperty

Methods inherited from interface javax.portlet.MutableRenderState

getRenderParameters, setPortletMode, setWindowState

Methods inherited from interface javax.portlet.RenderState

getPortletMode, getWindowState

Constructor Detail

ActionResponseWrapper

public ActionResponseWrapper(ActionResponse response)

Creates an ActionResponse adaptor wrapping the given response object.

Parameters:

response - the action response to wrap

Throws:

IllegalArgumentException - if the response is null

Method Detail

getResponse

public ActionResponse getResponse()

Return the wrapped response object.

Overrides:

getResponse in class StateAwareResponseWrapper

Returns:

the wrapped response

setResponse

public void setResponse(ActionResponse response)

Sets the response object being wrapped.

Parameters:

response - the response to set

Throws:

IllegalArgumentException - if the response is null.

sendRedirect

public void sendRedirect(String location)
                  throws IOException

The default behavior of this method is to call sendRedirect(location) on the wrapped response object.

Specified by:

sendRedirect in interface ActionResponse

Parameters:

location - the redirect location URL

Throws:

IOException - if an input or output exception occurs.

sendRedirect

public void sendRedirect(String location,
                String renderUrlParamName)
                  throws IOException

The default behavior of this method is to call sendRedirect(location, renderUrlParamName) on the wrapped response object.

Specified by:

sendRedirect in interface ActionResponse

Parameters:

location - the redirect location URL

renderUrlParamName - name of the query parameter under which the portlet container should store a render URL to this portlet

Throws:

IOException - if an input or output exception occurs.

createRedirectURL

public RenderURL createRedirectURL(MimeResponse.Copy option)
                            throws IllegalStateException

call wrapped object.

Specified by:

createRedirectURL in interface ActionResponse

Parameters:

option - Specifies how current parameters are to be copied to the URL

Returns:

a portlet render URL

Throws:

IllegalStateException - if the method is invoked after any of above mentioned methods of the ActionResponse interface has been called.

See Also:

MimeResponse.Copy