HttpServletRequestImpl (grizzly-http-servlet 2.3.16 API)

java.lang.Object
- org.glassfish.grizzly.servlet.HttpServletRequestImpl

All Implemented Interfaces:

javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest, Holders.RequestHolder
```
public class HttpServletRequestImpl
extends java.lang.Object
implements javax.servlet.http.HttpServletRequest, Holders.RequestHolder
```
Facade class that wraps a Request request object. All methods are delegated to the wrapped request.

Version:

$Revision: 1.7 $ $Date: 2007/08/01 19:04:28 $

Author:

Craig R. McClanahan, Remy Maucherat, Jean-Francois Arcand

Field Summary

Fields
Modifier and Type	Field and Description
`protected Request`	`request` The wrapped request.
`protected HttpServletResponseImpl`	`servletResponse` The corresponding servlet response
`protected boolean`	`usingInputStream` Using stream flag.
`protected boolean`	`usingReader` Using writer flag.

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

Constructor Summary

Constructors
Modifier Constructor and Description

protected HttpServletRequestImpl()
Construct a wrapper for the specified request.

Constructors
Modifier	Constructor and Description
`protected`	`HttpServletRequestImpl()` Construct a wrapper for the specified request.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`authenticate(javax.servlet.http.HttpServletResponse hsr)`
`java.lang.String`	`changeSessionId()`
`protected java.lang.Object`	`clone()` Prevent cloning the facade.
`static HttpServletRequestImpl`	`create()`
`void`	`disableAsyncSupport()` Disables async support for this request.
`javax.servlet.AsyncContext`	`getAsyncContext()`
`java.lang.Object`	`getAttribute(java.lang.String name)`
`java.util.Enumeration<java.lang.String>`	`getAttributeNames()`
`java.lang.String`	`getAuthType()`
`java.lang.String`	`getCharacterEncoding()`
`int`	`getContentLength()`
`long`	`getContentLengthLong()`
`java.lang.String`	`getContentType()`
`protected WebappContext`	`getContextImpl()` Return the underlying `WebappContext`
`java.lang.String`	`getContextPath()`
`javax.servlet.http.Cookie[]`	`getCookies()`
`long`	`getDateHeader(java.lang.String name)`
`javax.servlet.DispatcherType`	`getDispatcherType()`
`Cookie[]`	`getGrizzlyCookies()`
`java.lang.String`	`getHeader(java.lang.String name)`
`java.util.Enumeration<java.lang.String>`	`getHeaderNames()`
`java.util.Enumeration<java.lang.String>`	`getHeaders(java.lang.String name)`
`javax.servlet.http.HttpUpgradeHandler`	`getHttpUpgradeHandler()`
`javax.servlet.ServletInputStream`	`getInputStream()`
`Request`	`getInternalRequest()` Returns internal Grizzly `Request` associated with this Holder.
`int`	`getIntHeader(java.lang.String name)`
`java.lang.String`	`getLocalAddr()`
`java.util.Locale`	`getLocale()`
`java.util.Enumeration<java.util.Locale>`	`getLocales()`
`java.lang.String`	`getLocalName()`
`int`	`getLocalPort()`
`java.lang.String`	`getMethod()`
`java.lang.String`	`getParameter(java.lang.String name)`
`java.util.Map<java.lang.String,java.lang.String[]>`	`getParameterMap()`
`java.util.Enumeration<java.lang.String>`	`getParameterNames()`
`java.lang.String[]`	`getParameterValues(java.lang.String name)`
`javax.servlet.http.Part`	`getPart(java.lang.String string)`
`java.util.Collection<javax.servlet.http.Part>`	`getParts()`
`java.lang.String`	`getPathInfo()`
`java.lang.String`	`getPathTranslated()`
`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()`
`int`	`getRemotePort()`
`java.lang.String`	`getRemoteUser()`
`Request`	`getRequest()`
`javax.servlet.RequestDispatcher`	`getRequestDispatcher(java.lang.String path)`
`java.lang.String`	`getRequestedSessionId()`
`java.lang.String`	`getRequestURI()`
`java.lang.StringBuffer`	`getRequestURL()`
`java.lang.String`	`getScheme()`
`java.lang.String`	`getServerName()`
`int`	`getServerPort()`
`javax.servlet.ServletContext`	`getServletContext()`
`java.lang.String`	`getServletPath()`
`javax.servlet.http.HttpSession`	`getSession()`
`javax.servlet.http.HttpSession`	`getSession(boolean create)`
`java.security.Principal`	`getUserPrincipal()`
`void`	`initialize(Request request, HttpServletResponseImpl servletResponse, WebappContext context)`
`protected void`	`initSession()` Initialize the session object if there is a valid session request
`boolean`	`isAsyncStarted()`
`boolean`	`isAsyncSupported()`
`boolean`	`isRequestedSessionIdFromCookie()`
`boolean`	`isRequestedSessionIdFromUrl()`
`boolean`	`isRequestedSessionIdFromURL()`
`boolean`	`isRequestedSessionIdValid()`
`boolean`	`isSecure()`
`boolean`	`isUpgrade()`
`boolean`	`isUserInRole(java.lang.String role)`
`void`	`login(java.lang.String string, java.lang.String string1)`
`void`	`logout()`
`void`	`removeAttribute(java.lang.String name)`
`void`	`setAttribute(java.lang.String name, java.lang.Object value)`
`void`	`setCharacterEncoding(java.lang.String env)`
`protected void`	`setContextImpl(WebappContext contextImpl)` Set the underlying `WebappContext`
`protected void`	`setContextPath(java.lang.String contextPath)`
`protected void`	`setPathInfo(java.lang.String pathInfo)`
`void`	`setServletPath(java.lang.String servletPath)` Programmatically set the servlet path value.
`javax.servlet.AsyncContext`	`startAsync()`
`javax.servlet.AsyncContext`	`startAsync(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse)`
`<T extends javax.servlet.http.HttpUpgradeHandler> T`	`upgrade(java.lang.Class<T> handlerClass)` Create an instance of `HttpUpgradeHandler` for an given class and uses it for the http protocol upgrade processing.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - request
```
protected Request request
```
    The wrapped request.
  - servletResponse
