AtmosphereRequestImpl (atmosphere-runtime 3.0.0 API)

java.lang.Object
- jakarta.servlet.ServletRequestWrapper
- - jakarta.servlet.http.HttpServletRequestWrapper
  - - org.atmosphere.cpr.AtmosphereRequestImpl

All Implemented Interfaces:

jakarta.servlet.http.HttpServletRequest, jakarta.servlet.ServletRequest, AtmosphereRequest
```
public class AtmosphereRequestImpl
extends jakarta.servlet.http.HttpServletRequestWrapper
implements AtmosphereRequest
```
An Atmosphere request representation. An AtmosphereRequest is a two-way communication channel between the client and the server. If the isDestroyable() is set to false, or if its associated AtmosphereResource has been suspended, this object can be re-used at any moment between requests. You can use its associated AtmosphereResponse to write bytes at any moment, making this object bi-directional.

Author:

Jeanfrancois Arcand

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`AtmosphereRequestImpl.Body`
`static class`	`AtmosphereRequestImpl.Builder`
`static class`	`AtmosphereRequestImpl.LazyComputation`
`static class`	`AtmosphereRequestImpl.NoOpsRequest`

Nested classes/interfaces inherited from interface org.atmosphere.cpr.AtmosphereRequest
AtmosphereRequest.LocalAttributes

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AtmosphereRequest.LocalAttributes`	`attributes()` Return the locally added attributes.
`boolean`	`authenticate(jakarta.servlet.http.HttpServletResponse response)`
`AtmosphereRequestImpl.Body`	`body()` Return the request's body.
`AtmosphereRequest`	`body(byte[] bytes)`
`AtmosphereRequest`	`body(java.io.InputStream body)`
`AtmosphereRequest`	`body(java.io.Reader body)`
`AtmosphereRequest`	`body(java.lang.String body)`
`static AtmosphereRequest`	`cloneRequest(jakarta.servlet.http.HttpServletRequest request, boolean loadInMemory, boolean copySession, boolean isDestroyable, boolean createSession)` Copy the HttpServletRequest content inside an AtmosphereRequest.
`AtmosphereRequest`	`contentType(java.lang.String m)`
`AtmosphereRequest`	`contextPath(java.lang.String contextPath)`
`void`	`destroy()`
`void`	`destroy(boolean force)`
`AtmosphereRequest`	`destroyable(boolean destroyable)`
`boolean`	`destroyed()`
`boolean`	`dispatchRequestAsynchronously()` Dispatch the request asynchronously to container.
`jakarta.servlet.AsyncContext`	`getAsyncContext()`
`java.lang.Object`	`getAttribute(java.lang.String s)`
`java.util.Enumeration<java.lang.String>`	`getAttributeNames()`
`java.lang.String`	`getAuthType()`
`java.lang.String`	`getCharacterEncoding()`
`int`	`getContentLength()`
`java.lang.String`	`getContentType()`
`java.lang.String`	`getContextPath()`
`jakarta.servlet.http.Cookie[]`	`getCookies()`
`long`	`getDateHeader(java.lang.String name)`
`jakarta.servlet.DispatcherType`	`getDispatcherType()`
`java.lang.String`	`getHeader(java.lang.String s)`
`java.lang.String`	`getHeader(java.lang.String s, boolean checkCase)`
`java.util.Enumeration<java.lang.String>`	`getHeaderNames()`
`java.util.Enumeration`	`getHeaders(java.lang.String name)`
`jakarta.servlet.ServletInputStream`	`getInputStream()`
`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 s)`
`java.util.Map<java.lang.String,java.lang.String[]>`	`getParameterMap()`
`java.util.Enumeration<java.lang.String>`	`getParameterNames()`
`java.lang.String[]`	`getParameterValues(java.lang.String s)`
`jakarta.servlet.http.Part`	`getPart(java.lang.String name)`
`java.util.Collection<jakarta.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()`
`jakarta.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()`
`jakarta.servlet.ServletContext`	`getServletContext()`
`java.lang.String`	`getServletPath()`
`jakarta.servlet.http.HttpSession`	`getSession()`
`jakarta.servlet.http.HttpSession`	`getSession(boolean create)`
`java.security.Principal`	`getUserPrincipal()`
`AtmosphereRequest`	`header(java.lang.String name, java.lang.String value)` Add a header.
`AtmosphereRequest`	`headers(java.util.Map<java.lang.String,java.lang.String> headers)` Add all headers contained within the Map.
`java.util.Map<java.lang.String,java.lang.String>`	`headersMap()`
`boolean`	`isAsyncStarted()`
`boolean`	`isAsyncSupported()`
`boolean`	`isDestroyable()` Cjeck if this object can be destroyed.
`boolean`	`isRequestedSessionIdFromCookie()`
`boolean`	`isRequestedSessionIdFromUrl()`
`boolean`	`isRequestedSessionIdFromURL()`
`boolean`	`isRequestedSessionIdValid()`
`boolean`	`isSecure()`
`boolean`	`isUserInRole(java.lang.String role)`
`AtmosphereRequest.LocalAttributes`	`localAttributes()` Return a subset of the attributes set on this AtmosphereRequest, set locally by the framework or by an application.
`void`	`login(java.lang.String username, java.lang.String password)`
`void`	`logout()`
`AtmosphereRequest`	`method(java.lang.String m)`
`static AtmosphereRequest`	`newInstance()` Create an instance of this class without an associated `HttpServletRequest`.
`AtmosphereRequest`	`pathInfo(java.lang.String pathInfo)`
`AtmosphereRequest`	`queryString(java.lang.String qs)` Set the query string.
`java.util.Map<java.lang.String,java.lang.String[]>`	`queryStringsMap()`
`void`	`removeAttribute(java.lang.String name)`
`AtmosphereRequest`	`requestURI(java.lang.String requestURI)`
`java.lang.String`	`requestURL()`
`AtmosphereResource`	`resource()` The `AtmosphereResource` associated with this request.
`AtmosphereRequest`	`servletPath(java.lang.String servletPath)`
`void`	`setAttribute(java.lang.String s, java.lang.Object o)`
`void`	`setCharacterEncoding(java.lang.String env)`
`void`	`setRequest(jakarta.servlet.ServletRequest request)`
`jakarta.servlet.AsyncContext`	`startAsync()`
`jakarta.servlet.AsyncContext`	`startAsync(jakarta.servlet.ServletRequest request, jakarta.servlet.ServletResponse response)`
`java.lang.String`	`toString()`
`java.lang.String`	`uuid()` Return the underlying `AtmosphereResource.uuid()`.
`static AtmosphereRequest`	`wrap(jakarta.servlet.http.HttpServletRequest request)` Wrap an `HttpServletRequest`.
`jakarta.servlet.http.HttpServletRequest`	`wrappedRequest()`

Methods inherited from class jakarta.servlet.http.HttpServletRequestWrapper
changeSessionId, getHttpServletMapping, getTrailerFields, isTrailerFieldsReady, newPushBuilder, upgrade

Methods inherited from class jakarta.servlet.ServletRequestWrapper
getContentLengthLong, getRequest, isWrapperFor, isWrapperFor

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

Methods inherited from interface jakarta.servlet.http.HttpServletRequest
changeSessionId, getHttpServletMapping, getTrailerFields, isTrailerFieldsReady, newPushBuilder, upgrade

Methods inherited from interface jakarta.servlet.ServletRequest
getContentLengthLong

- Method Detail
  - destroyed
```
public boolean destroyed()
```
    Specified by:
    
    destroyed in interface AtmosphereRequest
  - destroyable
```
public AtmosphereRequest destroyable(boolean destroyable)
```
    Specified by:
    
    destroyable in interface AtmosphereRequest
  - getPathInfo
```
public java.lang.String getPathInfo()
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getPathInfo in interface jakarta.servlet.http.HttpServletRequest
    
    Specified by:
    
    getPathInfo in interface AtmosphereRequest
    
    Overrides:
    
    getPathInfo in class jakarta.servlet.http.HttpServletRequestWrapper
  - getPathTranslated
