Package javax.portlet.filter
Class ActionResponseWrapper
- java.lang.Object
-
- javax.portlet.filter.PortletResponseWrapper
-
- javax.portlet.filter.ActionResponseWrapper
-
- All Implemented Interfaces:
ActionResponse
,PortletResponse
,StateAwareResponse
public class ActionResponseWrapper extends PortletResponseWrapper implements ActionResponse
TheActionResponseWrapper
provides a convenient implementation of theActionResponse
interface that can be subclassed by developers wishing to adapt the response. This class implements the Wrapper or Decorator pattern. Methods default to calling through to the wrapped response object.- Since:
- 2.0
- See Also:
ActionResponse
-
-
Field Summary
Fields Modifier and Type Field Description (package private) ActionResponse
response
-
Constructor Summary
Constructors Constructor Description ActionResponseWrapper(ActionResponse response)
Creates anActionResponse
adaptor wrapping the given response object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PortletMode
getPortletMode()
The default behavior of this method is to callgetPortletMode()
on the wrapped response object.java.util.Map<java.lang.String,java.lang.String[]>
getRenderParameterMap()
The default behavior of this method is to callgetRenderParameterMap()
on the wrapped response object.ActionResponse
getResponse()
Return the wrapped response object.WindowState
getWindowState()
The default behavior of this method is to callgetWindowState()
on the wrapped response object.void
removePublicRenderParameter(java.lang.String name)
The default behavior of this method is to callremovePublicRenderParameter()
on the wrapped response object.void
sendRedirect(java.lang.String location)
The default behavior of this method is to callsendRedirect(location)
on the wrapped response object.void
sendRedirect(java.lang.String location, java.lang.String renderUrlParamName)
The default behavior of this method is to callsendRedirect(location, renderUrlParamName)
on the wrapped response object.void
setEvent(java.lang.String name, java.io.Serializable value)
The default behavior of this method is to callsetEvent()
on the wrapped response object.void
setEvent(javax.xml.namespace.QName name, java.io.Serializable value)
The default behavior of this method is to callsetEvent(name, value)
on the wrapped response object.void
setPortletMode(PortletMode portletMode)
The default behavior of this method is to callsetPortletMode(portletMode)
on the wrapped response object.void
setRenderParameter(java.lang.String key, java.lang.String value)
The default behavior of this method is to callsetRenderParameter(key, value)
on the wrapped response object.void
setRenderParameter(java.lang.String key, java.lang.String[] values)
The default behavior of this method is to callsetRenderParameter(key, value)
on the wrapped response object.void
setRenderParameters(java.util.Map<java.lang.String,java.lang.String[]> parameters)
The default behavior of this method is to callsetRenderParameters(parameters)
on the wrapped response object.void
setResponse(ActionResponse response)
Sets the response object being wrapped.void
setWindowState(WindowState windowState)
The default behavior of this method is to callsetWindowState(windowState)
on the wrapped response object.-
Methods inherited from class javax.portlet.filter.PortletResponseWrapper
addProperty, addProperty, addProperty, createElement, encodeURL, getNamespace, 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.PortletResponse
addProperty, addProperty, addProperty, createElement, encodeURL, getNamespace, setProperty
-
-
-
-
Field Detail
-
response
ActionResponse response
-
-
Constructor Detail
-
ActionResponseWrapper
public ActionResponseWrapper(ActionResponse response)
Creates anActionResponse
adaptor wrapping the given response object.- Parameters:
response
- the action response to wrap- Throws:
java.lang.IllegalArgumentException
- if the response isnull
-
-
Method Detail
-
sendRedirect
public void sendRedirect(java.lang.String location) throws java.io.IOException
The default behavior of this method is to callsendRedirect(location)
on the wrapped response object.- Specified by:
sendRedirect
in interfaceActionResponse
- Parameters:
location
- the redirect location URL- Throws:
java.io.IOException
- if an input or output exception occurs.
-
sendRedirect
public void sendRedirect(java.lang.String location, java.lang.String renderUrlParamName) throws java.io.IOException
The default behavior of this method is to callsendRedirect(location, renderUrlParamName)
on the wrapped response object.- Specified by:
sendRedirect
in interfaceActionResponse
- Parameters:
location
- the redirect location URLrenderUrlParamName
- name of the query parameter under which the portlet container should store a render URL to this portlet- Throws:
java.io.IOException
- if an input or output exception occurs.
-
setEvent
public void setEvent(javax.xml.namespace.QName name, java.io.Serializable value)
The default behavior of this method is to callsetEvent(name, value)
on the wrapped response object.- Specified by:
setEvent
in interfaceStateAwareResponse
- Parameters:
name
- the event name to publish, must not benull
value
- the value of this event, must have a valid JAXB binding and be serializable, ornull
.
-
setPortletMode
public void setPortletMode(PortletMode portletMode) throws PortletModeException
The default behavior of this method is to callsetPortletMode(portletMode)
on the wrapped response object.- Specified by:
setPortletMode
in interfaceStateAwareResponse
- Parameters:
portletMode
- the new portlet mode- Throws:
PortletModeException
- if the portlet cannot switch to this portlet mode, because the portlet or portal does not support it for this markup, or the current user is not allowed to switch to this portlet mode. To avoid this exception the portlet can check the allowed portlet modes withRequest.isPortletModeAllowed()
.
-
setRenderParameter
public void setRenderParameter(java.lang.String key, java.lang.String value)
The default behavior of this method is to callsetRenderParameter(key, value)
on the wrapped response object.- Specified by:
setRenderParameter
in interfaceStateAwareResponse
- Parameters:
key
- key of the render parametervalue
- value of the render parameter
-
setRenderParameter
public void setRenderParameter(java.lang.String key, java.lang.String[] values)
The default behavior of this method is to callsetRenderParameter(key, value)
on the wrapped response object.- Specified by:
setRenderParameter
in interfaceStateAwareResponse
- Parameters:
key
- key of the render parametervalues
- values of the render parameter
-
setRenderParameters
public void setRenderParameters(java.util.Map<java.lang.String,java.lang.String[]> parameters)
The default behavior of this method is to callsetRenderParameters(parameters)
on the wrapped response object.- Specified by:
setRenderParameters
in interfaceStateAwareResponse
- Parameters:
parameters
- Map containing parameter names for the render phase as keys and parameter values as map values. The keys in the parameter map must be of type String. The values in the parameter map must be of type String array (String[]
).
-
setWindowState
public void setWindowState(WindowState windowState) throws WindowStateException
The default behavior of this method is to callsetWindowState(windowState)
on the wrapped response object.- Specified by:
setWindowState
in interfaceStateAwareResponse
- Parameters:
windowState
- the new portlet window state- Throws:
WindowStateException
- if the portlet cannot switch to the specified window state. To avoid this exception the portlet can check the allowed window states withRequest.isWindowStateAllowed()
.- See Also:
WindowState
-
getResponse
public ActionResponse getResponse()
Return the wrapped response object.- Overrides:
getResponse
in classPortletResponseWrapper
- Returns:
- the wrapped response
-
setResponse
public void setResponse(ActionResponse response)
Sets the response object being wrapped.- Parameters:
response
- the response to set- Throws:
java.lang.IllegalArgumentException
- if the response is null.
-
getPortletMode
public PortletMode getPortletMode()
The default behavior of this method is to callgetPortletMode()
on the wrapped response object.- Specified by:
getPortletMode
in interfaceStateAwareResponse
- Returns:
- the portlet mode, or
null
if none is set
-
getRenderParameterMap
public java.util.Map<java.lang.String,java.lang.String[]> getRenderParameterMap()
The default behavior of this method is to callgetRenderParameterMap()
on the wrapped response object.- Specified by:
getRenderParameterMap
in interfaceStateAwareResponse
- Returns:
Map
containing render parameter names as keys and parameter values as map values, or an emptyMap
if no parameters exist. The keys in the parameter map are of type String. The values in the parameter map are of type String array (String[]
).
-
getWindowState
public WindowState getWindowState()
The default behavior of this method is to callgetWindowState()
on the wrapped response object.- Specified by:
getWindowState
in interfaceStateAwareResponse
- Returns:
- the window state, or
null
if none is set
-
setEvent
public void setEvent(java.lang.String name, java.io.Serializable value)
The default behavior of this method is to callsetEvent()
on the wrapped response object.- Specified by:
setEvent
in interfaceStateAwareResponse
- Parameters:
name
- the local part of the event name to publish, must not benull
value
- the value of this event, must have a valid JAXB binding and be serializable, ornull
.
-
removePublicRenderParameter
public void removePublicRenderParameter(java.lang.String name)
The default behavior of this method is to callremovePublicRenderParameter()
on the wrapped response object.- Specified by:
removePublicRenderParameter
in interfaceStateAwareResponse
- Parameters:
name
- aString
specifying the name of the public render parameter to be removed
-
-