org.exoplatform.services.portletcontainer.plugins.pc.portletAPIImp.helpers
Class CustomRequestWrapper

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

All Implemented Interfaces:

javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest

public class CustomRequestWrapper
extends javax.servlet.http.HttpServletRequestWrapper

Created by The eXo Platform SAS. Author : Mestrallet Benjamin benjmestrallet@users.sourceforge.net Date: Jul 29, 2003 Time: 2:24:57 AM This wrapper manages the incoming request to only provide the attributes and parameters that are in the name space of the receiving portlet.
This is done using a correct encoding and decoding windowId?attributeName

Field Summary

String	contextPath Context path.
String	pathInfo Path info.
String	query Query.
String	servletPath Servlet path.

Fields inherited from interface javax.servlet.http.HttpServletRequest

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

CustomRequestWrapper(javax.servlet.http.HttpServletRequest httpServletRequest, String windowId)

Method Summary

Object	getAttribute(String s) Overridden method.
Enumeration<String>	getAttributeNames() Overridden method.
String	getCharacterEncoding() Overridden method.
int	getContentLength() Overridden method.
String	getContentType() Overridden method.
String	getContextPath() Overridden method.
javax.servlet.ServletInputStream	getInputStream() Overridden method.
String	getLocalAddr() Overridden method.
String	getLocalName() Overridden method.
int	getLocalPort() Overridden method.
Map<String,String[]>	getParameterMap() Overridden method.
String	getPathInfo() Overridden method.
String	getProtocol() Overridden method.
String	getQueryString() Overridden method.
BufferedReader	getReader() Overridden method.
String	getRealPath(String arg0) Overridden method.
String	getRemoteAddr() Overridden method.
String	getRemoteHost() Overridden method.
int	getRemotePort() Overridden method.
String	getRequestURI() Overridden method.
StringBuffer	getRequestURL() Overridden method.
String	getServletPath() Overridden method.
javax.servlet.http.HttpSession	getSession() Overridden method.
javax.servlet.http.HttpSession	getSession(boolean b) Overridden method.
boolean	isRedirected()
boolean	isRequestedSessionIdValid() Overridden method.
void	removeAttribute(String s) Overridden method.
void	setAttribute(String s, Object o) Overridden method.
void	setCharacterEncoding(String arg0) Overridden method.
void	setContextPath(String string)
void	setNoInput(boolean noInput)
void	setNoValues(boolean noValues)
void	setParameterMap(Map<String,String[]> map)
void	setRedirected(boolean b)
void	setRedirectedPath(String path)

Methods inherited from class javax.servlet.http.HttpServletRequestWrapper

getAuthType, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getIntHeader, getMethod, getPathTranslated, getRemoteUser, getRequestedSessionId, getUserPrincipal, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isUserInRole

Methods inherited from class javax.servlet.ServletRequestWrapper

getLocale, getLocales, getParameter, getParameterNames, getParameterValues, getRequest, getRequestDispatcher, getScheme, getServerName, getServerPort, isSecure, 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

getLocale, getLocales, getParameter, getParameterNames, getParameterValues, getRequestDispatcher, getScheme, getServerName, getServerPort, isSecure

Field Detail

pathInfo

public String pathInfo

Path info.

servletPath

public String servletPath

Servlet path.

query

public String query

Query.

contextPath

public String contextPath

Context path.

Constructor Detail

CustomRequestWrapper

public CustomRequestWrapper(javax.servlet.http.HttpServletRequest httpServletRequest,
                            String windowId)

Parameters:

httpServletRequest - http servlet request

windowId - window id

Method Detail

getAttributeNames

public final Enumeration<String> getAttributeNames()

Overridden method.

Specified by:

getAttributeNames in interface javax.servlet.ServletRequest

Overrides:

getAttributeNames in class javax.servlet.ServletRequestWrapper

Returns:

attribute names

See Also:

ServletRequestWrapper.getAttributeNames()

getAttribute

public final Object getAttribute(String s)

Overridden method.

Specified by:

getAttribute in interface javax.servlet.ServletRequest

Overrides:

getAttribute in class javax.servlet.ServletRequestWrapper

Parameters:

s - name

Returns:

value

See Also:

ServletRequestWrapper.getAttribute(java.lang.String)

removeAttribute

public final void removeAttribute(String s)

Overridden method.

Specified by:

removeAttribute in interface javax.servlet.ServletRequest

Overrides:

removeAttribute in class javax.servlet.ServletRequestWrapper

Parameters:

s - name

See Also:

ServletRequestWrapper.removeAttribute(java.lang.String)

setAttribute

public final void setAttribute(String s,
                               Object o)

Overridden method.

Specified by:

setAttribute in interface javax.servlet.ServletRequest

Overrides:

setAttribute in class javax.servlet.ServletRequestWrapper

Parameters:

s - name

o - value

See Also:

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

getParameterMap

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

Overridden method.

Specified by:

getParameterMap in interface javax.servlet.ServletRequest

Overrides:

getParameterMap in class javax.servlet.ServletRequestWrapper

Returns:

parameter map

See Also:

ServletRequestWrapper.getParameterMap()

setParameterMap

public final void setParameterMap(Map<String,String[]> map)

Parameters:

map - parameter map

isRedirected

public final boolean isRedirected()

Returns:

is redirected

setRedirected

public final void setRedirected(boolean b)

Parameters:

b - redirected

getContentLength

public final int getContentLength()

Overridden method.

Specified by:

getContentLength in interface javax.servlet.ServletRequest

Overrides:

getContentLength in class javax.servlet.ServletRequestWrapper

Returns:

content length

See Also:

ServletRequestWrapper.getContentLength()

getRequestURL

public final StringBuffer getRequestURL()

Overridden method.

Specified by:

getRequestURL in interface javax.servlet.http.HttpServletRequest

Overrides:

getRequestURL in class javax.servlet.http.HttpServletRequestWrapper

Returns:

requested url

See Also:

HttpServletRequestWrapper.getRequestURL()

getCharacterEncoding

public final String getCharacterEncoding()

Overridden method.

Specified by:

getCharacterEncoding in interface javax.servlet.ServletRequest

Overrides:

getCharacterEncoding in class javax.servlet.ServletRequestWrapper

Returns:

character encoding

See Also:

ServletRequestWrapper.getCharacterEncoding()

getContentType

public final String getContentType()

Overridden method.

Specified by:

getContentType in interface javax.servlet.ServletRequest

Overrides:

getContentType in class javax.servlet.ServletRequestWrapper

Returns:

content type

See Also:

ServletRequestWrapper.getContentType()

getInputStream

public final javax.servlet.ServletInputStream getInputStream()
                                                      throws IOException

Overridden method.

Specified by:

getInputStream in interface javax.servlet.ServletRequest

Overrides:

getInputStream in class javax.servlet.ServletRequestWrapper

Returns:

input stream

Throws:

IOException - exception

See Also:

ServletRequestWrapper.getInputStream()

getReader

public final BufferedReader getReader()
                               throws IOException

Overridden method.

Specified by:

getReader in interface javax.servlet.ServletRequest

Overrides:

getReader in class javax.servlet.ServletRequestWrapper

Returns:

reader

Throws:

IOException - exception

See Also:

ServletRequestWrapper.getReader()

getLocalAddr

public final String getLocalAddr()

Overridden method.

Specified by:

getLocalAddr in interface javax.servlet.ServletRequest

Overrides:

getLocalAddr in class javax.servlet.ServletRequestWrapper

Returns:

local addr

See Also:

ServletRequestWrapper.getLocalAddr()

getLocalName

public final String getLocalName()

Overridden method.

Specified by:

getLocalName in interface javax.servlet.ServletRequest

Overrides:

getLocalName in class javax.servlet.ServletRequestWrapper

Returns:

local name

See Also:

ServletRequestWrapper.getLocalName()

getLocalPort

public final int getLocalPort()

Overridden method.

Specified by:

getLocalPort in interface javax.servlet.ServletRequest

Overrides:

getLocalPort in class javax.servlet.ServletRequestWrapper

Returns:

local port

See Also:

ServletRequestWrapper.getLocalPort()

getRemotePort

public final int getRemotePort()

Overridden method.

Specified by:

getRemotePort in interface javax.servlet.ServletRequest

Overrides:

getRemotePort in class javax.servlet.ServletRequestWrapper

Returns:

remote port

See Also:

ServletRequestWrapper.getRemotePort()

getRealPath

public final String getRealPath(String arg0)

Overridden method.

Specified by:

getRealPath in interface javax.servlet.ServletRequest