```
protected HttpServletResponseImpl servletResponse
```
    The corresponding servlet response
  - usingInputStream
```
protected boolean usingInputStream
```
    Using stream flag.
  - usingReader
```
protected boolean usingReader
```
    Using writer flag.
- Constructor Detail
  - HttpServletRequestImpl
```
protected HttpServletRequestImpl()
```
    Construct a wrapper for the specified request.
- Method Detail
  - create
```
public static HttpServletRequestImpl create()
```
  - initialize
```
public void initialize(Request request,
              HttpServletResponseImpl servletResponse,
              WebappContext context)
                throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - clone
```
protected java.lang.Object clone()
                          throws java.lang.CloneNotSupportedException
```
    Prevent cloning the facade.
    
    Overrides:
    
    clone in class java.lang.Object
    
    Throws:
    
    java.lang.CloneNotSupportedException
  - getAttribute
```
public java.lang.Object getAttribute(java.lang.String name)
```
    Specified by:
    
    getAttribute in interface javax.servlet.ServletRequest
  - getAttributeNames
```
public java.util.Enumeration<java.lang.String> getAttributeNames()
```
    Specified by:
    
    getAttributeNames in interface javax.servlet.ServletRequest
  - getCharacterEncoding
```
public java.lang.String getCharacterEncoding()
```
    Specified by:
    
    getCharacterEncoding in interface javax.servlet.ServletRequest
  - setCharacterEncoding
```
public void setCharacterEncoding(java.lang.String env)
                          throws java.io.UnsupportedEncodingException
