Package jakarta.portlet.filter

Class HeaderRequestWrapper

java.lang.Object

jakarta.portlet.filter.RenderStateWrapper

jakarta.portlet.filter.PortletRequestWrapper

jakarta.portlet.filter.RenderRequestWrapper

jakarta.portlet.filter.HeaderRequestWrapper

All Implemented Interfaces:

HeaderRequest, PortletRequest, RenderRequest, RenderState

public class HeaderRequestWrapper
extends RenderRequestWrapper
implements HeaderRequest

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

3.0

See Also:

HeaderRequest

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

Fields inherited from interface jakarta.portlet.RenderRequest

ETAG

Constructor Summary

Constructors

Constructor	Description
HeaderRequestWrapper(HeaderRequest request)	Creates an HeaderRequest adaptor wrapping the given request object.

Method Summary

Modifier and Type	Method	Description
HeaderRequest	getRequest()	Return the wrapped request object.
void	setRequest(HeaderRequest request)	Sets the request object being wrapped.

Methods inherited from class jakarta.portlet.filter.RenderRequestWrapper

getETag, setRequest

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

getETag

Methods inherited from interface jakarta.portlet.RenderState

getPortletMode, getRenderParameters, getWindowState

Constructor Detail

HeaderRequestWrapper

public HeaderRequestWrapper(HeaderRequest request)

Creates an HeaderRequest adaptor wrapping the given request object.

Parameters:

request - the render request to wrap

Throws:

IllegalArgumentException - if the request is null

Method Detail

getRequest

public HeaderRequest getRequest()

Return the wrapped request object.

Overrides:

getRequest in class RenderRequestWrapper

Returns:

the wrapped request

setRequest

public void setRequest(HeaderRequest request)

Sets the request object being wrapped.

Parameters:

request - the request to set

Throws:

IllegalArgumentException - if the request is null.