java.lang.Object
- io.undertow.servlet.spec.HttpServletRequestImpl

All Implemented Interfaces:

jakarta.servlet.http.HttpServletRequest, jakarta.servlet.ServletRequest
```
public final class HttpServletRequestImpl
extends Object
implements jakarta.servlet.http.HttpServletRequest
```
The http servlet request implementation. This class is not thread safe

Author:

Stuart Douglas, Richard Opalka

Field Summary

Fields
Modifier and Type Field Description

static AttachmentKey<Boolean> SECURE_REQUEST
Deprecated.
- Fields inherited from interface jakarta.servlet.http.HttpServletRequest
  BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

Constructors
Constructor Description

HttpServletRequestImpl(HttpServerExchange exchange, ServletContextImpl servletContext)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`authenticate(jakarta.servlet.http.HttpServletResponse response)`
`String`	`changeSessionId()`
`void`	`clearAttributes()`
`void`	`closeAndDrainRequest()`
`void`	`freeResources()`	Frees any resources (namely buffers) that may be associated with this request.
`AsyncContextImpl`	`getAsyncContext()`
`AsyncContextImpl`	`getAsyncContextInternal()`
`Object`	`getAttribute(String name)`
`Enumeration<String>`	`getAttributeNames()`
`String`	`getAuthType()`
`String`	`getCharacterEncoding()`
`int`	`getContentLength()`
`long`	`getContentLengthLong()`
`String`	`getContentType()`
`String`	`getContextPath()`
`jakarta.servlet.http.Cookie[]`	`getCookies()`
`long`	`getDateHeader(String name)`
`jakarta.servlet.DispatcherType`	`getDispatcherType()`
`HttpServerExchange`	`getExchange()`
`String`	`getHeader(HttpString name)`
`String`	`getHeader(String name)`
`Enumeration<String>`	`getHeaderNames()`
`Enumeration<String>`	`getHeaders(String name)`
`jakarta.servlet.http.HttpServletMapping`	`getHttpServletMapping()`
`jakarta.servlet.ServletInputStream`	`getInputStream()`
`int`	`getIntHeader(String name)`
`String`	`getLocalAddr()`
`Locale`	`getLocale()`
`Enumeration<Locale>`	`getLocales()`
`String`	`getLocalName()`	String java.net.InetAddress.getHostName() Gets the host name for this IP address.
`int`	`getLocalPort()`
`String`	`getMethod()`
`String`	`getOriginalContextPath()`
`String`	`getOriginalPathInfo()`
`String`	`getOriginalQueryString()`
`String`	`getOriginalRequestURI()`
`String`	`getOriginalServletPath()`
`String`	`getParameter(String name)`
`Map<String,String[]>`	`getParameterMap()`
`Enumeration<String>`	`getParameterNames()`
`String[]`	`getParameterValues(String name)`
`jakarta.servlet.http.Part`	`getPart(String name)`
`Collection<jakarta.servlet.http.Part>`	`getParts()`
`String`	`getPathInfo()`
`String`	`getPathTranslated()`
`String`	`getProtocol()`
`String`	`getProtocolRequestId()`
`Map<String,Deque<String>>`	`getQueryParameters()`
`String`	`getQueryString()`
`BufferedReader`	`getReader()`
`String`	`getRemoteAddr()`
`String`	`getRemoteHost()`
`int`	`getRemotePort()`
`String`	`getRemoteUser()`
`jakarta.servlet.RequestDispatcher`	`getRequestDispatcher(String path)`
`String`	`getRequestedSessionId()`
`String`	`getRequestId()`
`String`	`getRequestURI()`
`StringBuffer`	`getRequestURL()`
`String`	`getScheme()`
`String`	`getServerName()`
`int`	`getServerPort()`
`jakarta.servlet.ServletConnection`	`getServletConnection()`
`ServletContextImpl`	`getServletContext()`
`String`	`getServletPath()`
`jakarta.servlet.http.HttpSession`	`getSession()`
`jakarta.servlet.http.HttpSession`	`getSession(boolean create)`
`Map<String,String>`	`getTrailerFields()`
`Principal`	`getUserPrincipal()`
`boolean`	`isAsyncStarted()`
`boolean`	`isAsyncSupported()`
`boolean`	`isRequestedSessionIdFromCookie()`
`boolean`	`isRequestedSessionIdFromURL()`
`boolean`	`isRequestedSessionIdValid()`
`boolean`	`isSecure()`
`boolean`	`isTrailerFieldsReady()`
`boolean`	`isUserInRole(String role)`
`void`	`login(String username, String password)`
`void`	`logout()`
`jakarta.servlet.http.PushBuilder`	`newPushBuilder()`
`void`	`removeAttribute(String name)`
`void`	`setAttribute(String name, Object object)`
`void`	`setCharacterEncoding(String env)`
`void`	`setQueryParameters(Map<String,Deque<String>> queryParameters)`
`void`	`setServletContext(ServletContextImpl servletContext)`
`jakarta.servlet.AsyncContext`	`startAsync()`
`jakarta.servlet.AsyncContext`	`startAsync(jakarta.servlet.ServletRequest servletRequest, jakarta.servlet.ServletResponse servletResponse)`
`String`	`toString()`
`<T extends jakarta.servlet.http.HttpUpgradeHandler> T`	`upgrade(Class<T> handlerClass)`

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