```
    Specified by:
    
    setCharacterEncoding in interface javax.servlet.ServletRequest
    
    Throws:
    
    java.io.UnsupportedEncodingException
  - getContentLength
```
public int getContentLength()
```
    Specified by:
    
    getContentLength in interface javax.servlet.ServletRequest
  - getContentLengthLong
```
public long getContentLengthLong()
```
    Specified by:
    
    getContentLengthLong in interface javax.servlet.ServletRequest
  - getContentType
```
public java.lang.String getContentType()
```
    Specified by:
    
    getContentType in interface javax.servlet.ServletRequest
  - getInputStream
```
public javax.servlet.ServletInputStream getInputStream()
                                                throws java.io.IOException
```
    Specified by:
    
    getInputStream in interface javax.servlet.ServletRequest
    
    Throws:
    
    java.io.IOException
  - getParameter
```
public java.lang.String getParameter(java.lang.String name)
```
    Specified by:
    
    getParameter in interface javax.servlet.ServletRequest
  - getParameterNames
```
public java.util.Enumeration<java.lang.String> getParameterNames()
```
    Specified by:
    
    getParameterNames in interface javax.servlet.ServletRequest
  - getParameterValues
```
public java.lang.String[] getParameterValues(java.lang.String name)
```
    Specified by:
    
    getParameterValues in interface javax.servlet.ServletRequest
  - getParameterMap
```
public java.util.Map<java.lang.String,java.lang.String[]> getParameterMap()
```
    Specified by:
    
    getParameterMap in interface javax.servlet.ServletRequest
  - getProtocol
```
public java.lang.String getProtocol()
```
    Specified by:
    
    getProtocol in interface javax.servlet.ServletRequest
  - getScheme
```
public java.lang.String getScheme()
```
    Specified by:
    
    getScheme in interface javax.servlet.ServletRequest
  - getServerName
```
public java.lang.String getServerName()
```
    Specified by:
    
    getServerName in interface javax.servlet.ServletRequest
  - getServerPort
```
public int getServerPort()
```
    Specified by:
    
    getServerPort in interface javax.servlet.ServletRequest
  - getReader
```
public java.io.BufferedReader getReader()
                                 throws java.io.IOException
```
    Specified by:
    
    getReader in interface javax.servlet.ServletRequest
    
    Throws:
    
    java.io.IOException
  - getRemoteAddr
```
public java.lang.String getRemoteAddr()
```
    Specified by:
    
    getRemoteAddr in interface javax.servlet.ServletRequest
  - getRemoteHost
```
public java.lang.String getRemoteHost()
```
    Specified by:
    
    getRemoteHost in interface javax.servlet.ServletRequest
  - setAttribute
```
public void setAttribute(java.lang.String name,
                java.lang.Object value)
