DispatchedHttpServletRequest (GateIn - Portlet Container (pc) 5.3.2-RC02 API)

java.lang.Object
- javax.servlet.ServletRequestWrapper
- - javax.servlet.http.HttpServletRequestWrapper
  - - org.gatein.pc.portlet.impl.jsr168.DispatchedHttpServletRequest

All Implemented Interfaces:

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

Direct Known Subclasses:

DispatchedHttpServletRequest.ClientData, DispatchedHttpServletRequest.Mime
```
public abstract class DispatchedHttpServletRequest
extends javax.servlet.http.HttpServletRequestWrapper
```
Version:

$Revision: 6903 $

Author:

Julien Viet

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`DispatchedHttpServletRequest.Action`
`static class`	`DispatchedHttpServletRequest.ClientData`
`static class`	`DispatchedHttpServletRequest.Event`
`static class`	`DispatchedHttpServletRequest.Mime`
`static class`	`DispatchedHttpServletRequest.Render`
`static class`	`DispatchedHttpServletRequest.Resource`

Field Summary
- Fields inherited from interface javax.servlet.http.HttpServletRequest
  BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

Constructors
Constructor and Description
`DispatchedHttpServletRequest(Dispatch dispatch, javax.portlet.PortletRequest preq, javax.servlet.http.HttpServletRequestWrapper dreq, javax.servlet.ServletContext servletContext)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`getAttribute(String s)`
`Enumeration`	`getAttributeNames()`
`String`	`getAuthType()`
`abstract String`	`getCharacterEncoding()`
`abstract int`	`getContentLength()`
`abstract String`	`getContentType()`
`String`	`getContextPath()`
`javax.servlet.http.Cookie[]`	`getCookies()`
`long`	`getDateHeader(String s)`
`String`	`getHeader(String s)`
`Enumeration`	`getHeaderNames()`
`Enumeration`	`getHeaders(String s)`
`abstract javax.servlet.ServletInputStream`	`getInputStream()`
`int`	`getIntHeader(String s)`
`String`	`getLocalAddr()`
`Locale`	`getLocale()`
`Enumeration`	`getLocales()`
`String`	`getLocalName()`
`int`	`getLocalPort()`
`abstract String`	`getMethod()`
`String`	`getParameter(String name)`
`Map`	`getParameterMap()`
`Enumeration`	`getParameterNames()`
`String[]`	`getParameterValues(String name)`
`String`	`getPathInfo()`
`String`	`getPathTranslated()`
`String`	`getProtocol()`
`String`	`getQueryString()`
`abstract BufferedReader`	`getReader()`
`String`	`getRealPath(String s)`
`String`	`getRemoteAddr()`
`String`	`getRemoteHost()`
`int`	`getRemotePort()`
`String`	`getRemoteUser()`
`javax.servlet.ServletRequest`	`getRequest()`
`javax.servlet.RequestDispatcher`	`getRequestDispatcher(String s)`
`String`	`getRequestedSessionId()`
`String`	`getRequestURI()`
`StringBuffer`	`getRequestURL()`
`String`	`getScheme()`
`String`	`getServerName()`
`int`	`getServerPort()`
`String`	`getServletPath()`
`javax.servlet.http.HttpSession`	`getSession()`
`javax.servlet.http.HttpSession`	`getSession(boolean b)`
`Principal`	`getUserPrincipal()`
`boolean`	`isRequestedSessionIdFromCookie()`
`boolean`	`isRequestedSessionIdFromUrl()`
`boolean`	`isRequestedSessionIdFromURL()`
`boolean`	`isRequestedSessionIdValid()`
`boolean`	`isSecure()`
`boolean`	`isUserInRole(String s)`
`void`	`removeAttribute(String s)`
`void`	`setAttribute(String s, Object o)`
`abstract void`	`setCharacterEncoding(String s)`
`void`	`setRequest(javax.servlet.ServletRequest servletRequest)`

Methods inherited from class javax.servlet.http.HttpServletRequestWrapper
authenticate, changeSessionId, getPart, getParts, login, logout, upgrade

Methods inherited from class javax.servlet.ServletRequestWrapper
getAsyncContext, getContentLengthLong, getDispatcherType, getServletContext, isAsyncStarted, isAsyncSupported, isWrapperFor, isWrapperFor, startAsync, startAsync

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
getAsyncContext, getContentLengthLong, getDispatcherType, getServletContext, isAsyncStarted, isAsyncSupported, startAsync, startAsync

- Constructor Detail
  - DispatchedHttpServletRequest
```
public DispatchedHttpServletRequest(Dispatch dispatch,
                                    javax.portlet.PortletRequest preq,
                                    javax.servlet.http.HttpServletRequestWrapper dreq,
                                    javax.servlet.ServletContext servletContext)
