Top Description Fields Methods
javax.portlet

public Interface ActionRequest

extends ClientDataRequest
Known Direct Implementers
javax.portlet.filter.ActionRequestWrapper

The ActionRequest represents the request sent to the portlet to handle an action.
It extends the ClientDataRequest interface and provides action request information to portlets.

The portlet container creates an ActionRequest object and passes it as argument to the portlet's processAction method.

See Also
ClientDataRequest

Field Summary

Modifier and TypeField and Description
public static final String
ACTION_NAME

Predefined action name for usage with the @ProcessAction annotation.

Method Summary

Modifier and TypeMethod and Description
public ActionParameters

Returns:

an immutable object representing the action parameters
getActionParameters
()

Gets the action parameters set for this request.
Inherited from javax.portlet.ClientDataRequest:
getCharacterEncodinggetContentLengthgetContentLengthLonggetContentTypegetMethodgetPartgetPartsgetPortletInputStreamgetReadersetCharacterEncoding

Field Detail

ACTION_NAMEback to summary
public static final String ACTION_NAME

Predefined action name for usage with the @ProcessAction annotation.

Since
2.0

Method Detail

getActionParametersback to summary
public ActionParameters 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

Since
3.0
See Also
ActionParameters, MutableActionParameters, ActionURL