```
public java.lang.String getPathTranslated()
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getPathTranslated in interface jakarta.servlet.http.HttpServletRequest
    
    Specified by:
    
    getPathTranslated in interface AtmosphereRequest
    
    Overrides:
    
    getPathTranslated in class jakarta.servlet.http.HttpServletRequestWrapper
  - getQueryString
```
public java.lang.String getQueryString()
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getQueryString in interface jakarta.servlet.http.HttpServletRequest
    
    Specified by:
    
    getQueryString in interface AtmosphereRequest
    
    Overrides:
    
    getQueryString in class jakarta.servlet.http.HttpServletRequestWrapper
  - getRemoteUser
```
public java.lang.String getRemoteUser()
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getRemoteUser in interface jakarta.servlet.http.HttpServletRequest
    
    Specified by:
    
    getRemoteUser in interface AtmosphereRequest
    
    Overrides:
    
    getRemoteUser in class jakarta.servlet.http.HttpServletRequestWrapper
  - getRequestedSessionId
```
public java.lang.String getRequestedSessionId()
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getRequestedSessionId in interface jakarta.servlet.http.HttpServletRequest
    
    Specified by:
    
    getRequestedSessionId in interface AtmosphereRequest
    
    Overrides:
    
    getRequestedSessionId in class jakarta.servlet.http.HttpServletRequestWrapper
  - getMethod
