Package jakarta.portlet.filter

Class ActionRequestWrapper

java.lang.Object

jakarta.portlet.filter.RenderStateWrapper

jakarta.portlet.filter.PortletRequestWrapper

jakarta.portlet.filter.ClientDataRequestWrapper

jakarta.portlet.filter.ActionRequestWrapper

All Implemented Interfaces:

ActionRequest, ClientDataRequest, PortletRequest, RenderState

public class ActionRequestWrapper
extends ClientDataRequestWrapper
implements ActionRequest

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

Since:

2.0

See Also:

ActionRequest

Nested Class Summary

Nested classes/interfaces inherited from interface jakarta.portlet.PortletRequest

PortletRequest.P3PUserInfos

Field Summary

Fields inherited from class jakarta.portlet.filter.RenderStateWrapper

wrapped

Fields inherited from interface jakarta.portlet.ActionRequest

ACTION_NAME

Fields inherited from interface jakarta.portlet.PortletRequest

ACTION_PHASE, ACTION_SCOPE_ID, BASIC_AUTH, CCPP_PROFILE, CLIENT_CERT_AUTH, DIGEST_AUTH, EVENT_PHASE, FORM_AUTH, HEADER_PHASE, LIFECYCLE_PHASE, RENDER_HEADERS, RENDER_MARKUP, RENDER_PART, RENDER_PHASE, RESOURCE_PHASE, USER_INFO

Constructor Summary

Constructors

Constructor	Description
ActionRequestWrapper(ActionRequest request)	Creates an ActionRequest adaptor wrapping the given request object.

Method Summary

Modifier and Type	Method	Description
ActionParameters	getActionParameters()	Gets the action parameters set for this request.
ActionRequest	getRequest()	Return the wrapped request object.
void	setRequest(ActionRequest request)	Sets the request object being wrapped.

Methods inherited from class jakarta.portlet.filter.ClientDataRequestWrapper

getCharacterEncoding, getContentLength, getContentLengthLong, getContentType, getMethod, getPart, getParts, getPortletInputStream, getReader, setCharacterEncoding, setRequest

Methods inherited from class jakarta.portlet.filter.PortletRequestWrapper

getAttribute, getAttributeNames, getAuthType, getContextPath, getCookies, getLocale, getLocales, getParameter, getParameterMap, getParameterNames, getParameterValues, getPortalContext, getPortletContext, getPortletMode, getPortletSession, getPortletSession, getPreferences, getPrivateParameterMap, getProperties, getProperty, getPropertyNames, getPublicParameterMap, getRemoteUser, getRenderParameters, getRequestedSessionId, getResponseContentType, getResponseContentTypes, getScheme, getServerName, getServerPort, getUserAgent, getUserPrincipal, getWindowID, getWindowState, isPortletModeAllowed, isRequestedSessionIdValid, isSecure, isUserInRole, isWindowStateAllowed, removeAttribute, setAttribute, setRequest

Methods inherited from class jakarta.portlet.filter.RenderStateWrapper

getWrapped, setWrapped

Methods inherited from class java.lang.Object

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

Methods inherited from interface jakarta.portlet.ClientDataRequest

getCharacterEncoding, getContentLength, getContentLengthLong, getContentType, getMethod, getPart, getParts, getPortletInputStream, getReader, setCharacterEncoding

Methods inherited from interface jakarta.portlet.PortletRequest

getAttribute, getAttributeNames, getAuthType, getContextPath, getCookies, getLocale, getLocales, getParameter, getParameterMap, getParameterNames, getParameterValues, getPortalContext, getPortletContext, getPortletSession, getPortletSession, getPreferences, getPrivateParameterMap, getProperties, getProperty, getPropertyNames, getPublicParameterMap, getRemoteUser, getRequestedSessionId, getResponseContentType, getResponseContentTypes, getScheme, getServerName, getServerPort, getUserAgent, getUserPrincipal, getWindowID, isPortletModeAllowed, isRequestedSessionIdValid, isSecure, isUserInRole, isWindowStateAllowed, removeAttribute, setAttribute

Methods inherited from interface jakarta.portlet.RenderState

getPortletMode, getRenderParameters, getWindowState

Constructor Detail

ActionRequestWrapper

public ActionRequestWrapper(ActionRequest request)

Creates an ActionRequest adaptor wrapping the given request object.

Parameters:

request - the action request to wrap

Throws:

IllegalArgumentException - if the request is null

Method Detail

getRequest

public ActionRequest getRequest()

Return the wrapped request object.

Overrides:

getRequest in class ClientDataRequestWrapper

Returns:

the wrapped request

setRequest

public void setRequest(ActionRequest request)

Sets the request object being wrapped.

Parameters:

request - the request to set

Throws:

IllegalArgumentException - if the request is null.

getActionParameters

public ActionParameters getActionParameters()

Description copied from interface: ActionRequest

Gets the action parameters set for this request.

Action parameters are additional portlet parameters added to the URL triggering the request that extend the state information provided by the render parameters.

Action parameters can also contain information provided by the client, for example, form parameters provided when a form is submitted.

PortletParameters provides a description of the parameter concept.

Specified by:

getActionParameters in interface ActionRequest

Returns:

an immutable object representing the action parameters

See Also:

ActionParameters, MutableActionParameters, ActionURL