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

All Implemented Interfaces:

jakarta.servlet.http.HttpServletRequest, jakarta.servlet.ServletRequest, Holders.RequestHolder
```
public class HttpServletRequestImpl
extends Object
implements jakarta.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	Description
`protected org.glassfish.grizzly.http.server.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 jakarta.servlet.http.HttpServletRequest
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

Constructors
Modifier Constructor Description

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`authenticate(jakarta.servlet.http.HttpServletResponse hsr)`
`String`	`changeSessionId()`
`protected Object`	`clone()`	Prevent cloning the facade.
`static HttpServletRequestImpl`	`create()`
`void`	`disableAsyncSupport()`	Disables async support for this request.
`jakarta.servlet.AsyncContext`	`getAsyncContext()`
`Object`	`getAttribute(String name)`
`Enumeration<String>`	`getAttributeNames()`
`String`	`getAuthType()`
`String`	`getCharacterEncoding()`
`int`	`getContentLength()`
`long`	`getContentLengthLong()`
`String`	`getContentType()`
`protected WebappContext`	`getContextImpl()`	Return the underlying `WebappContext`
`String`	`getContextPath()`
`jakarta.servlet.http.Cookie[]`	`getCookies()`
`long`	`getDateHeader(String name)`
`jakarta.servlet.DispatcherType`	`getDispatcherType()`
`org.glassfish.grizzly.http.Cookie[]`	`getGrizzlyCookies()`
`String`	`getHeader(String name)`
`Enumeration<String>`	`getHeaderNames()`
`Enumeration<String>`	`getHeaders(String name)`
`jakarta.servlet.http.HttpServletMapping`	`getHttpServletMapping()`
`jakarta.servlet.http.HttpUpgradeHandler`	`getHttpUpgradeHandler()`
`jakarta.servlet.ServletInputStream`	`getInputStream()`
`org.glassfish.grizzly.http.server.Request`	`getInternalRequest()`	Returns internal Grizzly `Request` associated with this Holder.
`int`	`getIntHeader(String name)`
`String`	`getLocalAddr()`
`Locale`	`getLocale()`
`Enumeration<Locale>`	`getLocales()`
`String`	`getLocalName()`
`int`	`getLocalPort()`
`String`	`getMethod()`
`String`	`getParameter(String name)`
`Map<String,String[]>`	`getParameterMap()`
`Enumeration<String>`	`getParameterNames()`
`String[]`	`getParameterValues(String name)`
`jakarta.servlet.http.Part`	`getPart(String string)`
`Collection<jakarta.servlet.http.Part>`	`getParts()`
`String`	`getPathInfo()`
`String`	`getPathTranslated()`
`String`	`getProtocol()`
`String`	`getProtocolRequestId()`
`String`	`getQueryString()`
`BufferedReader`	`getReader()`
`String`	`getRemoteAddr()`
`String`	`getRemoteHost()`
`int`	`getRemotePort()`
`String`	`getRemoteUser()`
`org.glassfish.grizzly.http.server.Request`	`getRequest()`
`jakarta.servlet.RequestDispatcher`	`getRequestDispatcher(String path)`
`String`	`getRequestedSessionId()`
`String`	`getRequestId()`
`String`	`getRequestURI()`
`StringBuffer`	`getRequestURL()`
`String`	`getScheme()`
`String`	`getServerName()`
`int`	`getServerPort()`
`jakarta.servlet.ServletConnection`	`getServletConnection()`
`jakarta.servlet.ServletContext`	`getServletContext()`
`String`	`getServletPath()`
`jakarta.servlet.http.HttpSession`	`getSession()`
`jakarta.servlet.http.HttpSession`	`getSession(boolean create)`
`Map<String,String>`	`getTrailerFields()`
`Principal`	`getUserPrincipal()`
`void`	`initialize(org.glassfish.grizzly.http.server.Request request, HttpServletResponseImpl servletResponse, WebappContext context)`
`boolean`	`isAsyncStarted()`
`boolean`	`isAsyncSupported()`
`boolean`	`isRequestedSessionIdFromCookie()`
`boolean`	`isRequestedSessionIdFromURL()`
`boolean`	`isRequestedSessionIdValid()`
`boolean`	`isSecure()`
`boolean`	`isTrailerFieldsReady()`
`boolean`	`isUpgrade()`
`boolean`	`isUserInRole(String role)`
`void`	`login(String string, String string1)`
`void`	`logout()`
`jakarta.servlet.http.PushBuilder`	`newPushBuilder()`
`void`	`removeAttribute(String name)`
`void`	`setAttribute(String name, Object value)`
`void`	`setCharacterEncoding(String env)`
`protected void`	`setContextImpl(WebappContext contextImpl)`	Set the underlying `WebappContext`
`protected void`	`setContextPath(String contextPath)`
`protected void`	`setPathInfo(String pathInfo)`
`void`	`setServletPath(String servletPath)`	Programmatically set the servlet path value.
`jakarta.servlet.AsyncContext`	`startAsync()`
`jakarta.servlet.AsyncContext`	`startAsync(jakarta.servlet.ServletRequest servletRequest, jakarta.servlet.ServletResponse servletResponse)`
`<T extends jakarta.servlet.http.HttpUpgradeHandler> T`	`upgrade(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 org.glassfish.grizzly.http.server.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(org.glassfish.grizzly.http.server.Request request,
                       HttpServletResponseImpl servletResponse,
                       WebappContext context)
                throws IOException
```
    Throws:
    
    IOException
  - clone