```
public java.lang.String getMethod()
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getMethod in interface jakarta.servlet.http.HttpServletRequest
    
    Specified by:
    
    getMethod in interface AtmosphereRequest
    
    Overrides:
    
    getMethod in class jakarta.servlet.http.HttpServletRequestWrapper
  - getPart
```
public jakarta.servlet.http.Part getPart(java.lang.String name)
                                  throws java.io.IOException,
                                         jakarta.servlet.ServletException
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getPart in interface jakarta.servlet.http.HttpServletRequest
    
    Specified by:
    
    getPart in interface AtmosphereRequest
    
    Overrides:
    
    getPart in class jakarta.servlet.http.HttpServletRequestWrapper
    
    Throws:
    
    java.io.IOException
    
    jakarta.servlet.ServletException
  - getParts
```
public java.util.Collection<jakarta.servlet.http.Part> getParts()
                                                         throws java.io.IOException,
                                                                jakarta.servlet.ServletException
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getParts in interface jakarta.servlet.http.HttpServletRequest
    
    Specified by:
    
    getParts in interface AtmosphereRequest
    
    Overrides:
    
    getParts in class jakarta.servlet.http.HttpServletRequestWrapper
    
    Throws:
    
    java.io.IOException
    
    jakarta.servlet.ServletException
  - getContentType
```
public java.lang.String getContentType()
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getContentType in interface jakarta.servlet.ServletRequest
    
    Specified by:
    
    getContentType in interface AtmosphereRequest
    
    Overrides:
    
    getContentType in class jakarta.servlet.ServletRequestWrapper
  - getDispatcherType
```
public jakarta.servlet.DispatcherType getDispatcherType()
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getDispatcherType in interface jakarta.servlet.ServletRequest
    
    Specified by:
    
    getDispatcherType in interface AtmosphereRequest
    
    Overrides:
    
    getDispatcherType in class jakarta.servlet.ServletRequestWrapper
  - getServletPath
```
public java.lang.String getServletPath()
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getServletPath in interface jakarta.servlet.http.HttpServletRequest
    
    Specified by:
    
    getServletPath in interface AtmosphereRequest
    
    Overrides:
    
    getServletPath in class jakarta.servlet.http.HttpServletRequestWrapper
  - getRequestURI
```
public java.lang.String getRequestURI()
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getRequestURI in interface jakarta.servlet.http.HttpServletRequest
    
    Specified by:
    
    getRequestURI in interface AtmosphereRequest
    
    Overrides:
    
    getRequestURI in class jakarta.servlet.http.HttpServletRequestWrapper
  - getRequestURL
```
public java.lang.StringBuffer getRequestURL()
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getRequestURL in interface jakarta.servlet.http.HttpServletRequest
    
    Specified by:
    
    getRequestURL in interface AtmosphereRequest
    
    Overrides:
    
    getRequestURL in class jakarta.servlet.http.HttpServletRequestWrapper
  - getHeaders
```
public java.util.Enumeration getHeaders(java.lang.String name)
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getHeaders in interface jakarta.servlet.http.HttpServletRequest
    
    Specified by:
    
    getHeaders in interface AtmosphereRequest
    
    Overrides:
    
    getHeaders in class jakarta.servlet.http.HttpServletRequestWrapper
  - getIntHeader
```
public int getIntHeader(java.lang.String name)
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getIntHeader in interface jakarta.servlet.http.HttpServletRequest
    
    Specified by:
    
    getIntHeader in interface AtmosphereRequest
    
    Overrides:
    
    getIntHeader in class jakarta.servlet.http.HttpServletRequestWrapper
  - getHeaderNames
```
public java.util.Enumeration<java.lang.String> getHeaderNames()
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getHeaderNames in interface jakarta.servlet.http.HttpServletRequest
    
    Specified by:
    
    getHeaderNames in interface AtmosphereRequest
    
    Overrides:
    
    getHeaderNames in class jakarta.servlet.http.HttpServletRequestWrapper
  - authenticate
```
public boolean authenticate(jakarta.servlet.http.HttpServletResponse response)
                     throws java.io.IOException,
                            jakarta.servlet.ServletException
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    authenticate in interface jakarta.servlet.http.HttpServletRequest
    
    Specified by:
    
    authenticate in interface AtmosphereRequest
    
    Overrides:
    
    authenticate in class jakarta.servlet.http.HttpServletRequestWrapper
    
    Throws:
    
    java.io.IOException
    
    jakarta.servlet.ServletException
  - getAuthType
```
public java.lang.String getAuthType()
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getAuthType in interface jakarta.servlet.http.HttpServletRequest
    
    Specified by:
    
    getAuthType in interface AtmosphereRequest
    
    Overrides:
    
    getAuthType in class jakarta.servlet.http.HttpServletRequestWrapper
  - getContextPath
```
public java.lang.String getContextPath()
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getContextPath in interface jakarta.servlet.http.HttpServletRequest
    
    Specified by:
    
    getContextPath in interface AtmosphereRequest
    
    Overrides:
    
    getContextPath in class jakarta.servlet.http.HttpServletRequestWrapper
  - getCookies