```
    Specified by:
    
    setAttribute in interface javax.servlet.ServletRequest
  - removeAttribute
```
public void removeAttribute(java.lang.String name)
```
    Specified by:
    
    removeAttribute in interface javax.servlet.ServletRequest
  - getLocale
```
public java.util.Locale getLocale()
```
    Specified by:
    
    getLocale in interface javax.servlet.ServletRequest
  - getLocales
```
public java.util.Enumeration<java.util.Locale> getLocales()
```
    Specified by:
    
    getLocales in interface javax.servlet.ServletRequest
  - isSecure
```
public boolean isSecure()
```
    Specified by:
    
    isSecure in interface javax.servlet.ServletRequest
  - getRequestDispatcher
```
public javax.servlet.RequestDispatcher getRequestDispatcher(java.lang.String path)
```
    Specified by:
    
    getRequestDispatcher in interface javax.servlet.ServletRequest
  - getRealPath
```
public java.lang.String getRealPath(java.lang.String path)
```
    Specified by:
    
    getRealPath in interface javax.servlet.ServletRequest
  - getAuthType
```
public java.lang.String getAuthType()
```
    Specified by:
    
    getAuthType in interface javax.servlet.http.HttpServletRequest
  - getGrizzlyCookies
```
public Cookie[] getGrizzlyCookies()
```
  - getDateHeader
```
public long getDateHeader(java.lang.String name)
```
    Specified by:
    
    getDateHeader in interface javax.servlet.http.HttpServletRequest
  - getHeader
```
public java.lang.String getHeader(java.lang.String name)
```
    Specified by:
    
    getHeader in interface javax.servlet.http.HttpServletRequest
  - getHeaders
```
public java.util.Enumeration<java.lang.String> getHeaders(java.lang.String name)
```
    Specified by:
    
    getHeaders in interface javax.servlet.http.HttpServletRequest
  - getHeaderNames
```
public java.util.Enumeration<java.lang.String> getHeaderNames()
```
    Specified by:
    
    getHeaderNames in interface javax.servlet.http.HttpServletRequest
  - getIntHeader
```
public int getIntHeader(java.lang.String name)
```
    Specified by:
    
    getIntHeader in interface javax.servlet.http.HttpServletRequest
  - getMethod
```
public java.lang.String getMethod()
```
    Specified by:
    
    getMethod in interface javax.servlet.http.HttpServletRequest
  - getPathInfo
```
public java.lang.String getPathInfo()
```
    Specified by:
    
    getPathInfo in interface javax.servlet.http.HttpServletRequest
  - getPathTranslated
```
public java.lang.String getPathTranslated()
```
    Specified by:
    
    getPathTranslated in interface javax.servlet.http.HttpServletRequest
  - getContextPath
```
public java.lang.String getContextPath()
```
    Specified by:
    
    getContextPath in interface javax.servlet.http.HttpServletRequest
  - setContextPath
```
protected void setContextPath(java.lang.String contextPath)
```
  - getQueryString
```
public java.lang.String getQueryString()
```
    Specified by:
    
    getQueryString in interface javax.servlet.http.HttpServletRequest
  - getRemoteUser
```
public java.lang.String getRemoteUser()
```
    Specified by:
    
    getRemoteUser in interface javax.servlet.http.HttpServletRequest
  - isUserInRole
```
public boolean isUserInRole(java.lang.String role)
```
    Specified by:
    
    isUserInRole in interface javax.servlet.http.HttpServletRequest
  - getUserPrincipal
```
public java.security.Principal getUserPrincipal()
```
    Specified by:
    
    getUserPrincipal in interface javax.servlet.http.HttpServletRequest
  - getRequestedSessionId
```
public java.lang.String getRequestedSessionId()
```
    Specified by:
    
    getRequestedSessionId in interface javax.servlet.http.HttpServletRequest
  - getRequestURI
```
public java.lang.String getRequestURI()
```
    Specified by:
    
    getRequestURI in interface javax.servlet.http.HttpServletRequest
  - getRequestURL
```
public java.lang.StringBuffer getRequestURL()
```
    Specified by:
    
    getRequestURL in interface javax.servlet.http.HttpServletRequest
  - getServletPath
```
public java.lang.String getServletPath()
```
    Specified by:
    
    getServletPath in interface javax.servlet.http.HttpServletRequest
  - initSession
```
protected void initSession()
```
    Initialize the session object if there is a valid session request
  - getSession
```
public javax.servlet.http.HttpSession getSession(boolean create)
```
    Specified by:
    
    getSession in interface javax.servlet.http.HttpServletRequest
  - getSession
```
public javax.servlet.http.HttpSession getSession()
```
    Specified by:
    
    getSession in interface javax.servlet.http.HttpServletRequest
  - changeSessionId
```
public java.lang.String changeSessionId()
```
    Specified by:
    
    changeSessionId in interface javax.servlet.http.HttpServletRequest
  - isRequestedSessionIdValid
```
public boolean isRequestedSessionIdValid()
```
    Specified by:
    
    isRequestedSessionIdValid in interface javax.servlet.http.HttpServletRequest
  - isRequestedSessionIdFromCookie
```
public boolean isRequestedSessionIdFromCookie()
```
    Specified by:
    
    isRequestedSessionIdFromCookie in interface javax.servlet.http.HttpServletRequest
  - isRequestedSessionIdFromURL
```
public boolean isRequestedSessionIdFromURL()
```
    Specified by:
    
    isRequestedSessionIdFromURL in interface javax.servlet.http.HttpServletRequest
  - isRequestedSessionIdFromUrl
```
public boolean isRequestedSessionIdFromUrl()
```
    Specified by:
    
    isRequestedSessionIdFromUrl in interface javax.servlet.http.HttpServletRequest
  - getCookies
```
public javax.servlet.http.Cookie[] getCookies()
```
    Specified by:
    
    getCookies in interface javax.servlet.http.HttpServletRequest
  - getRemotePort
```
public int getRemotePort()
```
    Specified by:
    
    getRemotePort in interface javax.servlet.ServletRequest
  - getLocalName
```
public java.lang.String getLocalName()
```
    Specified by:
    
    getLocalName in interface javax.servlet.ServletRequest
  - getLocalAddr
```
public java.lang.String getLocalAddr()
```
    Specified by:
    
    getLocalAddr in interface javax.servlet.ServletRequest
  - getLocalPort
```
public int getLocalPort()
```
    Specified by:
    
    getLocalPort in interface javax.servlet.ServletRequest
  - getContextImpl
```
protected WebappContext getContextImpl()
```
    Return the underlying WebappContext
    
    Returns:
    Return the underlying WebappContext
  - setContextImpl
```
protected void setContextImpl(WebappContext contextImpl)
```
    Set the underlying WebappContext
    
    Parameters:
    contextImpl - the underlying WebappContext
  - setServletPath
```
public void setServletPath(java.lang.String servletPath)
```
    Programmatically set the servlet path value. Default is an empty String.
    
    Parameters:
    servletPath - Servlet path to set.
  - setPathInfo
```
protected void setPathInfo(java.lang.String pathInfo)
```
  - getRequest
```
public Request getRequest()
```
  - getServletContext
```
public javax.servlet.ServletContext getServletContext()
```
    Specified by:
    
    getServletContext in interface javax.servlet.ServletRequest
  - getInternalRequest
```
public Request getInternalRequest()
```
    Returns internal Grizzly Request associated with this Holder.
    
    Specified by:
    
    getInternalRequest in interface Holders.RequestHolder
  - getDispatcherType
```
public javax.servlet.DispatcherType getDispatcherType()
```
    Specified by:
    
    getDispatcherType in interface javax.servlet.ServletRequest
  - startAsync
```
public javax.servlet.AsyncContext startAsync()
                                      throws java.lang.IllegalStateException
