com.ibm.wps.pe.pc.legacy.cmpf
Class PortletRequestWrapper

java.lang.Object
  javax.servlet.ServletRequestWrapper
      javax.servlet.http.HttpServletRequestWrapper
          com.ibm.wps.pe.pc.legacy.cmpf.PortletRequestWrapper

All Implemented Interfaces:

javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest, org.apache.jetspeed.portlet.PortletRequest

public class PortletRequestWrapper
extends javax.servlet.http.HttpServletRequestWrapper
implements org.apache.jetspeed.portlet.PortletRequest

Provides a convenient implementation of the PortletRequest interface that can be subclassed by developers who wish to wrap the request to a Portlet. This class implements the Wrapper or Decorator pattern. Methods default to calling through to the wrapped request object.

Since:

5.0

See Also:

PortletRequest

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletRequest

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

PortletRequestWrapper(org.apache.jetspeed.portlet.PortletRequest portletRequest)
Creates a PortletRequest adaptor wrapping the specified request object.

Method Summary

org.apache.jetspeed.portlet.Client	getClient()
protected ClientWrapper	getClientWrapper() Use this method to return a wrapped client instead of the getClient method
org.apache.jetspeed.portlet.PortletData	getData()
org.apache.jetspeed.portlet.Portlet.Mode	getMode()
protected org.apache.jetspeed.portlet.PortletRequest	getPortletRequest() Returns the wrapped ServletRequest object.
org.apache.jetspeed.portlet.PortletSession	getPortletSession()
org.apache.jetspeed.portlet.PortletSession	getPortletSession(boolean create)
org.apache.jetspeed.portlet.PortletSettings	getPortletSettings()
org.apache.jetspeed.portlet.Portlet.Mode	getPreviousMode()
org.apache.jetspeed.portlet.User	getUser()
org.apache.jetspeed.portlet.PortletWindow	getWindow()
void	invalidateCache()
void	setModeModifier(org.apache.jetspeed.portlet.Portlet.ModeModifier modeModifier)

Methods inherited from class javax.servlet.http.HttpServletRequestWrapper

getAuthType, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getIntHeader, getMethod, getPathInfo, getPathTranslated, getQueryString, getRemoteUser, getRequestedSessionId, getRequestURI, getRequestURL, getServletPath, getSession, getSession, getUserPrincipal, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isUserInRole

Methods inherited from class javax.servlet.ServletRequestWrapper

getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequest, getRequestDispatcher, getScheme, getServerName, getServerPort, isSecure, removeAttribute, setAttribute, setCharacterEncoding, setRequest

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.jetspeed.portlet.PortletRequest

getAttribute, getAttributeNames, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getInputStream, getIntHeader, getLocale, getLocales, getMethod, getParameter, getParameterMap, getParameterNames, getParameterValues, isSecure, removeAttribute, setAttribute

Methods inherited from interface javax.servlet.http.HttpServletRequest

getAuthType, getContextPath, getPathInfo, getPathTranslated, getQueryString, getRemoteUser, getRequestedSessionId, getRequestURI, getRequestURL, getServletPath, getSession, getSession, getUserPrincipal, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isUserInRole

Methods inherited from interface javax.servlet.ServletRequest

getCharacterEncoding, getContentLength, getContentType, getLocalAddr, getLocalName, getLocalPort, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getScheme, getServerName, getServerPort, setCharacterEncoding

Constructor Detail

PortletRequestWrapper

public PortletRequestWrapper(org.apache.jetspeed.portlet.PortletRequest portletRequest)

Creates a PortletRequest adaptor wrapping the specified request object.

Parameters:

portletRequest - the portlet request

Throws:

java.lang.IllegalArgumentException - if the request is null

Method Detail

getPortletRequest

protected org.apache.jetspeed.portlet.PortletRequest getPortletRequest()

Returns the wrapped ServletRequest object.

getMode

public org.apache.jetspeed.portlet.Portlet.Mode getMode()

Specified by:

getMode in interface org.apache.jetspeed.portlet.PortletRequest

getPreviousMode

public org.apache.jetspeed.portlet.Portlet.Mode getPreviousMode()

Specified by:

getPreviousMode in interface org.apache.jetspeed.portlet.PortletRequest

setModeModifier

public void setModeModifier(org.apache.jetspeed.portlet.Portlet.ModeModifier modeModifier)
                     throws org.apache.jetspeed.portlet.AccessDeniedException

Specified by:

setModeModifier in interface org.apache.jetspeed.portlet.PortletRequest

Throws:

org.apache.jetspeed.portlet.AccessDeniedException

getClient

public final org.apache.jetspeed.portlet.Client getClient()

Specified by:

getClient in interface org.apache.jetspeed.portlet.PortletRequest

getClientWrapper

protected ClientWrapper getClientWrapper()

Use this method to return a wrapped client instead of the getClient method

Returns:

the wrapped client object.

See Also:

Client

getWindow

public org.apache.jetspeed.portlet.PortletWindow getWindow()

Specified by:

getWindow in interface org.apache.jetspeed.portlet.PortletRequest

getData

public org.apache.jetspeed.portlet.PortletData getData()

Specified by:

getData in interface org.apache.jetspeed.portlet.PortletRequest

getUser

public org.apache.jetspeed.portlet.User getUser()

Specified by:

getUser in interface org.apache.jetspeed.portlet.PortletRequest

getPortletSession

public org.apache.jetspeed.portlet.PortletSession getPortletSession()

Specified by:

getPortletSession in interface org.apache.jetspeed.portlet.PortletRequest

getPortletSession

public org.apache.jetspeed.portlet.PortletSession getPortletSession(boolean create)

Specified by:

getPortletSession in interface org.apache.jetspeed.portlet.PortletRequest

getPortletSettings

public org.apache.jetspeed.portlet.PortletSettings getPortletSettings()

Specified by:

getPortletSettings in interface org.apache.jetspeed.portlet.PortletRequest

invalidateCache

public void invalidateCache()

Specified by:

invalidateCache in interface org.apache.jetspeed.portlet.PortletRequest