```
- Method Detail
  - getRemoteAddr
```
public final String getRemoteAddr()
```
    Specified by:
    
    getRemoteAddr in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getRemoteAddr in class javax.servlet.ServletRequestWrapper
  - getRemoteHost
```
public final String getRemoteHost()
```
    Specified by:
    
    getRemoteHost in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getRemoteHost in class javax.servlet.ServletRequestWrapper
  - getRealPath
```
public final String getRealPath(String s)
```
    Specified by:
    
    getRealPath in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getRealPath in class javax.servlet.ServletRequestWrapper
  - getLocalAddr
```
public final String getLocalAddr()
```
    Specified by:
    
    getLocalAddr in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getLocalAddr in class javax.servlet.ServletRequestWrapper
  - getLocalName
```
public final String getLocalName()
```
    Specified by:
    
    getLocalName in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getLocalName in class javax.servlet.ServletRequestWrapper
  - getRequestURL
```
public final StringBuffer getRequestURL()
```
    Specified by:
    
    getRequestURL in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    getRequestURL in class javax.servlet.http.HttpServletRequestWrapper
  - getRemotePort
```
public final int getRemotePort()
```
    Specified by:
    
    getRemotePort in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getRemotePort in class javax.servlet.ServletRequestWrapper
  - getLocalPort
```
public final int getLocalPort()
```
    Specified by:
    
    getLocalPort in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getLocalPort in class javax.servlet.ServletRequestWrapper
  - getPathTranslated
```
public final String getPathTranslated()
```
    Specified by:
    
    getPathTranslated in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    getPathTranslated in class javax.servlet.http.HttpServletRequestWrapper
  - getPathInfo
```
public final String getPathInfo()
```
    Specified by:
    
    getPathInfo in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    getPathInfo in class javax.servlet.http.HttpServletRequestWrapper
  - getQueryString
```
public final String getQueryString()
```
    Specified by:
    
    getQueryString in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    getQueryString in class javax.servlet.http.HttpServletRequestWrapper
  - getRequestURI
```
public final String getRequestURI()
```
    Specified by:
    
    getRequestURI in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    getRequestURI in class javax.servlet.http.HttpServletRequestWrapper
  - getServletPath
```
public final String getServletPath()
```
    Specified by:
    
    getServletPath in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    getServletPath in class javax.servlet.http.HttpServletRequestWrapper
  - getScheme
```
public final String getScheme()
```
    Specified by:
    
    getScheme in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getScheme in class javax.servlet.ServletRequestWrapper
  - getServerName
```
public final String getServerName()
```
    Specified by:
    
    getServerName in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getServerName in class javax.servlet.ServletRequestWrapper
  - getServerPort
```
public final int getServerPort()
```
    Specified by:
    
    getServerPort in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getServerPort in class javax.servlet.ServletRequestWrapper
  - getAttribute
```
public final Object getAttribute(String s)
```
    Specified by:
    
    getAttribute in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getAttribute in class javax.servlet.ServletRequestWrapper
  - getAttributeNames
```
public final Enumeration getAttributeNames()
```
    Specified by:
    
    getAttributeNames in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getAttributeNames in class javax.servlet.ServletRequestWrapper
  - setAttribute
```
public final void setAttribute(String s,
                               Object o)
