org.exoplatform.services.portletcontainer.plugins.pc.portletAPIImp
Class PortletRequestImp

java.lang.Object
  javax.servlet.ServletRequestWrapper
      javax.servlet.http.HttpServletRequestWrapper
          org.exoplatform.services.portletcontainer.plugins.pc.portletAPIImp.PortletRequestImp

All Implemented Interfaces:

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

Direct Known Subclasses:

ClientDataRequestImp, EventRequestImp, RenderRequestImp

public abstract class PortletRequestImp
extends javax.servlet.http.HttpServletRequestWrapper
implements javax.portlet.PortletRequest, Map

Created by The eXo Platform SAS. Author : Mestrallet Benjamin benjmestrallet@users.sourceforge.net Date: Jul 27, 2003 Time: 8:44:32 PM This implementation acts like a wrapper to the global ServletRequest This object should be pooled, therefore two fill and empty methods are provided.

Nested Class Summary

Nested classes/interfaces inherited from interface javax.portlet.PortletRequest

javax.portlet.PortletRequest.P3PUserInfos

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

protected org.exoplatform.container.ExoContainer	cont Exo container.
protected String	enc Encoding.
protected boolean	encodingModified Was encoding modified.
protected RequestContext	reqCtx Request context.

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

Fields inherited from interface javax.servlet.http.HttpServletRequest

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

PortletRequestImp(RequestContext reqCtx)

Method Summary

void	clear() Overridden method.
boolean	containsKey(Object key) Overridden method.
boolean	containsValue(Object value) Overridden method.
Set	entrySet() Overridden method.
Object	get(Object key) Overridden method.
Object	getAttribute(String name) Overridden method.
String	getAuthType() Overridden method.
String	getContextPath() Overridden method.
Input	getInput()
Locale	getLocale() Overridden method.
Enumeration<Locale>	getLocales() Overridden method.
String	getParameter(String param) Overridden method.
Map<String,String[]>	getParameterMap() Overridden method.
Enumeration<String>	getParameterNames() Overridden method.
String[]	getParameterValues(String s) Overridden method.
javax.portlet.PortalContext	getPortalContext() Overridden method.
javax.portlet.PortletConfig	getPortletConfig()
Portlet	getPortletDatas()
javax.portlet.PortletMode	getPortletMode() Overridden method.
javax.portlet.PortletSession	getPortletSession() Overridden method.
javax.portlet.PortletSession	getPortletSession(boolean create) Overridden method.
PortletWindowInternal	getPortletWindowInternal()
javax.portlet.PortletPreferences	getPreferences() Overridden method.
Map<String,String[]>	getPrivateParameterMap() Overridden method.
Enumeration<String>	getProperties(String s) Overridden method.
String	getProperty(String s) Overridden method.
Enumeration<String>	getPropertyNames() Overridden method.
Map<String,String[]>	getPublicParameterMap() Overridden method.
String	getResponseContentType() Overridden method.
Enumeration<String>	getResponseContentTypes() Overridden method.
String	getWindowID() Overridden method.
javax.portlet.WindowState	getWindowState() Overridden method.
boolean	isEmpty() Overridden method.
boolean	isPortletModeAllowed(javax.portlet.PortletMode portletMode) Overridden method.
boolean	isRequestedSessionIdValid() Overridden method.
boolean	isUserInRole(String role) Overridden method.
boolean	isWindowStateAllowed(javax.portlet.WindowState windowState) Overridden method.
Set	keySet() Overridden method.
boolean	needsSecurityContraints(String portletName)
Object	put(Object key, Object value) Overridden method.
void	putAll(Map t) Overridden method.
Object	remove(Object key) Overridden method.
void	removeAttribute(String name) Overridden method.
void	setAttribute(String name, Object value) Overridden method.
int	size() Overridden method.
Collection	values() Overridden method.

Methods inherited from class javax.servlet.http.HttpServletRequestWrapper

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

Methods inherited from class javax.servlet.ServletRequestWrapper

getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getInputStream, getLocalAddr, getLocalName, getLocalPort, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequest, getRequestDispatcher, getScheme, getServerName, getServerPort, isSecure, 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.portlet.PortletRequest

getAttributeNames, getCookies, getRemoteUser, getRequestedSessionId, getScheme, getServerName, getServerPort, getUserPrincipal, isSecure

Methods inherited from interface java.util.Map

equals, hashCode

Methods inherited from interface javax.servlet.ServletRequest

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

Field Detail

cont

protected org.exoplatform.container.ExoContainer cont

Exo container.

reqCtx

protected RequestContext reqCtx

Request context.

encodingModified

protected boolean encodingModified

Was encoding modified.

enc

protected String enc

Encoding.

Constructor Detail

PortletRequestImp

public PortletRequestImp(RequestContext reqCtx)

Parameters:

reqCtx - request context

Method Detail

isWindowStateAllowed

public final boolean isWindowStateAllowed(javax.portlet.WindowState windowState)

Overridden method.

Specified by:

isWindowStateAllowed in interface javax.portlet.PortletRequest

Parameters:

windowState - window state

Returns:

is window state allowed

See Also:

PortletRequest.isWindowStateAllowed(javax.portlet.WindowState)

isPortletModeAllowed

public final boolean isPortletModeAllowed(javax.portlet.PortletMode portletMode)

Overridden method.

Specified by:

isPortletModeAllowed in interface javax.portlet.PortletRequest

Parameters:

portletMode - portlet mode

Returns:

is portlet mode allowed

See Also:

PortletRequest.isPortletModeAllowed(javax.portlet.PortletMode)

getPortletConfig

public final javax.portlet.PortletConfig getPortletConfig()

Returns:

portlet config

getInput

public final Input getInput()

Returns:

input

getPortletMode

public final javax.portlet.PortletMode getPortletMode()

Overridden method.

Specified by:

getPortletMode in interface javax.portlet.PortletRequest

Returns:

portlet mode

See Also:

PortletRequest.getPortletMode()

getWindowState

public final javax.portlet.WindowState getWindowState()

Overridden method.

Specified by:

getWindowState in interface javax.portlet.PortletRequest

Returns:

window state

See Also:

PortletRequest.getWindowState()

getPreferences

public final javax.portlet.PortletPreferences getPreferences()

Overridden method.

Specified by:

getPreferences in interface javax.portlet.PortletRequest

Returns:

preferences

See Also:

PortletRequest.getPreferences()

getPortletSession

public final javax.portlet.PortletSession getPortletSession()

Overridden method.

Specified by:

getPortletSession in interface javax.portlet.PortletRequest

Returns:

portlet session

See Also:

PortletRequest.getPortletSession()

getPortletSession

public final javax.portlet.PortletSession getPortletSession(boolean create)

Overridden method.

Specified by:

getPortletSession in interface javax.portlet.PortletRequest

Parameters:

create - if to create

Returns:

portlet session

See Also:

PortletRequest.getPortletSession(boolean)

isRequestedSessionIdValid

public final boolean isRequestedSessionIdValid()

Overridden method.

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

Returns:

is requested session id valid

See Also:

HttpServletRequestWrapper.isRequestedSessionIdValid()

getProperty

public final String getProperty(String s)

Overridden method.

Specified by:

getProperty in interface javax.portlet.PortletRequest

Parameters:

s - name

Returns:

value

See Also:

PortletRequest.getProperty(java.lang.String)

getProperties

public final Enumeration<String> getProperties(String s)

Overridden method.

Specified by:

getProperties in interface javax.portlet.PortletRequest

Parameters:

s - name

Returns:

values

See Also:

PortletRequest.getProperties(java.lang.String)

getPropertyNames

public final Enumeration<String> getPropertyNames()

Overridden method.

Specified by:

getPropertyNames in interface javax.portlet.PortletRequest

Returns:

property names

See Also:

