Package jakarta.portlet

Interface ActionRequest

All Superinterfaces:

ClientDataRequest, PortletRequest, RenderState

All Known Implementing Classes:

ActionRequestWrapper

public interface ActionRequest
extends ClientDataRequest

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

Nested Class Summary

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

PortletRequest.P3PUserInfos

Field Summary

Fields

Modifier and Type	Field	Description
static String	ACTION_NAME	Predefined action name for usage with the @ProcessAction annotation.

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

Method Summary

Modifier and Type	Method	Description
ActionParameters	getActionParameters()	Gets the action parameters set for this request.

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

Field Detail

ACTION_NAME

static final String ACTION_NAME

Predefined action name for usage with the @ProcessAction annotation.

Since:

2.0

See Also:

Constant Field Values

Method Detail

getActionParameters

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:

an immutable object representing the action parameters

Since:

3.0

See Also:

ActionParameters, MutableActionParameters, ActionURL