org.apache.pluto.portlet

Class PortletRequestWrapper

java.lang.Object

javax.servlet.ServletRequestWrapper

javax.servlet.http.HttpServletRequestWrapper

org.apache.pluto.portlet.PortletRequestWrapper

All Implemented Interfaces:

javax.portlet.PortletRequest, javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest

Direct Known Subclasses:

ActionRequestWrapper, RenderRequestWrapper

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

Field Summary

Fields inherited from interface javax.portlet.PortletRequest

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH, USER_INFO

Fields inherited from interface javax.servlet.http.HttpServletRequest

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

Constructors

Constructor and Description
PortletRequestWrapper(javax.portlet.PortletRequest portletRequest) Creates a ServletRequest adaptor wrapping the given request object.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	getAttribute(java.lang.String name)
java.util.Enumeration	getAttributeNames()
java.lang.String	getAuthType()
java.lang.String	getContextPath()
java.util.Locale	getLocale()
java.util.Enumeration	getLocales()
java.lang.String	getParameter(java.lang.String name)
java.util.Map	getParameterMap()
java.util.Enumeration	getParameterNames()
java.lang.String[]	getParameterValues(java.lang.String name)
javax.portlet.PortalContext	getPortalContext()
javax.portlet.PortletMode	getPortletMode()
javax.portlet.PortletRequest	getPortletRequest() Return the wrapped ServletRequest object.
javax.portlet.PortletSession	getPortletSession()
javax.portlet.PortletSession	getPortletSession(boolean create)
javax.portlet.PortletPreferences	getPreferences()
java.util.Enumeration	getProperties(java.lang.String name)
java.lang.String	getProperty(java.lang.String name)
java.util.Enumeration	getPropertyNames()
java.lang.String	getRemoteUser()
java.lang.String	getRequestedSessionId()
java.lang.String	getResponseContentType()
java.util.Enumeration	getResponseContentTypes()
java.lang.String	getScheme()
java.lang.String	getServerName()
int	getServerPort()
java.security.Principal	getUserPrincipal()
javax.portlet.WindowState	getWindowState()
boolean	isPortletModeAllowed(javax.portlet.PortletMode mode)
boolean	isRequestedSessionIdValid()
boolean	isSecure()
boolean	isUserInRole(java.lang.String role)
boolean	isWindowStateAllowed(javax.portlet.WindowState state)
void	removeAttribute(java.lang.String name)
void	setAttribute(java.lang.String name, java.lang.Object o)
void	setRequest(javax.portlet.PortletRequest request) Sets the request being wrapped.

Methods inherited from class javax.servlet.http.HttpServletRequestWrapper

getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getIntHeader, getMethod, getPathInfo, getPathTranslated, getQueryString, getRequestURI, getRequestURL, getServletPath, getSession, getSession, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL

Methods inherited from class javax.servlet.ServletRequestWrapper

getCharacterEncoding, getContentLength, getContentType, getInputStream, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRequest, getRequestDispatcher, setCharacterEncoding, setRequest

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.servlet.ServletRequest

getCharacterEncoding, getContentLength, getContentType, getInputStream, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRequestDispatcher, setCharacterEncoding

Constructor Detail

PortletRequestWrapper

public PortletRequestWrapper(javax.portlet.PortletRequest portletRequest)

Creates a ServletRequest adaptor wrapping the given request object.

Throws:

java.lang.IllegalArgumentException - if the request is null.

Method Detail

isWindowStateAllowed

public boolean isWindowStateAllowed(javax.portlet.WindowState state)

Specified by:

isWindowStateAllowed in interface javax.portlet.PortletRequest

isPortletModeAllowed

public boolean isPortletModeAllowed(javax.portlet.PortletMode mode)

Specified by:

isPortletModeAllowed in interface javax.portlet.PortletRequest

getPortletMode

public javax.portlet.PortletMode getPortletMode()

Specified by:

getPortletMode in interface javax.portlet.PortletRequest