```
public jakarta.servlet.http.Cookie[] getCookies()
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getCookies in interface jakarta.servlet.http.HttpServletRequest
    
    Specified by:
    
    getCookies in interface AtmosphereRequest
    
    Overrides:
    
    getCookies in class jakarta.servlet.http.HttpServletRequestWrapper
  - getDateHeader
```
public long getDateHeader(java.lang.String name)
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getDateHeader in interface jakarta.servlet.http.HttpServletRequest
    
    Specified by:
    
    getDateHeader in interface AtmosphereRequest
    
    Overrides:
    
    getDateHeader in class jakarta.servlet.http.HttpServletRequestWrapper
  - getHeader
```
public java.lang.String getHeader(java.lang.String s)
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getHeader in interface jakarta.servlet.http.HttpServletRequest
    
    Specified by:
    
    getHeader in interface AtmosphereRequest
    
    Overrides:
    
    getHeader in class jakarta.servlet.http.HttpServletRequestWrapper
  - wrappedRequest
```
public jakarta.servlet.http.HttpServletRequest wrappedRequest()
```
    Specified by:
    
    wrappedRequest in interface AtmosphereRequest
  - getHeader
```
public java.lang.String getHeader(java.lang.String s,
                                  boolean checkCase)
```
    Specified by:
    
    getHeader in interface AtmosphereRequest
  - getParameter
```
public java.lang.String getParameter(java.lang.String s)
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getParameter in interface jakarta.servlet.ServletRequest
    
    Specified by:
    
    getParameter in interface AtmosphereRequest
    
    Overrides:
    
    getParameter in class jakarta.servlet.ServletRequestWrapper
  - getParameterMap
```
public java.util.Map<java.lang.String,java.lang.String[]> getParameterMap()
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getParameterMap in interface jakarta.servlet.ServletRequest
    
    Specified by:
    
    getParameterMap in interface AtmosphereRequest
    
    Overrides:
    
    getParameterMap in class jakarta.servlet.ServletRequestWrapper
  - getParameterNames
```
public java.util.Enumeration<java.lang.String> getParameterNames()
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getParameterNames in interface jakarta.servlet.ServletRequest
    
    Specified by:
    
    getParameterNames in interface AtmosphereRequest
    
    Overrides:
    
    getParameterNames in class jakarta.servlet.ServletRequestWrapper
  - getParameterValues
```
public java.lang.String[] getParameterValues(java.lang.String s)
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getParameterValues in interface jakarta.servlet.ServletRequest
    
    Specified by:
    
    getParameterValues in interface AtmosphereRequest
    
    Overrides:
    
    getParameterValues in class jakarta.servlet.ServletRequestWrapper
  - getProtocol
```
public java.lang.String getProtocol()
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getProtocol in interface jakarta.servlet.ServletRequest
    
    Specified by:
    
    getProtocol in interface AtmosphereRequest
    
    Overrides:
    
    getProtocol in class jakarta.servlet.ServletRequestWrapper
  - getInputStream
```
public jakarta.servlet.ServletInputStream getInputStream()
                                                  throws java.io.IOException
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getInputStream in interface jakarta.servlet.ServletRequest
    
    Specified by:
    
    getInputStream in interface AtmosphereRequest
    
    Overrides:
    
    getInputStream in class jakarta.servlet.ServletRequestWrapper
    
    Throws:
    
    java.io.IOException
  - getReader
```
public java.io.BufferedReader getReader()
                                 throws java.io.IOException
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getReader in interface jakarta.servlet.ServletRequest
    
    Specified by:
    
    getReader in interface AtmosphereRequest
    
    Overrides:
    
    getReader in class jakarta.servlet.ServletRequestWrapper
    
    Throws:
    
    java.io.IOException
  - getRealPath
```
public java.lang.String getRealPath(java.lang.String path)
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getRealPath in interface jakarta.servlet.ServletRequest
    
    Specified by:
    
    getRealPath in interface AtmosphereRequest
    
    Overrides:
    
    getRealPath in class jakarta.servlet.ServletRequestWrapper
  - headers
```
public AtmosphereRequest headers(java.util.Map<java.lang.String,java.lang.String> headers)
```
    Description copied from interface: AtmosphereRequest
    
    Add all headers contained within the Map.
    
    Specified by:
    
    headers in interface AtmosphereRequest
    
    Returns:
    
    this;
  - header
```
public AtmosphereRequest header(java.lang.String name,
                                java.lang.String value)