```
protected Object clone()
                throws CloneNotSupportedException
```
    Prevent cloning the facade.
    
    Overrides:
    
    clone in class Object
    
    Throws:
    
    CloneNotSupportedException
  - getAttribute
```
public Object getAttribute(String name)
```
    Specified by:
    
    getAttribute in interface jakarta.servlet.ServletRequest
  - getAttributeNames
```
public Enumeration<String> getAttributeNames()
```
    Specified by:
    
    getAttributeNames in interface jakarta.servlet.ServletRequest
  - getCharacterEncoding
```
public String getCharacterEncoding()
```
    Specified by:
    
    getCharacterEncoding in interface jakarta.servlet.ServletRequest
  - setCharacterEncoding
```
public void setCharacterEncoding(String env)
                          throws UnsupportedEncodingException
```
    Specified by:
    
    setCharacterEncoding in interface jakarta.servlet.ServletRequest
    
    Throws:
    
    UnsupportedEncodingException
  - getContentLength
```
public int getContentLength()
```
    Specified by:
    
    getContentLength in interface jakarta.servlet.ServletRequest
  - getContentLengthLong
```
public long getContentLengthLong()
```
    Specified by:
    
    getContentLengthLong in interface jakarta.servlet.ServletRequest
  - getContentType
```
public String getContentType()
```
    Specified by:
    
    getContentType in interface jakarta.servlet.ServletRequest
  - getInputStream
```
public jakarta.servlet.ServletInputStream getInputStream()
                                                  throws IOException
```
    Specified by:
    
    getInputStream in interface jakarta.servlet.ServletRequest
    
    Throws:
    
    IOException
  - getParameter
```
public String getParameter(String name)
```
    Specified by:
    
    getParameter in interface jakarta.servlet.ServletRequest
  - getParameterNames
```
public Enumeration<String> getParameterNames()
```
    Specified by:
    
    getParameterNames in interface jakarta.servlet.ServletRequest
  - getParameterValues
```
public String[] getParameterValues(String name)
```
    Specified by:
    
    getParameterValues in interface jakarta.servlet.ServletRequest
  - getParameterMap
```
public Map<String,String[]> getParameterMap()
```
    Specified by:
    
    getParameterMap in interface jakarta.servlet.ServletRequest
  - getProtocol
```
public String getProtocol()
```
    Specified by:
    
    getProtocol in interface jakarta.servlet.ServletRequest
  - getScheme
```
public String getScheme()
```
    Specified by:
    
    getScheme in interface jakarta.servlet.ServletRequest
  - getServerName
```
public String getServerName()
```
    Specified by:
    
    getServerName in interface jakarta.servlet.ServletRequest
  - getServerPort
```
public int getServerPort()
```
    Specified by:
    
    getServerPort in interface jakarta.servlet.ServletRequest
  - getReader
```
public BufferedReader getReader()
                         throws IOException
```
    Specified by:
    
    getReader in interface jakarta.servlet.ServletRequest
    
    Throws:
    
    IOException
  - getRemoteAddr