getWindowState

public javax.portlet.WindowState getWindowState()

Specified by:

getWindowState in interface javax.portlet.PortletRequest

getPreferences

public javax.portlet.PortletPreferences getPreferences()

Specified by:

getPreferences in interface javax.portlet.PortletRequest

getPortletSession

public javax.portlet.PortletSession getPortletSession()

Specified by:

getPortletSession in interface javax.portlet.PortletRequest

getPortletSession

public javax.portlet.PortletSession getPortletSession(boolean create)

Specified by:

getPortletSession in interface javax.portlet.PortletRequest

getProperty

public java.lang.String getProperty(java.lang.String name)

Specified by:

getProperty in interface javax.portlet.PortletRequest

getProperties

public java.util.Enumeration getProperties(java.lang.String name)

Specified by:

getProperties in interface javax.portlet.PortletRequest

getPropertyNames

public java.util.Enumeration getPropertyNames()

Specified by:

getPropertyNames in interface javax.portlet.PortletRequest

getPortalContext

public javax.portlet.PortalContext getPortalContext()

Specified by:

getPortalContext in interface javax.portlet.PortletRequest

getAuthType

public java.lang.String getAuthType()

Specified by:

getAuthType in interface javax.portlet.PortletRequest

Specified by:

getAuthType in interface javax.servlet.http.HttpServletRequest

Overrides:

getAuthType in class javax.servlet.http.HttpServletRequestWrapper

getContextPath

public java.lang.String getContextPath()

Specified by:

getContextPath in interface javax.portlet.PortletRequest

Specified by:

getContextPath in interface javax.servlet.http.HttpServletRequest

Overrides:

getContextPath in class javax.servlet.http.HttpServletRequestWrapper

getRemoteUser

public java.lang.String getRemoteUser()

Specified by:

getRemoteUser in interface javax.portlet.PortletRequest

Specified by:

getRemoteUser in interface javax.servlet.http.HttpServletRequest

Overrides:

getRemoteUser in class javax.servlet.http.HttpServletRequestWrapper

getUserPrincipal

public java.security.Principal getUserPrincipal()

Specified by:

getUserPrincipal in interface javax.portlet.PortletRequest

Specified by:

getUserPrincipal in interface javax.servlet.http.HttpServletRequest

Overrides:

getUserPrincipal in class javax.servlet.http.HttpServletRequestWrapper

isUserInRole

public boolean isUserInRole(java.lang.String role)

Specified by:

isUserInRole in interface javax.portlet.PortletRequest

Specified by:

isUserInRole in interface javax.servlet.http.HttpServletRequest

Overrides:

isUserInRole in class javax.servlet.http.HttpServletRequestWrapper

getAttribute

public java.lang.Object getAttribute(java.lang.String name)

Specified by:

getAttribute in interface javax.portlet.PortletRequest

Specified by:

getAttribute in interface javax.servlet.ServletRequest

Overrides:

getAttribute in class javax.servlet.ServletRequestWrapper

getAttributeNames

public java.util.Enumeration getAttributeNames()

Specified by:

getAttributeNames in interface javax.portlet.PortletRequest

Specified by:

getAttributeNames in interface javax.servlet.ServletRequest

Overrides:

getAttributeNames in class javax.servlet.ServletRequestWrapper

getParameter

public java.lang.String getParameter(java.lang.String name)

Specified by:

getParameter in interface javax.portlet.PortletRequest

Specified by:

getParameter in interface javax.servlet.ServletRequest

Overrides:

getParameter in class javax.servlet.ServletRequestWrapper

getParameterNames

public java.util.Enumeration getParameterNames()

Specified by:

getParameterNames in interface javax.portlet.PortletRequest

Specified by:

getParameterNames in interface javax.servlet.ServletRequest

Overrides:

getParameterNames in class javax.servlet.ServletRequestWrapper

getParameterValues

public java.lang.String[] getParameterValues(java.lang.String name)