```
    Description copied from interface: AtmosphereRequest
    
    Add a header.
    
    Specified by:
    
    header in interface AtmosphereRequest
    
    Returns:
    
    this
  - queryString
```
public AtmosphereRequest queryString(java.lang.String qs)
```
    Description copied from interface: AtmosphereRequest
    
    Set the query string.
    
    Specified by:
    
    queryString in interface AtmosphereRequest
    
    Returns:
    
    this
  - headersMap
```
public java.util.Map<java.lang.String,java.lang.String> headersMap()
```
    Specified by:
    
    headersMap in interface AtmosphereRequest
  - queryStringsMap
```
public java.util.Map<java.lang.String,java.lang.String[]> queryStringsMap()
```
    Specified by:
    
    queryStringsMap in interface AtmosphereRequest
  - method
```
public AtmosphereRequest method(java.lang.String m)
```
    Specified by:
    
    method in interface AtmosphereRequest
  - contentType
```
public AtmosphereRequest contentType(java.lang.String m)
```
    Specified by:
    
    contentType in interface AtmosphereRequest
  - body
```
public AtmosphereRequest body(java.lang.String body)
```
    Specified by:
    
    body in interface AtmosphereRequest
  - body
```
public AtmosphereRequest body(byte[] bytes)
```
    Specified by:
    
    body in interface AtmosphereRequest
  - body
```
public AtmosphereRequest body(java.io.InputStream body)
```
    Specified by:
    
    body in interface AtmosphereRequest
  - body
```
public AtmosphereRequest body(java.io.Reader body)
```
    Specified by:
    
    body in interface AtmosphereRequest
  - body
```
public AtmosphereRequestImpl.Body body()
```
    Description copied from interface: AtmosphereRequest
    
    Return the request's body. This method will return an empty Body if the underlying container or framework is using InputStream or Reader.
    
    Specified by:
    
    body in interface AtmosphereRequest
    
    Returns:
    
    the request body;
  - servletPath
```
public AtmosphereRequest servletPath(java.lang.String servletPath)
```
    Specified by:
    
    servletPath in interface AtmosphereRequest
  - contextPath
```
public AtmosphereRequest contextPath(java.lang.String contextPath)
```
    Specified by:
    
    contextPath in interface AtmosphereRequest
  - requestURI
```
public AtmosphereRequest requestURI(java.lang.String requestURI)
```
    Specified by:
    
    requestURI in interface AtmosphereRequest
  - setAttribute
```
public void setAttribute(java.lang.String s,
                         java.lang.Object o)
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    setAttribute in interface jakarta.servlet.ServletRequest
    
    Specified by:
    
    setAttribute in interface AtmosphereRequest
    
    Overrides:
    
    setAttribute in class jakarta.servlet.ServletRequestWrapper
  - setCharacterEncoding
```
public void setCharacterEncoding(java.lang.String env)
                          throws java.io.UnsupportedEncodingException
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    setCharacterEncoding in interface jakarta.servlet.ServletRequest
    
    Specified by:
    
    setCharacterEncoding in interface AtmosphereRequest
    
    Overrides:
    
    setCharacterEncoding in class jakarta.servlet.ServletRequestWrapper
    
    Throws:
    
    java.io.UnsupportedEncodingException
  - startAsync
```
public jakarta.servlet.AsyncContext startAsync()
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    startAsync in interface jakarta.servlet.ServletRequest
    
    Specified by:
    
    startAsync in interface AtmosphereRequest
    
    Overrides:
    
    startAsync in class jakarta.servlet.ServletRequestWrapper
  - startAsync
```
public jakarta.servlet.AsyncContext startAsync(jakarta.servlet.ServletRequest request,
                                               jakarta.servlet.ServletResponse response)
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    startAsync in interface jakarta.servlet.ServletRequest
    
    Specified by:
    
    startAsync in interface AtmosphereRequest
    
    Overrides:
    
    startAsync in class jakarta.servlet.ServletRequestWrapper
  - getAsyncContext
```
public jakarta.servlet.AsyncContext getAsyncContext()
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getAsyncContext in interface jakarta.servlet.ServletRequest
    
    Specified by:
    
    getAsyncContext in interface AtmosphereRequest
    
    Overrides:
    
    getAsyncContext in class jakarta.servlet.ServletRequestWrapper
  - getAttribute
```
public java.lang.Object getAttribute(java.lang.String s)
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getAttribute in interface jakarta.servlet.ServletRequest
    
    Specified by:
    
    getAttribute in interface AtmosphereRequest
    
    Overrides:
    
    getAttribute in class jakarta.servlet.ServletRequestWrapper
  - removeAttribute
```
public void removeAttribute(java.lang.String name)
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    removeAttribute in interface jakarta.servlet.ServletRequest
    
    Specified by:
    
    removeAttribute in interface AtmosphereRequest
    
    Overrides:
    
    removeAttribute in class jakarta.servlet.ServletRequestWrapper
  - attributes
```
public AtmosphereRequest.LocalAttributes attributes()
```
    Description copied from interface: AtmosphereRequest
    
    Return the locally added attributes.
    
    Specified by:
    
    attributes in interface AtmosphereRequest
    
    Returns:
    
    the locally added attributes
  - getSession