```
public String getRemoteAddr()
```
    Specified by:
    
    getRemoteAddr in interface jakarta.servlet.ServletRequest
  - getRemoteHost
```
public String getRemoteHost()
```
    Specified by:
    
    getRemoteHost in interface jakarta.servlet.ServletRequest
  - setAttribute
```
public void setAttribute(String name,
                         Object value)
```
    Specified by:
    
    setAttribute in interface jakarta.servlet.ServletRequest
  - removeAttribute
```
public void removeAttribute(String name)
```
    Specified by:
    
    removeAttribute in interface jakarta.servlet.ServletRequest
  - getLocale
```
public Locale getLocale()
```
    Specified by:
    
    getLocale in interface jakarta.servlet.ServletRequest
  - getLocales
```
public Enumeration<Locale> getLocales()
```
    Specified by:
    
    getLocales in interface jakarta.servlet.ServletRequest
  - isSecure
```
public boolean isSecure()
```
    Specified by:
    
    isSecure in interface jakarta.servlet.ServletRequest
  - getRequestDispatcher
```
public jakarta.servlet.RequestDispatcher getRequestDispatcher(String path)
```
    Specified by:
    
    getRequestDispatcher in interface jakarta.servlet.ServletRequest
  - getAuthType
```
public String getAuthType()
```
    Specified by:
    
    getAuthType in interface jakarta.servlet.http.HttpServletRequest
  - getGrizzlyCookies
```
public org.glassfish.grizzly.http.Cookie[] getGrizzlyCookies()
```
  - getDateHeader
```
public long getDateHeader(String name)
```
    Specified by:
    
    getDateHeader in interface jakarta.servlet.http.HttpServletRequest
  - getHeader
```
public String getHeader(String name)
```
    Specified by:
    
    getHeader in interface jakarta.servlet.http.HttpServletRequest
  - getHeaders
```
public Enumeration<String> getHeaders(String name)
```
    Specified by:
    
    getHeaders in interface jakarta.servlet.http.HttpServletRequest
  - getHeaderNames
```
public Enumeration<String> getHeaderNames()
```
    Specified by:
    
    getHeaderNames in interface jakarta.servlet.http.HttpServletRequest
  - getIntHeader
```
public int getIntHeader(String name)
```
    Specified by:
    
    getIntHeader in interface jakarta.servlet.http.HttpServletRequest
  - getMethod
```
public String getMethod()
```
    Specified by:
    
    getMethod in interface jakarta.servlet.http.HttpServletRequest
  - getPathInfo
```
public String getPathInfo()
```
    Specified by:
    
    getPathInfo in interface jakarta.servlet.http.HttpServletRequest
  - getPathTranslated
```
public String getPathTranslated()
```
    Specified by:
    
    getPathTranslated in interface jakarta.servlet.http.HttpServletRequest
  - getContextPath
```
public String getContextPath()
```
    Specified by:
    
    getContextPath in interface jakarta.servlet.http.HttpServletRequest
  - setContextPath
```
protected void setContextPath(String contextPath)
```
  - getQueryString
```
public String getQueryString()
```
    Specified by:
    
    getQueryString in interface jakarta.servlet.http.HttpServletRequest
  - getRemoteUser
```
public String getRemoteUser()
```
    Specified by:
    
    getRemoteUser in interface jakarta.servlet.http.HttpServletRequest
  - isUserInRole
```
public boolean isUserInRole(String role)
```
    Specified by:
    
    isUserInRole in interface jakarta.servlet.http.HttpServletRequest
  - getUserPrincipal
```
public Principal getUserPrincipal()
```
    Specified by:
    
    getUserPrincipal in interface jakarta.servlet.http.HttpServletRequest
  - getRequestedSessionId
```
public String getRequestedSessionId()
```
    Specified by:
    
    getRequestedSessionId in interface jakarta.servlet.http.HttpServletRequest
  - getRequestURI
```
public String getRequestURI()
```
    Specified by:
    
    getRequestURI in interface jakarta.servlet.http.HttpServletRequest
  - getRequestURL
```
public StringBuffer getRequestURL()
```
    Specified by:
    
    getRequestURL in interface jakarta.servlet.http.HttpServletRequest
  - getServletPath