```
    Specified by:
    
    startAsync in interface javax.servlet.ServletRequest
    
    Throws:
    
    java.lang.IllegalStateException
  - startAsync
```
public javax.servlet.AsyncContext startAsync(javax.servlet.ServletRequest servletRequest,
                                    javax.servlet.ServletResponse servletResponse)
                                      throws java.lang.IllegalStateException
```
    Specified by:
    
    startAsync in interface javax.servlet.ServletRequest
    
    Throws:
    
    java.lang.IllegalStateException
  - isAsyncStarted
```
public boolean isAsyncStarted()
```
    Specified by:
    
    isAsyncStarted in interface javax.servlet.ServletRequest
  - disableAsyncSupport
```
public void disableAsyncSupport()
```
    Disables async support for this request. Async support is disabled as soon as this request has passed a filter or servlet that does not support async (either via the designated annotation or declaratively).
  - isAsyncSupported
```
public boolean isAsyncSupported()
```
    Specified by:
    
    isAsyncSupported in interface javax.servlet.ServletRequest
  - getAsyncContext
```
public javax.servlet.AsyncContext getAsyncContext()
```
    Specified by:
    
    getAsyncContext in interface javax.servlet.ServletRequest
  - upgrade
```
public <T extends javax.servlet.http.HttpUpgradeHandler> T upgrade(java.lang.Class<T> handlerClass)
                                                        throws java.io.IOException
