org.apache.pluto.core.impl

Class PortletRequestImpl

java.lang.Object

javax.servlet.ServletRequestWrapper

javax.servlet.http.HttpServletRequestWrapper

org.apache.pluto.core.impl.PortletRequestImpl

All Implemented Interfaces:

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

Direct Known Subclasses:

ActionRequestImpl, RenderRequestImpl

public abstract class PortletRequestImpl
extends javax.servlet.http.HttpServletRequestWrapper
implements javax.portlet.PortletRequest, InternalPortletRequest

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
PortletRequestImpl(PortletWindow portletWindow, javax.servlet.http.HttpServletRequest servletRequest)

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	getCharacterEncoding()
int	getContentLength()
java.lang.String	getContentType()
java.lang.String	getContextPath()
javax.servlet.http.Cookie[]	getCookies()
long	getDateHeader(java.lang.String name)
java.lang.String	getHeader(java.lang.String name)
java.util.Enumeration	getHeaderNames()
java.util.Enumeration	getHeaders(java.lang.String name)
javax.servlet.ServletInputStream	getInputStream()
PortletWindow	getInternalPortletWindow()
int	getIntHeader(java.lang.String name)
java.util.Locale	getLocale()
java.util.Enumeration	getLocales()
java.lang.String	getMethod()
java.lang.String	getParameter(java.lang.String name)
java.util.Map	getParameterMap()
java.util.Enumeration	getParameterNames()
java.lang.String[]	getParameterValues(java.lang.String name)
java.lang.String	getPathInfo()
java.lang.String	getPathTranslated()
javax.portlet.PortalContext	getPortalContext()
javax.portlet.PortletMode	getPortletMode()
javax.portlet.PortletSession	getPortletSession()
javax.portlet.PortletSession	getPortletSession(boolean create)
abstract 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	getProtocol()
java.lang.String	getQueryString()
java.io.BufferedReader	getReader()
java.lang.String	getRealPath(java.lang.String path)
java.lang.String	getRemoteAddr()
java.lang.String	getRemoteHost()
java.lang.String	getRemoteUser()
javax.servlet.RequestDispatcher	getRequestDispatcher(java.lang.String path)
java.lang.String	getRequestedSessionId()
java.lang.String	getRequestURI()
java.lang.StringBuffer	getRequestURL()
java.lang.String	getResponseContentType()
java.util.Enumeration	getResponseContentTypes()
java.lang.String	getScheme()
java.lang.String	getServerName()
int	getServerPort()
java.lang.String	getServletPath()
javax.servlet.http.HttpSession	getSession()
javax.servlet.http.HttpSession	getSession(boolean create)
java.security.Principal	getUserPrincipal()
javax.portlet.WindowState	getWindowState()
boolean	isIncluded()
boolean	isPortletModeAllowed(javax.portlet.PortletMode portletMode)
boolean	isRequestedSessionIdFromCookie()
boolean	isRequestedSessionIdFromUrl() Deprecated. use isRequestedSessionIdFromURL instead
boolean	isRequestedSessionIdFromURL()
boolean	isRequestedSessionIdValid()
boolean	isSecure()
boolean	isUserInRole(java.lang.String roleName) Determines whether a user is mapped to the specified role.
boolean	isWindowStateAllowed(javax.portlet.WindowState state)
void	lateInit(javax.servlet.http.HttpServletRequest webModuleServletRequest)
void	removeAttribute(java.lang.String name)
void	setAttribute(java.lang.String name, java.lang.Object o)
void	setCharacterEncoding(java.lang.String env)
void	setIncluded(boolean included)

Methods inherited from class javax.servlet.ServletRequestWrapper

getRequest, setRequest

Methods inherited from class java.lang.Object

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

Constructor Detail

PortletRequestImpl

public PortletRequestImpl(PortletWindow portletWindow,
                  javax.servlet.http.HttpServletRequest servletRequest)

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 portletMode)

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 abstract 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 roleName)