```
public String getServletPath()
```
    Specified by:
    
    getServletPath in interface jakarta.servlet.http.HttpServletRequest
  - getSession
```
public jakarta.servlet.http.HttpSession getSession(boolean create)
```
    Specified by:
    
    getSession in interface jakarta.servlet.http.HttpServletRequest
  - getSession
```
public jakarta.servlet.http.HttpSession getSession()
```
    Specified by:
    
    getSession in interface jakarta.servlet.http.HttpServletRequest
  - changeSessionId
```
public String changeSessionId()
```
    Specified by:
    
    changeSessionId in interface jakarta.servlet.http.HttpServletRequest
  - isRequestedSessionIdValid
```
public boolean isRequestedSessionIdValid()
```
    Specified by:
    
    isRequestedSessionIdValid in interface jakarta.servlet.http.HttpServletRequest
  - isRequestedSessionIdFromCookie
```
public boolean isRequestedSessionIdFromCookie()
```
    Specified by:
    
    isRequestedSessionIdFromCookie in interface jakarta.servlet.http.HttpServletRequest
  - isRequestedSessionIdFromURL
```
public boolean isRequestedSessionIdFromURL()
```
    Specified by:
    
    isRequestedSessionIdFromURL in interface jakarta.servlet.http.HttpServletRequest
  - getCookies
```
public jakarta.servlet.http.Cookie[] getCookies()
```
    Specified by:
    
    getCookies in interface jakarta.servlet.http.HttpServletRequest
  - getRemotePort
```
public int getRemotePort()
```
    Specified by:
    
    getRemotePort in interface jakarta.servlet.ServletRequest
  - getLocalName
```
public String getLocalName()
```
    Specified by:
    
    getLocalName in interface jakarta.servlet.ServletRequest
  - getLocalAddr
```
public String getLocalAddr()
```
    Specified by:
    
    getLocalAddr in interface jakarta.servlet.ServletRequest
  - getLocalPort
```
public int getLocalPort()
```
    Specified by:
    
    getLocalPort in interface jakarta.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(String servletPath)
```
    Programmatically set the servlet path value. Default is an empty String.
    
    Parameters:
    
    servletPath - Servlet path to set.
  - setPathInfo
```
protected void setPathInfo(String pathInfo)
```
  - getRequest
```
public org.glassfish.grizzly.http.server.Request getRequest()
```
  - getServletContext
```
public jakarta.servlet.ServletContext getServletContext()
```
    Specified by:
    
    getServletContext in interface jakarta.servlet.ServletRequest
  - getInternalRequest
```
public org.glassfish.grizzly.http.server.Request getInternalRequest()
```
    Returns internal Grizzly Request associated with this Holder.
    
    Specified by:
    
    getInternalRequest in interface Holders.RequestHolder
  - getDispatcherType
```
public jakarta.servlet.DispatcherType getDispatcherType()
```
    Specified by:
    
    getDispatcherType in interface jakarta.servlet.ServletRequest
  - startAsync
```
public jakarta.servlet.AsyncContext startAsync()
                                        throws IllegalStateException
```
    Specified by:
    
    startAsync in interface jakarta.servlet.ServletRequest
    
    Throws:
    
    IllegalStateException
  - startAsync
```
public jakarta.servlet.AsyncContext startAsync(jakarta.servlet.ServletRequest servletRequest,
                                               jakarta.servlet.ServletResponse servletResponse)
                                        throws IllegalStateException
```
    Specified by:
    
    startAsync in interface jakarta.servlet.ServletRequest
    
    Throws:
    
    IllegalStateException
  - isAsyncStarted
```
public boolean isAsyncStarted()
```
    Specified by:
    
    isAsyncStarted in interface jakarta.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 jakarta.servlet.ServletRequest
  - getAsyncContext
```
public jakarta.servlet.AsyncContext getAsyncContext()
```
    Specified by:
    
    getAsyncContext in interface jakarta.servlet.ServletRequest
  - upgrade
```
public <T extends jakarta.servlet.http.HttpUpgradeHandler> T upgrade(Class<T> handlerClass)
                                                              throws IOException