- Field Detail
  - SECURE_REQUEST
```
@Deprecated
public static final AttachmentKey<Boolean> SECURE_REQUEST
```
    Deprecated.
- Constructor Detail
  - HttpServletRequestImpl
```
public HttpServletRequestImpl(HttpServerExchange exchange,
                              ServletContextImpl servletContext)
```
- Method Detail
  - getExchange
```
public HttpServerExchange getExchange()
```
  - getAuthType
```
public String getAuthType()
```
    Specified by:
    
    getAuthType in interface jakarta.servlet.http.HttpServletRequest
  - getCookies
```
public jakarta.servlet.http.Cookie[] getCookies()
```
    Specified by:
    
    getCookies in interface jakarta.servlet.http.HttpServletRequest
  - 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
  - getHeader
```
public String getHeader(HttpString name)
```
  - 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
  - getHttpServletMapping
```
public jakarta.servlet.http.HttpServletMapping getHttpServletMapping()
```
    Specified by:
    
    getHttpServletMapping 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
  - 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
  - changeSessionId
```
public String changeSessionId()
```
    Specified by:
    
    changeSessionId 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
  - 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
  - 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
  - authenticate
```
public boolean authenticate(jakarta.servlet.http.HttpServletResponse response)
                     throws IOException,
                            jakarta.servlet.ServletException
```
    Specified by:
    
    authenticate in interface jakarta.servlet.http.HttpServletRequest
    
    Throws:
    
    IOException
    
    jakarta.servlet.ServletException
  - login
```
public void login(String username,
                  String password)
           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 name)
                                  throws IOException,
                                         jakarta.servlet.ServletException
```
    Specified by:
    
    getPart in interface jakarta.servlet.http.HttpServletRequest
    
    Throws:
    
    IOException
    
    jakarta.servlet.ServletException
  - upgrade
```
public <T extends jakarta.servlet.http.HttpUpgradeHandler> T upgrade(Class<T> handlerClass)
                                                              throws IOException
```
    Specified by:
    
    upgrade in interface jakarta.servlet.http.HttpServletRequest
    
    Throws:
    
    IOException
  - 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
  - closeAndDrainRequest
```
public void closeAndDrainRequest()
                          throws IOException
```
    Throws:
    
    IOException
  - freeResources
```
public void freeResources()
                   throws IOException
```
    Frees any resources (namely buffers) that may be associated with this request.
    
    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 object)
