Top Description Constructors Methods
javax.portlet.filter

public Class EventRequestWrapper

extends PortletRequestWrapper
implements EventRequest
Class Inheritance
All Implemented Interfaces
javax.portlet.EventRequest, javax.portlet.PortletRequest, javax.portlet.RenderState
Imports
javax.portlet.Event, .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

Constructor Summary

AccessConstructor and Description
public
EventRequestWrapper(EventRequest
the event request to wrap
request
)

Creates an EventRequest adaptor wrapping the given request object.

Method Summary

Modifier and TypeMethod and Description
public Event
getEvent()

Implements javax.portlet.EventRequest.getEvent.

Returns the event that triggered the call to the processEvent method.
public String
getMethod()

Implements javax.portlet.EventRequest.getMethod.

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

Returns:

the wrapped request
getRequest
()

Overrides javax.portlet.filter.PortletRequestWrapper.getRequest.

Return the wrapped request object.
public void
setRequest(EventRequest
the request to set
request
)

Sets the request object being wrapped.

Inherited from javax.portlet.filter.PortletRequestWrapper:
getAttributegetAttributeNamesgetAuthTypegetContextPathgetCookiesgetLocalegetLocalesgetParametergetParameterMapgetParameterNamesgetParameterValuesgetPortalContextgetPortletContextgetPortletModegetPortletSessiongetPortletSessiongetPreferencesgetPrivateParameterMapgetPropertiesgetPropertygetPropertyNamesgetPublicParameterMapgetRemoteUsergetRenderParametersgetRequestedSessionIdgetResponseContentTypegetResponseContentTypesgetSchemegetServerNamegetServerPortgetUserAgentgetUserPrincipalgetWindowIDgetWindowStateisPortletModeAllowedisRequestedSessionIdValidisSecureisUserInRoleisWindowStateAllowedremoveAttributesetAttributesetRequest

Constructor Detail

EventRequestWrapperback to summary
public EventRequestWrapper(EventRequest request)

Creates an EventRequest adaptor wrapping the given request object.

Parameters
request:EventRequest

the event request to wrap

Exceptions
IllegalArgumentException:
if the request is null

Method Detail

getEventback to summary
public Event getEvent()

Implements javax.portlet.EventRequest.getEvent.

Doc from javax.portlet.EventRequest.getEvent.

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

Returns:Event

the event that triggered the current processEvent call.

Annotations
@Override
getMethodback to summary
public String getMethod()

Implements javax.portlet.EventRequest.getMethod.

Doc from javax.portlet.EventRequest.getMethod.

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

Returns:String

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

Annotations
@Override
getRequestback to summary
public EventRequest getRequest()

Overrides javax.portlet.filter.PortletRequestWrapper.getRequest.

Return the wrapped request object.

Returns:EventRequest

the wrapped request

setRequestback to summary
public void setRequest(EventRequest request)

Sets the request object being wrapped.

Parameters
request:EventRequest

the request to set

Exceptions
IllegalArgumentException:
if the request is null.