PortletRequest.getPropertyNames()

getPortalContext

public final javax.portlet.PortalContext getPortalContext()

Overridden method.

Specified by:

getPortalContext in interface javax.portlet.PortletRequest

Returns:

portal context

See Also:

PortletRequest.getPortalContext()

getResponseContentType

public final String getResponseContentType()

Overridden method.

Specified by:

getResponseContentType in interface javax.portlet.PortletRequest

Returns:

response content types

See Also:

PortletRequest.getResponseContentType()

getResponseContentTypes

public final Enumeration<String> getResponseContentTypes()

Overridden method.

Specified by:

getResponseContentTypes in interface javax.portlet.PortletRequest

Returns:

response content type

See Also:

PortletRequest.getResponseContentTypes()

isUserInRole

public final boolean isUserInRole(String role)

Overridden method.

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:

role - role

Returns:

is user in role

See Also:

HttpServletRequestWrapper.isUserInRole(java.lang.String)

getPortletDatas

public final Portlet getPortletDatas()

Returns:

portlet datas

getPortletWindowInternal

public final PortletWindowInternal getPortletWindowInternal()

Returns:

portlet window internal object

needsSecurityContraints

public final boolean needsSecurityContraints(String portletName)

Parameters:

portletName - portlet name

Returns:

does it need security constraint

getAuthType

public final String getAuthType()

Overridden method.

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

Returns:

auth type

See Also:

HttpServletRequestWrapper.getAuthType()

getAttribute

public final Object getAttribute(String name)

Overridden method.

Specified by:

getAttribute in interface javax.portlet.PortletRequest

Specified by:

getAttribute in interface javax.servlet.ServletRequest

Overrides:

getAttribute in class javax.servlet.ServletRequestWrapper

Parameters:

name - name

Returns:

value

See Also:

ServletRequestWrapper.getAttribute(java.lang.String)

setAttribute

public final void setAttribute(String name,
                               Object value)

Overridden method.

Specified by:

setAttribute in interface javax.portlet.PortletRequest

Specified by:

setAttribute in interface javax.servlet.ServletRequest

Overrides:

setAttribute in class javax.servlet.ServletRequestWrapper

Parameters:

name - name

value - value

See Also:

ServletRequestWrapper.setAttribute(java.lang.String, java.lang.Object)

removeAttribute

public final void removeAttribute(String name)

Overridden method.

Specified by:

removeAttribute in interface javax.portlet.PortletRequest

Specified by:

removeAttribute in interface javax.servlet.ServletRequest

Overrides:

removeAttribute in class javax.servlet.ServletRequestWrapper

Parameters:

name - name

See Also:

ServletRequestWrapper.removeAttribute(java.lang.String)

getContextPath

public final String getContextPath()

Overridden method.

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

Returns:

context path

See Also:

HttpServletRequestWrapper.getContextPath()

size

public final int size()

Overridden method.

Specified by:

size in interface Map

Returns:

size

See Also:

Map.size()

isEmpty

public final boolean isEmpty()

Overridden method.

Specified by:

isEmpty in interface Map

Returns:

is empty

See Also:

Map.isEmpty()

containsKey

public final boolean containsKey(Object key)

Overridden method.

Specified by:

containsKey in interface Map

Parameters:

key - key

Returns:

if contains key

See Also:

Map.containsKey(java.lang.Object)

containsValue

public final boolean containsValue(Object value)

Overridden method.

Specified by:

containsValue in interface Map

Parameters:

value - value

Returns:

if contains value

See Also:

Map.containsValue(java.lang.Object)

get

public final Object get(Object key)

Overridden method.

Specified by:

get in interface Map

Parameters:

key - key

Returns:

value

See Also:

Map.get(java.lang.Object)

put

public final Object put(Object key,
                        Object value)

Overridden method.

Specified by:

put in interface Map

Parameters:

key - key

value - value

Returns:

value

See Also:

Map.put(java.lang.Object, java.lang.Object)