```
    Create an instance of HttpUpgradeHandler for an given class and uses it for the http protocol upgrade processing.
    
    Specified by:
    
    upgrade in interface jakarta.servlet.http.HttpServletRequest
    
    Parameters:
    
    handlerClass - The ProtocolHandler class used for the upgrade.
    
    Returns:
    
    an instance of the HttpUpgradeHandler
    
    Throws:
    
    IOException - if an I/O error occurred during the upgrade
    
    Since:
    
    Servlet 3.1
    
    See Also:
    
    HttpUpgradeHandler, WebConnection
  - isUpgrade
```
public boolean isUpgrade()
```
  - getHttpUpgradeHandler
```
public jakarta.servlet.http.HttpUpgradeHandler getHttpUpgradeHandler()
```
  - authenticate
```
public boolean authenticate(jakarta.servlet.http.HttpServletResponse hsr)
                     throws IOException,
                            jakarta.servlet.ServletException
```
    Specified by:
    
    authenticate in interface jakarta.servlet.http.HttpServletRequest
    
    Throws:
    
    IOException
    
    jakarta.servlet.ServletException
  - login
```
public void login(String string,
                  String string1)
           throws jakarta.servlet.ServletException
```
    Specified by:
    
    login in interface jakarta.servlet.http.HttpServletRequest
    
    Throws:
    
    jakarta.servlet.ServletException
  - logout
```
public void logout()
            throws jakarta.servlet.ServletException
```
    Specified by:
    
    logout in interface jakarta.servlet.http.HttpServletRequest
    
    Throws:
    
    jakarta.servlet.ServletException
  - getParts
```
public Collection<jakarta.servlet.http.Part> getParts()
                                               throws IOException,
                                                      jakarta.servlet.ServletException
```
    Specified by:
    
    getParts in interface jakarta.servlet.http.HttpServletRequest
    
    Throws:
    
    IOException
    
    jakarta.servlet.ServletException
  - getPart
```
public jakarta.servlet.http.Part getPart(String string)
                                  throws IOException,
                                         jakarta.servlet.ServletException
```
    Specified by:
    
    getPart in interface jakarta.servlet.http.HttpServletRequest
    
    Throws:
    
    IOException
    
    jakarta.servlet.ServletException
  - getHttpServletMapping
```
public jakarta.servlet.http.HttpServletMapping getHttpServletMapping()
```
    Specified by:
    
    getHttpServletMapping in interface jakarta.servlet.http.HttpServletRequest
  - newPushBuilder
```
public jakarta.servlet.http.PushBuilder newPushBuilder()
```
    Specified by:
    
    newPushBuilder in interface jakarta.servlet.http.HttpServletRequest
  - getTrailerFields
```
public Map<String,String> getTrailerFields()
```
    Specified by:
    
    getTrailerFields in interface jakarta.servlet.http.HttpServletRequest
  - isTrailerFieldsReady
```
public boolean isTrailerFieldsReady()
```
    Specified by:
    
    isTrailerFieldsReady in interface jakarta.servlet.http.HttpServletRequest
  - getRequestId
```
public String getRequestId()
```
    Specified by:
    
    getRequestId in interface jakarta.servlet.ServletRequest
  - getProtocolRequestId
```
public String getProtocolRequestId()
```
    Specified by:
    
    getProtocolRequestId in interface jakarta.servlet.ServletRequest
  - getServletConnection
```
public jakarta.servlet.ServletConnection getServletConnection()
```
    Specified by:
    
    getServletConnection in interface jakarta.servlet.ServletRequest

Class HttpServletRequestImpl

Field Summary

Fields inherited from interface jakarta.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

getAuthType

getGrizzlyCookies

getDateHeader

getHeader

getHeaders

getHeaderNames

getIntHeader

getMethod

getPathInfo

getPathTranslated

getContextPath

setContextPath

getQueryString

getRemoteUser

isUserInRole

getUserPrincipal

getRequestedSessionId

getRequestURI

getRequestURL

getServletPath

getSession

getSession

changeSessionId

isRequestedSessionIdValid

isRequestedSessionIdFromCookie

isRequestedSessionIdFromURL

getCookies

getRemotePort

getLocalName

getLocalAddr

getLocalPort

getContextImpl

setContextImpl

setServletPath

setPathInfo

getRequest

getServletContext

getInternalRequest