Determines whether a user is mapped to the specified role. As specified in PLT-20-3, we must reference the <security-role-ref> mappings within the deployment descriptor. If no mapping is available, then, and only then, do we check use the actual role name specified against the web application deployment descriptor.

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

Parameters:

roleName - the name of the role

Returns:

true if it is determined the user has the given role.

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

lateInit

public void lateInit(javax.servlet.http.HttpServletRequest webModuleServletRequest)

Specified by:

lateInit in interface InternalPortletRequest

getInternalPortletWindow

public PortletWindow getInternalPortletWindow()

Specified by:

getInternalPortletWindow in interface InternalPortletRequest

setIncluded

public void setIncluded(boolean included)

Specified by:

setIncluded in interface InternalPortletRequest

isIncluded

public boolean isIncluded()

Specified by:

isIncluded in interface InternalPortletRequest

getCharacterEncoding

public java.lang.String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface javax.servlet.ServletRequest

Overrides:

getCharacterEncoding in class javax.servlet.ServletRequestWrapper

getContentType

public java.lang.String getContentType()

Specified by:

getContentType in interface javax.servlet.ServletRequest

Overrides:

getContentType in class javax.servlet.ServletRequestWrapper

getContentLength

public int getContentLength()

Specified by:

getContentLength in interface javax.servlet.ServletRequest

Overrides:

getContentLength in class javax.servlet.ServletRequestWrapper

getReader

public java.io.BufferedReader getReader()
                                 throws java.io.UnsupportedEncodingException,
                                        java.io.IOException

Specified by:

getReader in interface javax.servlet.ServletRequest

Overrides:

getReader in class javax.servlet.ServletRequestWrapper

Throws:

java.io.UnsupportedEncodingException

java.io.IOException

getCookies

public javax.servlet.http.Cookie[] getCookies()

Specified by:

getCookies in interface javax.servlet.http.HttpServletRequest

Overrides:

getCookies in class javax.servlet.http.HttpServletRequestWrapper

getDateHeader

public long getDateHeader(java.lang.String name)

Specified by:

getDateHeader in interface javax.servlet.http.HttpServletRequest

Overrides:

getDateHeader in class javax.servlet.http.HttpServletRequestWrapper

getHeader

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

Specified by:

getHeader in interface javax.servlet.http.HttpServletRequest

Overrides:

getHeader in class javax.servlet.http.HttpServletRequestWrapper

getHeaders

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

Specified by:

getHeaders in interface javax.servlet.http.HttpServletRequest

Overrides:

getHeaders in class javax.servlet.http.HttpServletRequestWrapper

getHeaderNames

public java.util.Enumeration getHeaderNames()

Specified by:

getHeaderNames in interface javax.servlet.http.HttpServletRequest

Overrides:

getHeaderNames in class javax.servlet.http.HttpServletRequestWrapper

getIntHeader

public int getIntHeader(java.lang.String name)

Specified by:

getIntHeader in interface javax.servlet.http.HttpServletRequest

Overrides:

getIntHeader in class javax.servlet.http.HttpServletRequestWrapper

getPathInfo

public java.lang.String getPathInfo()

Specified by:

getPathInfo in interface javax.servlet.http.HttpServletRequest

Overrides:

getPathInfo in class javax.servlet.http.HttpServletRequestWrapper

getQueryString

public java.lang.String getQueryString()

Specified by:

getQueryString in interface javax.servlet.http.HttpServletRequest

Overrides:

getQueryString in class javax.servlet.http.HttpServletRequestWrapper

getPathTranslated

public java.lang.String getPathTranslated()

Specified by:

getPathTranslated in interface javax.servlet.http.HttpServletRequest

Overrides:

getPathTranslated in class javax.servlet.http.HttpServletRequestWrapper

getRequestURI

public java.lang.String getRequestURI()

Specified by:

getRequestURI in interface javax.servlet.http.HttpServletRequest

Overrides:

getRequestURI in class javax.servlet.http.HttpServletRequestWrapper

getRequestURL

public java.lang.StringBuffer getRequestURL()

Specified by:

getRequestURL in interface javax.servlet.http.HttpServletRequest

Overrides:

getRequestURL in class javax.servlet.http.HttpServletRequestWrapper

getServletPath

public java.lang.String getServletPath()

Specified by:

getServletPath in interface javax.servlet.http.HttpServletRequest

Overrides:

getServletPath in class javax.servlet.http.HttpServletRequestWrapper

getSession

public javax.servlet.http.HttpSession getSession(boolean create)

Specified by:

getSession in interface javax.servlet.http.HttpServletRequest

Overrides:

getSession in class javax.servlet.http.HttpServletRequestWrapper

getSession

public javax.servlet.http.HttpSession getSession()

Specified by:

getSession in interface javax.servlet.http.HttpServletRequest

Overrides:

getSession in class javax.servlet.http.HttpServletRequestWrapper

getMethod

public java.lang.String getMethod()

Specified by:

getMethod in interface javax.servlet.http.HttpServletRequest

Overrides:

getMethod in class javax.servlet.http.HttpServletRequestWrapper

isRequestedSessionIdFromURL

public boolean isRequestedSessionIdFromURL()

Specified by:

isRequestedSessionIdFromURL in interface javax.servlet.http.HttpServletRequest

Overrides:

isRequestedSessionIdFromURL in class javax.servlet.http.HttpServletRequestWrapper

isRequestedSessionIdFromUrl

public boolean isRequestedSessionIdFromUrl()

Deprecated. use isRequestedSessionIdFromURL instead

Specified by:

isRequestedSessionIdFromUrl in interface javax.servlet.http.HttpServletRequest

Overrides:

isRequestedSessionIdFromUrl in class javax.servlet.http.HttpServletRequestWrapper

isRequestedSessionIdFromCookie

public boolean isRequestedSessionIdFromCookie()

Specified by:

isRequestedSessionIdFromCookie in interface javax.servlet.http.HttpServletRequest

Overrides:

isRequestedSessionIdFromCookie in class javax.servlet.http.HttpServletRequestWrapper

getProtocol

public java.lang.String getProtocol()

Specified by:

getProtocol in interface javax.servlet.ServletRequest

Overrides:

getProtocol in class javax.servlet.ServletRequestWrapper

getRemoteAddr

public java.lang.String getRemoteAddr()

Specified by:

getRemoteAddr in interface javax.servlet.ServletRequest

Overrides:

getRemoteAddr in class javax.servlet.ServletRequestWrapper

getRemoteHost

public java.lang.String getRemoteHost()

Specified by:

getRemoteHost in interface javax.servlet.ServletRequest

Overrides:

getRemoteHost in class javax.servlet.ServletRequestWrapper

getRealPath

public java.lang.String getRealPath(java.lang.String path)

Specified by:

getRealPath in interface javax.servlet.ServletRequest

Overrides:

getRealPath in class javax.servlet.ServletRequestWrapper

setCharacterEncoding

public void setCharacterEncoding(java.lang.String env)
                          throws java.io.UnsupportedEncodingException

Specified by:

setCharacterEncoding in interface javax.servlet.ServletRequest

Overrides:

setCharacterEncoding in class javax.servlet.ServletRequestWrapper

Throws:

java.io.UnsupportedEncodingException

getInputStream

public javax.servlet.ServletInputStream getInputStream()
                                                throws java.io.IOException

Specified by:

getInputStream in interface javax.servlet.ServletRequest

Overrides:

getInputStream in class javax.servlet.ServletRequestWrapper

Throws:

java.io.IOException

getRequestDispatcher

public javax.servlet.RequestDispatcher getRequestDispatcher(java.lang.String path)

Specified by:

getRequestDispatcher in interface javax.servlet.ServletRequest

Overrides:

getRequestDispatcher in class javax.servlet.ServletRequestWrapper