remove

public final Object remove(Object key)

Overridden method.

Specified by:

remove in interface Map

Parameters:

key - key

Returns:

remove object

See Also:

Map.remove(java.lang.Object)

putAll

public final void putAll(Map t)

Overridden method.

Specified by:

putAll in interface Map

Parameters:

t - source map

See Also:

Map.putAll(java.util.Map)

clear

public final void clear()

Overridden method.

Specified by:

clear in interface Map

See Also:

Map.clear()

keySet

public final Set keySet()

Overridden method.

Specified by:

keySet in interface Map

Returns:

key set

See Also:

Map.keySet()

values

public final Collection values()

Overridden method.

Specified by:

values in interface Map

Returns:

values

See Also:

Map.values()

entrySet

public final Set entrySet()

Overridden method.

Specified by:

entrySet in interface Map

Returns:

entry set

See Also:

Map.entrySet()

getLocale

public final Locale getLocale()

Overridden method.

Specified by:

getLocale in interface javax.portlet.PortletRequest

Specified by:

getLocale in interface javax.servlet.ServletRequest

Overrides:

getLocale in class javax.servlet.ServletRequestWrapper

Returns:

locale

See Also:

ServletRequestWrapper.getLocale()

getLocales

public final Enumeration<Locale> getLocales()

Overridden method.

Specified by:

getLocales in interface javax.portlet.PortletRequest

Specified by:

getLocales in interface javax.servlet.ServletRequest

Overrides:

getLocales in class javax.servlet.ServletRequestWrapper

Returns:

locales

See Also:

ServletRequestWrapper.getLocales()

getWindowID

public final String getWindowID()

Overridden method. added for jsr-286

Specified by:

getWindowID in interface javax.portlet.PortletRequest

Returns:

window id

See Also:

PortletRequest.getWindowID()

getParameter

public String getParameter(String param)

Overridden method.

Specified by:

getParameter in interface javax.portlet.PortletRequest

Specified by:

getParameter in interface javax.servlet.ServletRequest

Overrides:

getParameter in class javax.servlet.ServletRequestWrapper

Parameters:

param - name

Returns:

value

See Also:

ServletRequestWrapper.getParameter(java.lang.String)

getParameterNames

public Enumeration<String> getParameterNames()

Overridden method.

Specified by:

getParameterNames in interface javax.portlet.PortletRequest

Specified by:

getParameterNames in interface javax.servlet.ServletRequest

Overrides:

getParameterNames in class javax.servlet.ServletRequestWrapper

Returns:

parameter names

See Also:

ServletRequestWrapper.getParameterNames()

getParameterValues

public String[] getParameterValues(String s)

Overridden method.

Specified by:

getParameterValues in interface javax.portlet.PortletRequest

Specified by:

getParameterValues in interface javax.servlet.ServletRequest

Overrides:

getParameterValues in class javax.servlet.ServletRequestWrapper

Parameters:

s - name

Returns:

values

See Also:

ServletRequestWrapper.getParameterValues(java.lang.String)

getParameterMap

public Map<String,String[]> getParameterMap()

Overridden method.

Specified by:

getParameterMap in interface javax.portlet.PortletRequest

Specified by:

getParameterMap in interface javax.servlet.ServletRequest

Overrides:

getParameterMap in class javax.servlet.ServletRequestWrapper

Returns:

parameter map

See Also:

ServletRequestWrapper.getParameterMap()

getPrivateParameterMap

public final Map<String,String[]> getPrivateParameterMap()

Overridden method.

Specified by:

getPrivateParameterMap in interface javax.portlet.PortletRequest

Returns:

private parameter map

See Also:

PortletRequest.getPrivateParameterMap()

getPublicParameterMap

public final Map<String,String[]> getPublicParameterMap()

Overridden method.

Specified by:

getPublicParameterMap in interface javax.portlet.PortletRequest

Returns:

public parameter map

See Also:

PortletRequest.getPublicParameterMap()