Overrides:

getRealPath in class javax.servlet.ServletRequestWrapper

Parameters:

arg0 - path

Returns:

real path

See Also:

ServletRequestWrapper.getRealPath(java.lang.String)

getRemoteAddr

public final String getRemoteAddr()

Overridden method.

Specified by:

getRemoteAddr in interface javax.servlet.ServletRequest

Overrides:

getRemoteAddr in class javax.servlet.ServletRequestWrapper

Returns:

remote addr

See Also:

ServletRequestWrapper.getRemoteAddr()

getRemoteHost

public final String getRemoteHost()

Overridden method.

Specified by:

getRemoteHost in interface javax.servlet.ServletRequest

Overrides:

getRemoteHost in class javax.servlet.ServletRequestWrapper

Returns:

remote host

See Also:

ServletRequestWrapper.getRemoteHost()

setCharacterEncoding

public final void setCharacterEncoding(String arg0)
                                throws UnsupportedEncodingException

Overridden method.

Specified by:

setCharacterEncoding in interface javax.servlet.ServletRequest

Overrides:

setCharacterEncoding in class javax.servlet.ServletRequestWrapper

Parameters:

arg0 - character encoding

Throws:

UnsupportedEncodingException - exception

See Also:

ServletRequestWrapper.setCharacterEncoding(java.lang.String)

getProtocol

public final String getProtocol()

Overridden method.

Specified by:

getProtocol in interface javax.servlet.ServletRequest

Overrides:

getProtocol in class javax.servlet.ServletRequestWrapper

Returns:

http protocol

See Also:

ServletRequestWrapper.getProtocol()

getSession

public final javax.servlet.http.HttpSession getSession()

Overridden method.

Specified by:

getSession in interface javax.servlet.http.HttpServletRequest

Overrides:

getSession in class javax.servlet.http.HttpServletRequestWrapper

Returns:

http session

See Also:

HttpServletRequestWrapper.getSession()

getSession

public final javax.servlet.http.HttpSession getSession(boolean b)

Overridden method.

Specified by:

getSession in interface javax.servlet.http.HttpServletRequest

Overrides:

getSession in class javax.servlet.http.HttpServletRequestWrapper

Parameters:

b - if to create

Returns:

http session

See Also:

HttpServletRequestWrapper.getSession(boolean)

isRequestedSessionIdValid

public final boolean isRequestedSessionIdValid()

Overridden method.

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

setContextPath

public final void setContextPath(String string)

Parameters:

string - context path

getContextPath

public final String getContextPath()

Overridden method.

Specified by:

getContextPath in interface javax.servlet.http.HttpServletRequest

Overrides:

getContextPath in class javax.servlet.http.HttpServletRequestWrapper

Returns:

context path

See Also:

HttpServletRequestWrapper.getContextPath()

setRedirectedPath

public final void setRedirectedPath(String path)

Parameters:

path - redirected path

getPathInfo

public final String getPathInfo()

Overridden method.

Specified by:

getPathInfo in interface javax.servlet.http.HttpServletRequest

Overrides:

getPathInfo in class javax.servlet.http.HttpServletRequestWrapper

Returns:

path info

See Also:

HttpServletRequestWrapper.getPathInfo()

getServletPath

public final String getServletPath()

Overridden method.

Specified by:

getServletPath in interface javax.servlet.http.HttpServletRequest

Overrides:

getServletPath in class javax.servlet.http.HttpServletRequestWrapper

Returns:

servlet path

See Also:

HttpServletRequestWrapper.getServletPath()

getQueryString

public final String getQueryString()

Overridden method.

Specified by:

getQueryString in interface javax.servlet.http.HttpServletRequest

Overrides:

getQueryString in class javax.servlet.http.HttpServletRequestWrapper

Returns:

query string

See Also:

HttpServletRequestWrapper.getQueryString()

getRequestURI

public final String getRequestURI()

Overridden method.

Specified by:

getRequestURI in interface javax.servlet.http.HttpServletRequest

Overrides:

getRequestURI in class javax.servlet.http.HttpServletRequestWrapper

Returns:

request uri

See Also:

HttpServletRequestWrapper.getRequestURI()

setNoInput

public final void setNoInput(boolean noInput)

Parameters:

noInput - noInput

setNoValues

public final void setNoValues(boolean noValues)

Parameters:

noValues - noValues