```
public jakarta.servlet.http.HttpSession getSession()
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getSession in interface jakarta.servlet.http.HttpServletRequest
    
    Specified by:
    
    getSession in interface AtmosphereRequest
    
    Overrides:
    
    getSession in class jakarta.servlet.http.HttpServletRequestWrapper
  - getSession
```
public jakarta.servlet.http.HttpSession getSession(boolean create)
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getSession in interface jakarta.servlet.http.HttpServletRequest
    
    Specified by:
    
    getSession in interface AtmosphereRequest
    
    Overrides:
    
    getSession in class jakarta.servlet.http.HttpServletRequestWrapper
  - getUserPrincipal
```
public java.security.Principal getUserPrincipal()
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getUserPrincipal in interface jakarta.servlet.http.HttpServletRequest
    
    Specified by:
    
    getUserPrincipal in interface AtmosphereRequest
    
    Overrides:
    
    getUserPrincipal in class jakarta.servlet.http.HttpServletRequestWrapper
  - isRequestedSessionIdFromCookie
```
public boolean isRequestedSessionIdFromCookie()
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    isRequestedSessionIdFromCookie in interface jakarta.servlet.http.HttpServletRequest
    
    Specified by:
    
    isRequestedSessionIdFromCookie in interface AtmosphereRequest
    
    Overrides:
    
    isRequestedSessionIdFromCookie in class jakarta.servlet.http.HttpServletRequestWrapper
  - isRequestedSessionIdFromUrl
```
public boolean isRequestedSessionIdFromUrl()
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    isRequestedSessionIdFromUrl in interface jakarta.servlet.http.HttpServletRequest
    
    Specified by:
    
    isRequestedSessionIdFromUrl in interface AtmosphereRequest
    
    Overrides:
    
    isRequestedSessionIdFromUrl in class jakarta.servlet.http.HttpServletRequestWrapper
  - isRequestedSessionIdFromURL
```
public boolean isRequestedSessionIdFromURL()
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    isRequestedSessionIdFromURL in interface jakarta.servlet.http.HttpServletRequest
    
    Specified by:
    
    isRequestedSessionIdFromURL in interface AtmosphereRequest
    
    Overrides:
    
    isRequestedSessionIdFromURL in class jakarta.servlet.http.HttpServletRequestWrapper
  - isRequestedSessionIdValid
```
public boolean isRequestedSessionIdValid()
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    isRequestedSessionIdValid in interface jakarta.servlet.http.HttpServletRequest
    
    Specified by:
    
    isRequestedSessionIdValid in interface AtmosphereRequest
    
    Overrides:
    
    isRequestedSessionIdValid in class jakarta.servlet.http.HttpServletRequestWrapper
  - isUserInRole
```
public boolean isUserInRole(java.lang.String role)
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    isUserInRole in interface jakarta.servlet.http.HttpServletRequest
    
    Specified by:
    
    isUserInRole in interface AtmosphereRequest
    
    Overrides:
    
    isUserInRole in class jakarta.servlet.http.HttpServletRequestWrapper
  - login
```
public void login(java.lang.String username,
                  java.lang.String password)
           throws jakarta.servlet.ServletException
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    login in interface jakarta.servlet.http.HttpServletRequest
    
    Specified by:
    
    login in interface AtmosphereRequest
    
    Overrides:
    
    login in class jakarta.servlet.http.HttpServletRequestWrapper
    
    Throws:
    
    jakarta.servlet.ServletException
  - logout
```
public void logout()
            throws jakarta.servlet.ServletException
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    logout in interface jakarta.servlet.http.HttpServletRequest
    
    Specified by:
    
    logout in interface AtmosphereRequest
    
    Overrides:
    
    logout in class jakarta.servlet.http.HttpServletRequestWrapper
    
    Throws:
    
    jakarta.servlet.ServletException
  - getRemoteAddr
```
public java.lang.String getRemoteAddr()
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getRemoteAddr in interface jakarta.servlet.ServletRequest
    
    Specified by:
    
    getRemoteAddr in interface AtmosphereRequest
    
    Overrides:
    
    getRemoteAddr in class jakarta.servlet.ServletRequestWrapper
  - getRemoteHost
```
public java.lang.String getRemoteHost()
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getRemoteHost in interface jakarta.servlet.ServletRequest
    
    Specified by:
    
    getRemoteHost in interface AtmosphereRequest
    
    Overrides:
    
    getRemoteHost in class jakarta.servlet.ServletRequestWrapper
  - getRemotePort
```
public int getRemotePort()
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getRemotePort in interface jakarta.servlet.ServletRequest
    
    Specified by:
    
    getRemotePort in interface AtmosphereRequest
    
    Overrides:
    
    getRemotePort in class jakarta.servlet.ServletRequestWrapper
  - getRequestDispatcher
```
public jakarta.servlet.RequestDispatcher getRequestDispatcher(java.lang.String path)
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getRequestDispatcher in interface jakarta.servlet.ServletRequest
    
    Specified by:
    
    getRequestDispatcher in interface AtmosphereRequest
    
    Overrides:
    
    getRequestDispatcher in class jakarta.servlet.ServletRequestWrapper
  - getScheme
