AtmosphereRequest (atmosphere-runtime 2.3.9 API)

java.lang.Object
- javax.servlet.ServletRequestWrapper
- - javax.servlet.http.HttpServletRequestWrapper
  - - org.atmosphere.cpr.AtmosphereRequest

All Implemented Interfaces:

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

Direct Known Subclasses:

AtmosphereRequestImpl
```
public class AtmosphereRequest
extends javax.servlet.http.HttpServletRequestWrapper
```
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 AtmosphereRequest.Body

static class AtmosphereRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`AtmosphereRequest.Body`
`static class`	`AtmosphereRequest.Builder`

Field Summary
- 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 AtmosphereRequest(AtmosphereRequest.Builder b)

Constructors
Modifier	Constructor and Description
`protected`	`AtmosphereRequest(AtmosphereRequest.Builder b)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`java.util.Map<java.lang.String,java.lang.Object>`	`attributes()` Deprecated. Use `localAttributes()`
`boolean`	`authenticate(javax.servlet.http.HttpServletResponse response)`
`AtmosphereRequest.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(javax.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.
`javax.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()`
`javax.servlet.http.Cookie[]`	`getCookies()`
`long`	`getDateHeader(java.lang.String name)`
`javax.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)`
`javax.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)`
`javax.servlet.http.Part`	`getPart(java.lang.String name)`
`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()`
`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()`
`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)`
`java.util.Map<java.lang.String,java.lang.Object>`	`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(javax.servlet.ServletRequest request)`
`javax.servlet.AsyncContext`	`startAsync()`
`javax.servlet.AsyncContext`	`startAsync(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response)`
`java.lang.String`	`toString()`
`java.lang.String`	`uuid()` Return the underlying `AtmosphereResource.uuid()`.
`static AtmosphereRequest`	`wrap(javax.servlet.http.HttpServletRequest request)` Wrap an `HttpServletRequest`.
`javax.servlet.http.HttpServletRequest`	`wrappedRequest()`

Methods inherited from class javax.servlet.ServletRequestWrapper
getRequest, isWrapperFor, isWrapperFor

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

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

Class AtmosphereRequest

Nested Class Summary

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletRequest

Constructor Summary

Method Summary

Methods inherited from class javax.servlet.ServletRequestWrapper

Methods inherited from class java.lang.Object

Constructor Detail

AtmosphereRequest

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

getRemoteHost