```
    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
  - getRemotePort
```
public int getRemotePort()
```
    Specified by:
    
    getRemotePort in interface jakarta.servlet.ServletRequest
  - getLocalName
```
public String getLocalName()
```
    String java.net.InetAddress.getHostName() Gets the host name for this IP address. If this InetAddress was created with a host name, this host name will be remembered and returned; otherwise, a reverse name lookup will be performed and the result will be returned based on the system configured name lookup service. If a lookup of the name service is required, call getCanonicalHostName. If there is a security manager, its checkConnect method is first called with the hostname and -1 as its arguments to see if the operation is allowed. If the operation is not allowed, it will return the textual representation of the IP address.
    
    Specified by:
    
    getLocalName in interface jakarta.servlet.ServletRequest
    
    See Also:
    
    InetAddress.getHostName(boolean)
  - getLocalAddr
```
public String getLocalAddr()
```
    Specified by:
    
    getLocalAddr in interface jakarta.servlet.ServletRequest
  - getLocalPort
```
public int getLocalPort()
```
    Specified by:
    
    getLocalPort in interface jakarta.servlet.ServletRequest
  - getServletContext
```
public ServletContextImpl getServletContext()
```
    Specified by:
    
    getServletContext 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
  - isAsyncSupported
```
public boolean isAsyncSupported()
```
    Specified by:
    
    isAsyncSupported in interface jakarta.servlet.ServletRequest
  - getAsyncContext
```
public AsyncContextImpl getAsyncContext()
```
    Specified by:
    
    getAsyncContext in interface jakarta.servlet.ServletRequest
  - getAsyncContextInternal
```
public AsyncContextImpl getAsyncContextInternal()
```
  - getDispatcherType
```
public jakarta.servlet.DispatcherType getDispatcherType()
```
    Specified by:
    
    getDispatcherType in interface jakarta.servlet.ServletRequest
  - getQueryParameters
```
public Map<String,Deque<String>> getQueryParameters()
```
  - setQueryParameters
```
public void setQueryParameters(Map<String,Deque<String>> queryParameters)
```
  - setServletContext
```
public void setServletContext(ServletContextImpl servletContext)
```
  - getOriginalRequestURI
```
public String getOriginalRequestURI()
```
  - getOriginalServletPath
```
public String getOriginalServletPath()
```
  - getOriginalPathInfo
```
public String getOriginalPathInfo()
```
  - getOriginalContextPath
```
public String getOriginalContextPath()
```
  - getOriginalQueryString
```
public String getOriginalQueryString()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - clearAttributes
```
public void clearAttributes()
```
  - 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

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

SECURE_REQUEST

Constructor Detail

HttpServletRequestImpl

Method Detail

getExchange

getAuthType

getCookies

getDateHeader

getHeader

getHeader

getHeaders

getHeaderNames

getHttpServletMapping

getIntHeader

getMethod

getPathInfo

getPathTranslated

getContextPath

getQueryString

getRemoteUser

isUserInRole

getUserPrincipal

getRequestedSessionId

changeSessionId

getRequestId

getProtocolRequestId

getServletConnection

getRequestURI

getRequestURL

getServletPath

getSession

getSession

isRequestedSessionIdValid

isRequestedSessionIdFromCookie

isRequestedSessionIdFromURL

authenticate

login

logout

getParts

getPart

upgrade

getAttribute

getAttributeNames

getCharacterEncoding

setCharacterEncoding

getContentLength

getContentLengthLong

getContentType

getInputStream

closeAndDrainRequest

freeResources

getParameter

getParameterNames

getParameterValues

getParameterMap

getProtocol

getScheme

getServerName

getServerPort

getReader

getRemoteAddr

getRemoteHost

setAttribute

removeAttribute

getLocale

getLocales

isSecure

getRequestDispatcher

getRemotePort

getLocalName

getLocalAddr

getLocalPort

getServletContext