```
    Specified by:
    
    setAttribute in interface javax.servlet.ServletRequest
    
    Overrides:
    
    setAttribute in class javax.servlet.ServletRequestWrapper
  - removeAttribute
```
public final void removeAttribute(String s)
```
    Specified by:
    
    removeAttribute in interface javax.servlet.ServletRequest
    
    Overrides:
    
    removeAttribute in class javax.servlet.ServletRequestWrapper
  - getLocale
```
public final Locale getLocale()
```
    Specified by:
    
    getLocale in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getLocale in class javax.servlet.ServletRequestWrapper
  - getLocales
```
public final Enumeration getLocales()
```
    Specified by:
    
    getLocales in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getLocales in class javax.servlet.ServletRequestWrapper
  - isSecure
```
public boolean isSecure()
```
    Specified by:
    
    isSecure in interface javax.servlet.ServletRequest
    
    Overrides:
    
    isSecure in class javax.servlet.ServletRequestWrapper
  - getAuthType
```
public final String getAuthType()
```
    Specified by:
    
    getAuthType in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    getAuthType in class javax.servlet.http.HttpServletRequestWrapper
  - getContextPath
```
public final String getContextPath()
```
    Specified by:
    
    getContextPath in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    getContextPath in class javax.servlet.http.HttpServletRequestWrapper
  - getRemoteUser
```
public final String getRemoteUser()
```
    Specified by:
    
    getRemoteUser in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    getRemoteUser in class javax.servlet.http.HttpServletRequestWrapper
  - getUserPrincipal
```
public final Principal getUserPrincipal()
```
    Specified by:
    
    getUserPrincipal in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    getUserPrincipal in class javax.servlet.http.HttpServletRequestWrapper
  - getRequestedSessionId
```
public final String getRequestedSessionId()
```
    Specified by:
    
    getRequestedSessionId in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    getRequestedSessionId in class javax.servlet.http.HttpServletRequestWrapper
  - isRequestedSessionIdValid
```
public final boolean isRequestedSessionIdValid()
```
    Specified by:
    
    isRequestedSessionIdValid in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    isRequestedSessionIdValid in class javax.servlet.http.HttpServletRequestWrapper
  - getCookies
```
public final javax.servlet.http.Cookie[] getCookies()
```
    Specified by:
    
    getCookies in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    getCookies in class javax.servlet.http.HttpServletRequestWrapper
  - getParameter
```
public final String getParameter(String name)
```
    Specified by:
    
    getParameter in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getParameter in class javax.servlet.ServletRequestWrapper
  - getParameterNames
```
public final Enumeration getParameterNames()
```
    Specified by:
    
    getParameterNames in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getParameterNames in class javax.servlet.ServletRequestWrapper
  - getParameterValues
```
public final String[] getParameterValues(String name)
```
    Specified by:
    
    getParameterValues in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getParameterValues in class javax.servlet.ServletRequestWrapper
  - getParameterMap
```
public final Map getParameterMap()
```
    Specified by:
    
    getParameterMap in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getParameterMap in class javax.servlet.ServletRequestWrapper
  - getCharacterEncoding
```
public abstract String getCharacterEncoding()
```
    Specified by:
    
    getCharacterEncoding in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getCharacterEncoding in class javax.servlet.ServletRequestWrapper
  - setCharacterEncoding
```
public abstract void setCharacterEncoding(String s)
                                   throws UnsupportedEncodingException
```
    Specified by:
    
    setCharacterEncoding in interface javax.servlet.ServletRequest
    
    Overrides:
    
    setCharacterEncoding in class javax.servlet.ServletRequestWrapper
    
    Throws:
    
    UnsupportedEncodingException
  - getContentType
```
public abstract String getContentType()
```
    Specified by:
    
    getContentType in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getContentType in class javax.servlet.ServletRequestWrapper
  - getInputStream
```
public abstract javax.servlet.ServletInputStream getInputStream()
                                                         throws IOException
```
    Specified by:
    
    getInputStream in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getInputStream in class javax.servlet.ServletRequestWrapper
    
    Throws:
    
    IOException
  - getReader
```
public abstract BufferedReader getReader()
                                  throws IOException