```
public java.lang.String getScheme()
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getScheme in interface jakarta.servlet.ServletRequest
    
    Specified by:
    
    getScheme in interface AtmosphereRequest
    
    Overrides:
    
    getScheme in class jakarta.servlet.ServletRequestWrapper
  - getServerName
```
public java.lang.String getServerName()
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getServerName in interface jakarta.servlet.ServletRequest
    
    Specified by:
    
    getServerName in interface AtmosphereRequest
    
    Overrides:
    
    getServerName in class jakarta.servlet.ServletRequestWrapper
  - getServerPort
```
public int getServerPort()
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getServerPort in interface jakarta.servlet.ServletRequest
    
    Specified by:
    
    getServerPort in interface AtmosphereRequest
    
    Overrides:
    
    getServerPort in class jakarta.servlet.ServletRequestWrapper
  - getServletContext
```
public jakarta.servlet.ServletContext getServletContext()
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getServletContext in interface jakarta.servlet.ServletRequest
    
    Specified by:
    
    getServletContext in interface AtmosphereRequest
    
    Overrides:
    
    getServletContext in class jakarta.servlet.ServletRequestWrapper
  - isAsyncStarted
```
public boolean isAsyncStarted()
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    isAsyncStarted in interface jakarta.servlet.ServletRequest
    
    Specified by:
    
    isAsyncStarted in interface AtmosphereRequest
    
    Overrides:
    
    isAsyncStarted in class jakarta.servlet.ServletRequestWrapper
  - isAsyncSupported
```
public boolean isAsyncSupported()
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    isAsyncSupported in interface jakarta.servlet.ServletRequest
    
    Specified by:
    
    isAsyncSupported in interface AtmosphereRequest
    
    Overrides:
    
    isAsyncSupported in class jakarta.servlet.ServletRequestWrapper
  - isSecure
```
public boolean isSecure()
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    isSecure in interface jakarta.servlet.ServletRequest
    
    Specified by:
    
    isSecure in interface AtmosphereRequest
    
    Overrides:
    
    isSecure in class jakarta.servlet.ServletRequestWrapper
  - getLocalName
```
public java.lang.String getLocalName()
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getLocalName in interface jakarta.servlet.ServletRequest
    
    Specified by:
    
    getLocalName in interface AtmosphereRequest
    
    Overrides:
    
    getLocalName in class jakarta.servlet.ServletRequestWrapper
  - getLocalPort
```
public int getLocalPort()
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getLocalPort in interface jakarta.servlet.ServletRequest
    
    Specified by:
    
    getLocalPort in interface AtmosphereRequest
    
    Overrides:
    
    getLocalPort in class jakarta.servlet.ServletRequestWrapper
  - getLocalAddr
```
public java.lang.String getLocalAddr()
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getLocalAddr in interface jakarta.servlet.ServletRequest
    
    Specified by:
    
    getLocalAddr in interface AtmosphereRequest
    
    Overrides:
    
    getLocalAddr in class jakarta.servlet.ServletRequestWrapper
  - getLocale
```
public java.util.Locale getLocale()
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getLocale in interface jakarta.servlet.ServletRequest
    
    Specified by:
    
    getLocale in interface AtmosphereRequest
    
    Overrides:
    
    getLocale in class jakarta.servlet.ServletRequestWrapper
  - resource
```
public AtmosphereResource resource()
```
    Description copied from interface: AtmosphereRequest
    
    The AtmosphereResource associated with this request.
    
    Specified by:
    
    resource in interface AtmosphereRequest
    
    Returns:
    
    an AtmosphereResource
  - getLocales
```
public java.util.Enumeration<java.util.Locale> getLocales()
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getLocales in interface jakarta.servlet.ServletRequest
    
    Specified by:
    
    getLocales in interface AtmosphereRequest
    
    Overrides:
    
    getLocales in class jakarta.servlet.ServletRequestWrapper
  - dispatchRequestAsynchronously
```
public boolean dispatchRequestAsynchronously()
```
    Description copied from interface: AtmosphereRequest
    
    Dispatch the request asynchronously to container. The default is false.
    
    Specified by:
    
    dispatchRequestAsynchronously in interface AtmosphereRequest
    
    Returns:
    
    true to dispatch the request asynchronously to container.
  - isDestroyable
```
public boolean isDestroyable()
```
    Description copied from interface: AtmosphereRequest
    
    Cjeck if this object can be destroyed. Default is true.
    
    Specified by:
    
    isDestroyable in interface AtmosphereRequest
  - pathInfo
```
public AtmosphereRequest pathInfo(java.lang.String pathInfo)
```
    Specified by:
    
    pathInfo in interface AtmosphereRequest
  - getAttributeNames
