public class ActionRequestWrapper extends ClientDataRequestWrapper implements ActionRequest
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.ActionRequest
PortletRequest.P3PUserInfos
wrapped
ACTION_NAME
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 and Description |
---|
ActionRequestWrapper(ActionRequest request)
Creates an
ActionRequest adaptor
wrapping the given request object. |
Modifier and Type | Method and 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.
|
getCharacterEncoding, getContentLength, getContentLengthLong, getContentType, getMethod, getPart, getParts, getPortletInputStream, getReader, setCharacterEncoding, setRequest
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
getWrapped, setWrapped
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getCharacterEncoding, getContentLength, getContentLengthLong, getContentType, getMethod, getPart, getParts, getPortletInputStream, getReader, setCharacterEncoding
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
getPortletMode, getRenderParameters, getWindowState
public ActionRequestWrapper(ActionRequest request)
ActionRequest
adaptor
wrapping the given request object.request
- the action request to wrapIllegalArgumentException
- if the request is null
public ActionRequest getRequest()
getRequest
in class ClientDataRequestWrapper
public void setRequest(ActionRequest request)
request
- the request to setIllegalArgumentException
- if the request is null.public ActionParameters getActionParameters()
ActionRequest
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.
getActionParameters
in interface ActionRequest
ActionParameters
,
MutableActionParameters
,
ActionURL
Java Portlet 3.0 API Specification. See the Copyright and License provided with this distribution. Use is subject to license terms.