```
    Specified by:
    
    getReader in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getReader in class javax.servlet.ServletRequestWrapper
    
    Throws:
    
    IOException
  - getContentLength
```
public abstract int getContentLength()
```
    Specified by:
    
    getContentLength in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getContentLength in class javax.servlet.ServletRequestWrapper
  - getMethod
```
public abstract String getMethod()
```
    Specified by:
    
    getMethod in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    getMethod in class javax.servlet.http.HttpServletRequestWrapper
  - getHeader
```
public final String getHeader(String s)
```
    Specified by:
    
    getHeader in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    getHeader in class javax.servlet.http.HttpServletRequestWrapper
  - getHeaders
```
public final Enumeration getHeaders(String s)
```
    Specified by:
    
    getHeaders in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    getHeaders in class javax.servlet.http.HttpServletRequestWrapper
  - getHeaderNames
```
public final Enumeration getHeaderNames()
```
    Specified by:
    
    getHeaderNames in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    getHeaderNames in class javax.servlet.http.HttpServletRequestWrapper
  - getDateHeader
```
public final long getDateHeader(String s)
```
    Specified by:
    
    getDateHeader in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    getDateHeader in class javax.servlet.http.HttpServletRequestWrapper
  - getIntHeader
```
public final int getIntHeader(String s)
```
    Specified by:
    
    getIntHeader in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    getIntHeader in class javax.servlet.http.HttpServletRequestWrapper
  - getRequestDispatcher
```
public final javax.servlet.RequestDispatcher getRequestDispatcher(String s)
```
    Specified by:
    
    getRequestDispatcher in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getRequestDispatcher in class javax.servlet.ServletRequestWrapper
  - isUserInRole
```
public final boolean isUserInRole(String s)
```
    Specified by:
    
    isUserInRole in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    isUserInRole in class javax.servlet.http.HttpServletRequestWrapper
  - getSession
```
public final javax.servlet.http.HttpSession getSession(boolean b)
```
    Specified by:
    
    getSession in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    getSession in class javax.servlet.http.HttpServletRequestWrapper
  - getSession
```
public final javax.servlet.http.HttpSession getSession()
```
    Specified by:
    
    getSession in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    getSession in class javax.servlet.http.HttpServletRequestWrapper
  - isRequestedSessionIdFromCookie
```
public final boolean isRequestedSessionIdFromCookie()
```
    Specified by:
    
    isRequestedSessionIdFromCookie in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    isRequestedSessionIdFromCookie in class javax.servlet.http.HttpServletRequestWrapper
  - isRequestedSessionIdFromURL
```
public final boolean isRequestedSessionIdFromURL()
```
    Specified by:
    
    isRequestedSessionIdFromURL in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    isRequestedSessionIdFromURL in class javax.servlet.http.HttpServletRequestWrapper
  - isRequestedSessionIdFromUrl
```
public final boolean isRequestedSessionIdFromUrl()
```
    Specified by:
    
    isRequestedSessionIdFromUrl in interface javax.servlet.http.HttpServletRequest
    
    Overrides:
    
    isRequestedSessionIdFromUrl in class javax.servlet.http.HttpServletRequestWrapper
  - getProtocol
```
public final String getProtocol()
```
    Specified by:
    
    getProtocol in interface javax.servlet.ServletRequest
    
    Overrides:
    
    getProtocol in class javax.servlet.ServletRequestWrapper
  - setRequest
```
public final void setRequest(javax.servlet.ServletRequest servletRequest)
```
    Overrides:
    
    setRequest in class javax.servlet.ServletRequestWrapper
  - getRequest
```
public javax.servlet.ServletRequest getRequest()
```
    Overrides:
    
    getRequest in class javax.servlet.ServletRequestWrapper

Class DispatchedHttpServletRequest

Nested Class Summary

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletRequest

Constructor Summary

Method Summary

Methods inherited from class javax.servlet.http.HttpServletRequestWrapper

Methods inherited from class javax.servlet.ServletRequestWrapper

Methods inherited from class java.lang.Object

Methods inherited from interface javax.servlet.ServletRequest

Constructor Detail

DispatchedHttpServletRequest

Method Detail

getRemoteAddr

getRemoteHost

getRealPath

getLocalAddr

getLocalName

getRequestURL

getRemotePort

getLocalPort

getPathTranslated

getPathInfo

getQueryString

getRequestURI

getServletPath

getScheme

getServerName

getServerPort

getAttribute

getAttributeNames

setAttribute

removeAttribute

getLocale

getLocales

isSecure

getAuthType

getContextPath

getRemoteUser

getUserPrincipal

getRequestedSessionId

isRequestedSessionIdValid

getCookies

getParameter

getParameterNames

getParameterValues

getParameterMap

getCharacterEncoding

setCharacterEncoding

getContentType

getInputStream

getReader

getContentLength

getMethod

getHeader

getHeaders

getHeaderNames

getDateHeader

getIntHeader

getRequestDispatcher

isUserInRole

getSession

getSession

isRequestedSessionIdFromCookie

isRequestedSessionIdFromURL

isRequestedSessionIdFromUrl

getProtocol

setRequest

getRequest