Package javax.portlet.filter
Class EventRequestWrapper
- java.lang.Object
-
- javax.portlet.filter.PortletRequestWrapper
-
- javax.portlet.filter.EventRequestWrapper
-
- All Implemented Interfaces:
EventRequest
,PortletRequest
public class EventRequestWrapper extends PortletRequestWrapper implements EventRequest
TheEventRequestWrapper
provides a convenient implementation of theEventRequest
interface that can be subclassed by developers wishing to adapt the request. 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 javax.portlet.PortletRequest
PortletRequest.P3PUserInfos
-
-
Field Summary
Fields Modifier and Type Field Description (package private) EventRequest
request
-
Fields inherited from interface javax.portlet.PortletRequest
ACTION_PHASE, ACTION_SCOPE_ID, BASIC_AUTH, CCPP_PROFILE, CLIENT_CERT_AUTH, DIGEST_AUTH, EVENT_PHASE, FORM_AUTH, LIFECYCLE_PHASE, RENDER_HEADERS, RENDER_MARKUP, RENDER_PART, RENDER_PHASE, RESOURCE_PHASE, USER_INFO
-
-
Constructor Summary
Constructors Constructor Description EventRequestWrapper(EventRequest request)
Creates anEventRequest
adaptor wrapping the given request object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Event
getEvent()
The default behavior of this method is to callgetEvent()
on the wrapped request object.java.lang.String
getMethod()
The default behavior of this method is to callgetMethod()
on the wrapped request object.EventRequest
getRequest()
Return the wrapped request object.void
setRequest(EventRequest request)
Sets the request object being wrapped.-
Methods inherited from class javax.portlet.filter.PortletRequestWrapper
getAttribute, getAttributeNames, getAuthType, getContextPath, getCookies, getLocale, getLocales, getParameter, getParameterMap, getParameterNames, getParameterValues, getPortalContext, getPortletMode, getPortletSession, getPortletSession, getPreferences, getPrivateParameterMap, getProperties, getProperty, getPropertyNames, getPublicParameterMap, getRemoteUser, getRequestedSessionId, getResponseContentType, getResponseContentTypes, getScheme, getServerName, getServerPort, getUserPrincipal, getWindowID, getWindowState, isPortletModeAllowed, isRequestedSessionIdValid, isSecure, isUserInRole, isWindowStateAllowed, removeAttribute, setAttribute, setRequest
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface javax.portlet.PortletRequest
getAttribute, getAttributeNames, getAuthType, getContextPath, getCookies, getLocale, getLocales, getParameter, getParameterMap, getParameterNames, getParameterValues, getPortalContext, getPortletMode, getPortletSession, getPortletSession, getPreferences, getPrivateParameterMap, getProperties, getProperty, getPropertyNames, getPublicParameterMap, getRemoteUser, getRequestedSessionId, getResponseContentType, getResponseContentTypes, getScheme, getServerName, getServerPort, getUserPrincipal, getWindowID, getWindowState, isPortletModeAllowed, isRequestedSessionIdValid, isSecure, isUserInRole, isWindowStateAllowed, removeAttribute, setAttribute
-
-
-
-
Field Detail
-
request
EventRequest request
-
-
Constructor Detail
-
EventRequestWrapper
public EventRequestWrapper(EventRequest request)
Creates anEventRequest
adaptor wrapping the given request object.- Parameters:
request
- the event request to wrap- Throws:
java.lang.IllegalArgumentException
- if the request isnull
-
-
Method Detail
-
getRequest
public EventRequest getRequest()
Return the wrapped request object.- Overrides:
getRequest
in classPortletRequestWrapper
- Returns:
- the wrapped request
-
setRequest
public void setRequest(EventRequest request)
Sets the request object being wrapped.- Parameters:
request
- the request to set- Throws:
java.lang.IllegalArgumentException
- if the request is null.
-
getEvent
public Event getEvent()
The default behavior of this method is to callgetEvent()
on the wrapped request object.- Specified by:
getEvent
in interfaceEventRequest
- Returns:
- the event that triggered the current processEvent call.
-
getMethod
public java.lang.String getMethod()
The default behavior of this method is to callgetMethod()
on the wrapped request object.- Specified by:
getMethod
in interfaceEventRequest
- Returns:
- a String specifying the name of the HTTP method with which this request was made
-
-