Package jakarta.portlet.filter

Class EventRequestWrapper

java.lang.Object

jakarta.portlet.filter.RenderStateWrapper

jakarta.portlet.filter.PortletRequestWrapper

jakarta.portlet.filter.EventRequestWrapper

All Implemented Interfaces:

EventRequest, PortletRequest, RenderState

public class EventRequestWrapper
extends PortletRequestWrapper
implements EventRequest

The EventRequestWrapper provides a convenient implementation of the EventRequest 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:

EventRequest

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.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
EventRequestWrapper(EventRequest request)	Creates an EventRequest adaptor wrapping the given request object.

Method Summary

Modifier and Type	Method	Description
Event	getEvent()	Returns the event that triggered the call to the processEvent method.
String	getMethod()	Returns the name of the HTTP method with which the original action request was made, for example, POST, or PUT.
EventRequest	getRequest()	Return the wrapped request object.
void	setRequest(EventRequest request)	Sets the request object being wrapped.

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.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

EventRequestWrapper

public EventRequestWrapper(EventRequest request)

Creates an EventRequest adaptor wrapping the given request object.

Parameters:

request - the event request to wrap

Throws:

IllegalArgumentException - if the request is null

Method Detail

getRequest

public EventRequest getRequest()

Return the wrapped request object.

Overrides:

getRequest in class PortletRequestWrapper

Returns:

the wrapped request

setRequest

public void setRequest(EventRequest request)

Sets the request object being wrapped.

Parameters:

request - the request to set

Throws:

IllegalArgumentException - if the request is null.

getEvent

public Event getEvent()

Description copied from interface: EventRequest

Returns the event that triggered the call to the processEvent method.

Specified by:

getEvent in interface EventRequest

Returns:

the event that triggered the current processEvent call.

getMethod

public String getMethod()

Description copied from interface: EventRequest

Returns the name of the HTTP method with which the original action request was made, for example, POST, or PUT.

Specified by:

getMethod in interface EventRequest

Returns:

a String specifying the name of the HTTP method with which this request was made