Java Portlet API V3.0 3.0.1 · javax.portlet.filter.ActionRequestWrapper

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.

Constructor Summary

Access	Constructor and Description
public	ActionRequestWrapper(ActionRequest the action request to wrap request) Creates an `ActionRequest` adaptor wrapping the given request object.

Method Summary

Modifier and Type	Method and Description
public ActionParameters	getActionParameters() Implements javax.portlet.ActionRequest.getActionParameters. Gets the action parameters set for this request.
public ActionRequest	Returns: the wrapped request getRequest() Overrides javax.portlet.filter.ClientDataRequestWrapper.getRequest. Return the wrapped request object.
public void	setRequest(ActionRequest the request to set request) Sets the request object being wrapped.

Inherited from javax.portlet.filter.ClientDataRequestWrapper:: getCharacterEncoding getContentLength getContentLengthLong getContentType getMethod getPart getParts getPortletInputStream getReader setCharacterEncoding setRequest

Constructor Detail

ActionRequestWrapper back to summary

ActionRequestWrapper	back to summary
public ActionRequestWrapper(ActionRequest request) Creates an `ActionRequest` adaptor wrapping the given request object. Parameters request:ActionRequest the action request to wrap Exceptions IllegalArgumentException: if the request is `null`

public ActionRequestWrapper(ActionRequest request)

Creates an ActionRequest adaptor wrapping the given request object.

Parameters

request:ActionRequest: the action request to wrap

Exceptions

IllegalArgumentException:: if the request is null

Method Detail

getActionParameters back to summary

getActionParameters	back to summary
public ActionParameters getActionParameters() Implements javax.portlet.ActionRequest.getActionParameters. Doc from javax.portlet.ActionRequest.getActionParameters. 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. Returns:ActionParameters an immutable object representing the action parameters Annotations @Override

public ActionParameters getActionParameters()

Implements javax.portlet.ActionRequest.getActionParameters.

Doc from javax.portlet.ActionRequest.getActionParameters.

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.

Returns:ActionParameters

an immutable object representing the action parameters

Annotations

@Override

getRequest	back to summary
public ActionRequest getRequest() Overrides javax.portlet.filter.ClientDataRequestWrapper.getRequest. Return the wrapped request object. Returns:ActionRequest the wrapped request

getRequest

back to summary

public ActionRequest getRequest()

Overrides javax.portlet.filter.ClientDataRequestWrapper.getRequest.

Return the wrapped request object.

Returns:ActionRequest: the wrapped request

setRequest	back to summary
public void setRequest(ActionRequest request) Sets the request object being wrapped. Parameters request:ActionRequest the request to set Exceptions IllegalArgumentException: if the request is null.

setRequest