Specified by:

getParameterValues in interface javax.portlet.PortletRequest

Specified by:

getParameterValues in interface javax.servlet.ServletRequest

Overrides:

getParameterValues in class javax.servlet.ServletRequestWrapper

getParameterMap

public java.util.Map getParameterMap()

Specified by:

getParameterMap in interface javax.portlet.PortletRequest

Specified by:

getParameterMap in interface javax.servlet.ServletRequest

Overrides:

getParameterMap in class javax.servlet.ServletRequestWrapper

isSecure

public boolean isSecure()

Specified by:

isSecure in interface javax.portlet.PortletRequest

Specified by:

isSecure in interface javax.servlet.ServletRequest

Overrides:

isSecure in class javax.servlet.ServletRequestWrapper

setAttribute

public void setAttribute(java.lang.String name,
                java.lang.Object o)

Specified by:

setAttribute in interface javax.portlet.PortletRequest

Specified by:

setAttribute in interface javax.servlet.ServletRequest

Overrides:

setAttribute in class javax.servlet.ServletRequestWrapper

removeAttribute

public void removeAttribute(java.lang.String name)

Specified by:

removeAttribute in interface javax.portlet.PortletRequest

Specified by:

removeAttribute in interface javax.servlet.ServletRequest

Overrides:

removeAttribute in class javax.servlet.ServletRequestWrapper

getRequestedSessionId

public java.lang.String getRequestedSessionId()

Specified by:

getRequestedSessionId in interface javax.portlet.PortletRequest

Specified by:

getRequestedSessionId in interface javax.servlet.http.HttpServletRequest

Overrides:

getRequestedSessionId in class javax.servlet.http.HttpServletRequestWrapper

isRequestedSessionIdValid

public boolean isRequestedSessionIdValid()

Specified by:

isRequestedSessionIdValid in interface javax.portlet.PortletRequest

Specified by:

isRequestedSessionIdValid in interface javax.servlet.http.HttpServletRequest

Overrides:

isRequestedSessionIdValid in class javax.servlet.http.HttpServletRequestWrapper

getResponseContentType

public java.lang.String getResponseContentType()

Specified by:

getResponseContentType in interface javax.portlet.PortletRequest

getResponseContentTypes

public java.util.Enumeration getResponseContentTypes()

Specified by:

getResponseContentTypes in interface javax.portlet.PortletRequest

getLocale

public java.util.Locale getLocale()

Specified by:

getLocale in interface javax.portlet.PortletRequest

Specified by:

getLocale in interface javax.servlet.ServletRequest

Overrides:

getLocale in class javax.servlet.ServletRequestWrapper

getLocales

public java.util.Enumeration getLocales()

Specified by:

getLocales in interface javax.portlet.PortletRequest

Specified by:

getLocales in interface javax.servlet.ServletRequest

Overrides:

getLocales in class javax.servlet.ServletRequestWrapper

getScheme

public java.lang.String getScheme()

Specified by:

getScheme in interface javax.portlet.PortletRequest

Specified by:

getScheme in interface javax.servlet.ServletRequest

Overrides:

getScheme in class javax.servlet.ServletRequestWrapper

getServerName

public java.lang.String getServerName()

Specified by:

getServerName in interface javax.portlet.PortletRequest

Specified by:

getServerName in interface javax.servlet.ServletRequest

Overrides:

getServerName in class javax.servlet.ServletRequestWrapper

getServerPort

public int getServerPort()

Specified by:

getServerPort in interface javax.portlet.PortletRequest

Specified by:

getServerPort in interface javax.servlet.ServletRequest

Overrides:

getServerPort in class javax.servlet.ServletRequestWrapper

getPortletRequest

public javax.portlet.PortletRequest getPortletRequest()

Return the wrapped ServletRequest object.

setRequest

public void setRequest(javax.portlet.PortletRequest request)

Sets the request being wrapped.

Throws:

java.lang.IllegalArgumentException - if the request is null.