```
    Create an instance of HttpUpgradeHandler for an given class and uses it for the http protocol upgrade processing.
    
    Specified by:
    
    upgrade in interface javax.servlet.http.HttpServletRequest
    
    Parameters:
    handlerClass - The ProtocolHandler class used for the upgrade.
    
    Returns:
    an instance of the HttpUpgradeHandler
    
    Throws:
    
    java.io.IOException - if an I/O error occurred during the upgrade
    Since:
    
    Servlet 3.1
    
    See Also:
    HttpUpgradeHandler, WebConnection
  - isUpgrade
```
public boolean isUpgrade()
```
  - getHttpUpgradeHandler
```
public javax.servlet.http.HttpUpgradeHandler getHttpUpgradeHandler()
```
  - authenticate
```
public boolean authenticate(javax.servlet.http.HttpServletResponse hsr)
                     throws java.io.IOException,
                            javax.servlet.ServletException
```
    Specified by:
    
    authenticate in interface javax.servlet.http.HttpServletRequest
    
    Throws:
    
    java.io.IOException
    
    javax.servlet.ServletException
  - login
```
public void login(java.lang.String string,
         java.lang.String string1)
           throws javax.servlet.ServletException
```
    Specified by:
    
    login in interface javax.servlet.http.HttpServletRequest
    
    Throws:
    
    javax.servlet.ServletException
  - logout
```
public void logout()
            throws javax.servlet.ServletException
```
    Specified by:
    
    logout in interface javax.servlet.http.HttpServletRequest
    
    Throws:
    
    javax.servlet.ServletException
  - getParts
```
public java.util.Collection<javax.servlet.http.Part> getParts()
                                                       throws java.io.IOException,
                                                              javax.servlet.ServletException
```
    Specified by:
    
    getParts in interface javax.servlet.http.HttpServletRequest
    
    Throws:
    
    java.io.IOException
    
    javax.servlet.ServletException
  - getPart
```
public javax.servlet.http.Part getPart(java.lang.String string)
                                throws java.io.IOException,
                                       javax.servlet.ServletException
```
    Specified by:
    
    getPart in interface javax.servlet.http.HttpServletRequest
    
    Throws:
    
    java.io.IOException
    
    javax.servlet.ServletException

Class HttpServletRequestImpl

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

request

servletResponse

usingInputStream

usingReader

Constructor Detail

HttpServletRequestImpl

Method Detail

create

initialize

clone

getAttribute

getAttributeNames

getCharacterEncoding

setCharacterEncoding

getContentLength

getContentLengthLong

getContentType

getInputStream

getParameter

getParameterNames

getParameterValues

getParameterMap

getProtocol

getScheme

getServerName

getServerPort

getReader

getRemoteAddr

getRemoteHost

setAttribute

removeAttribute

getLocale

getLocales

isSecure

getRequestDispatcher

getRealPath

getAuthType

getGrizzlyCookies

getDateHeader

getHeader

getHeaders

getHeaderNames

getIntHeader

getMethod

getPathInfo

getPathTranslated

getContextPath

setContextPath

getQueryString

getRemoteUser

isUserInRole

getUserPrincipal

getRequestedSessionId

getRequestURI

getRequestURL

getServletPath

initSession

getSession

getSession

changeSessionId

isRequestedSessionIdValid

isRequestedSessionIdFromCookie

isRequestedSessionIdFromURL

isRequestedSessionIdFromUrl

getCookies

getRemotePort

getLocalName

getLocalAddr

getLocalPort

getContextImpl

setContextImpl

setServletPath

setPathInfo