```
public java.util.Enumeration<java.lang.String> getAttributeNames()
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getAttributeNames in interface jakarta.servlet.ServletRequest
    
    Specified by:
    
    getAttributeNames in interface AtmosphereRequest
    
    Overrides:
    
    getAttributeNames in class jakarta.servlet.ServletRequestWrapper
  - localAttributes
```
public AtmosphereRequest.LocalAttributes localAttributes()
```
    Description copied from interface: AtmosphereRequest
    
    Return a subset of the attributes set on this AtmosphereRequest, set locally by the framework or by an application. Attributes added using this method won't be propagated to the original, container-only, native request object.
    
    Specified by:
    
    localAttributes in interface AtmosphereRequest
    
    Returns:
    
    a
  - getCharacterEncoding
```
public java.lang.String getCharacterEncoding()
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getCharacterEncoding in interface jakarta.servlet.ServletRequest
    
    Specified by:
    
    getCharacterEncoding in interface AtmosphereRequest
    
    Overrides:
    
    getCharacterEncoding in class jakarta.servlet.ServletRequestWrapper
  - getContentLength
```
public int getContentLength()
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    getContentLength in interface jakarta.servlet.ServletRequest
    
    Specified by:
    
    getContentLength in interface AtmosphereRequest
    
    Overrides:
    
    getContentLength in class jakarta.servlet.ServletRequestWrapper
  - uuid
```
public java.lang.String uuid()
```
    Description copied from interface: AtmosphereRequest
    
    Return the underlying AtmosphereResource.uuid(). May return "0" if no AtmosphereResource is associated with this object.
    
    Specified by:
    
    uuid in interface AtmosphereRequest
    
    Returns:
    
    the underlying AtmosphereResource.uuid()
  - destroy
```
public void destroy()
```
    Specified by:
    
    destroy in interface AtmosphereRequest
  - destroy
```
public void destroy(boolean force)
```
    Specified by:
    
    destroy in interface AtmosphereRequest
  - setRequest
```
public void setRequest(jakarta.servlet.ServletRequest request)
```
    Description copied from interface: AtmosphereRequest
    
    Specified by:
    
    setRequest in interface AtmosphereRequest
    
    Overrides:
    
    setRequest in class jakarta.servlet.ServletRequestWrapper
  - newInstance
```
public static final AtmosphereRequest newInstance()
```
    Create an instance of this class without an associated HttpServletRequest.
    
    Returns:
    
    an instance of this class without an associated HttpServletRequest
  - wrap
```
public static final AtmosphereRequest wrap(jakarta.servlet.http.HttpServletRequest request)
```
    Wrap an HttpServletRequest.
    
    Parameters:
    
    request - HttpServletRequest
    
    Returns:
    
    an AtmosphereRequest
  - cloneRequest
```
public static final AtmosphereRequest cloneRequest(jakarta.servlet.http.HttpServletRequest request,
                                                   boolean loadInMemory,
                                                   boolean copySession,
                                                   boolean isDestroyable,
                                                   boolean createSession)
```
    Copy the HttpServletRequest content inside an AtmosphereRequest. By default the returned AtmosphereRequest is not destroyable.
    
    Parameters:
    
    request - HttpServletRequest
    
    Returns:
    
    an AtmosphereRequest
  - toString
```
public java.lang.String toString()
```
    Specified by:
    
    toString in interface AtmosphereRequest
    
    Overrides:
    
    toString in class java.lang.Object
  - requestURL
```
public java.lang.String requestURL()
```
    Specified by:
    
    requestURL in interface AtmosphereRequest

Class AtmosphereRequestImpl

Nested Class Summary

Nested classes/interfaces inherited from interface org.atmosphere.cpr.AtmosphereRequest

Field Summary

Fields inherited from interface jakarta.servlet.http.HttpServletRequest

Method Summary

Methods inherited from class jakarta.servlet.http.HttpServletRequestWrapper

Methods inherited from class jakarta.servlet.ServletRequestWrapper

Methods inherited from class java.lang.Object

Methods inherited from interface jakarta.servlet.http.HttpServletRequest

Methods inherited from interface jakarta.servlet.ServletRequest

Method Detail

destroyed

destroyable

getPathInfo

getPathTranslated

getQueryString

getRemoteUser

getRequestedSessionId

getMethod

getPart

getParts

getContentType

getDispatcherType

getServletPath

getRequestURI

getRequestURL

getHeaders

getIntHeader

getHeaderNames

authenticate

getAuthType

getContextPath

getCookies

getDateHeader

getHeader

wrappedRequest

getHeader

getParameter

getParameterMap

getParameterNames

getParameterValues

getProtocol

getInputStream

getReader

getRealPath

headers

header

queryString

headersMap

queryStringsMap

method

contentType

body

body

body

body

body

servletPath

contextPath

requestURI

setAttribute

setCharacterEncoding

startAsync

startAsync

getAsyncContext

getAttribute

removeAttribute

attributes

getSession

getSession

getUserPrincipal

isRequestedSessionIdFromCookie

isRequestedSessionIdFromUrl

isRequestedSessionIdFromURL

isRequestedSessionIdValid

isUserInRole

login

logout

getRemoteAddr