AtmosphereRequest (atmosphere-runtime 2.4.1.3 API)

All Superinterfaces:

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

All Known Implementing Classes:

AtmosphereRequestImpl
```
public interface AtmosphereRequest
extends javax.servlet.http.HttpServletRequest
```
An Atmosphere request representation. An AtmosphereRequest is a two-way communication channel between the client and the server. If the AtmosphereRequestImpl.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 Interface and Description

static interface AtmosphereRequest.Builder

static class AtmosphereRequest.LocalAttributes

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`AtmosphereRequest.Builder`
`static class`	`AtmosphereRequest.LocalAttributes`

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

Method Summary

Methods
Modifier and Type	Method and Description
`AtmosphereRequest.LocalAttributes`	`attributes()` Deprecated. Use `localAttributes()`
`boolean`	`authenticate(javax.servlet.http.HttpServletResponse response)`
`AtmosphereRequestImpl.Body`	`body()` Return the request's body.
`AtmosphereRequest`	`body(byte[] bytes)`
`AtmosphereRequest`	`body(InputStream body)`
`AtmosphereRequest`	`body(Reader body)`
`AtmosphereRequest`	`body(String body)`
`AtmosphereRequest`	`contentType(String m)`
`AtmosphereRequest`	`contextPath(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()`
`Object`	`getAttribute(String s)`
`Enumeration<String>`	`getAttributeNames()`
`String`	`getAuthType()`
`String`	`getCharacterEncoding()`
`int`	`getContentLength()`
`String`	`getContentType()`
`String`	`getContextPath()`
`javax.servlet.http.Cookie[]`	`getCookies()`
`long`	`getDateHeader(String name)`
`javax.servlet.DispatcherType`	`getDispatcherType()`
`String`	`getHeader(String s)`
`String`	`getHeader(String s, boolean checkCase)`
`Enumeration<String>`	`getHeaderNames()`
`Enumeration`	`getHeaders(String name)`
`javax.servlet.ServletInputStream`	`getInputStream()`
`int`	`getIntHeader(String name)`
`String`	`getLocalAddr()`
`Locale`	`getLocale()`
`Enumeration<Locale>`	`getLocales()`
`String`	`getLocalName()`
`int`	`getLocalPort()`
`String`	`getMethod()`
`String`	`getParameter(String s)`
`Map<String,String[]>`	`getParameterMap()`
`Enumeration<String>`	`getParameterNames()`
`String[]`	`getParameterValues(String s)`
`javax.servlet.http.Part`	`getPart(String name)`
`Collection<javax.servlet.http.Part>`	`getParts()`
`String`	`getPathInfo()`
`String`	`getPathTranslated()`
`String`	`getProtocol()`
`String`	`getQueryString()`
`BufferedReader`	`getReader()`
`String`	`getRealPath(String path)`
`String`	`getRemoteAddr()`
`String`	`getRemoteHost()`
`int`	`getRemotePort()`
`String`	`getRemoteUser()`
`javax.servlet.RequestDispatcher`	`getRequestDispatcher(String path)`
`String`	`getRequestedSessionId()`
`String`	`getRequestURI()`
`StringBuffer`	`getRequestURL()`
`String`	`getScheme()`
`String`	`getServerName()`
`int`	`getServerPort()`
`javax.servlet.ServletContext`	`getServletContext()`
`String`	`getServletPath()`
`javax.servlet.http.HttpSession`	`getSession()`
`javax.servlet.http.HttpSession`	`getSession(boolean create)`
`Principal`	`getUserPrincipal()`
`AtmosphereRequest`	`header(String name, String value)` Add a header.
`AtmosphereRequest`	`headers(Map<String,String> headers)` Add all headers contained within the Map.
`Map<String,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(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(String username, String password)`
`void`	`logout()`
`AtmosphereRequest`	`method(String m)`
`AtmosphereRequest`	`pathInfo(String pathInfo)`
`AtmosphereRequest`	`queryString(String qs)` Set the query string.
`Map<String,String[]>`	`queryStringsMap()`
`void`	`removeAttribute(String name)`
`AtmosphereRequest`	`requestURI(String requestURI)`
`String`	`requestURL()`
`AtmosphereResource`	`resource()` The `AtmosphereResource` associated with this request.
`AtmosphereRequest`	`servletPath(String servletPath)`
`void`	`setAttribute(String s, Object o)`
`void`	`setCharacterEncoding(String env)`
`void`	`setRequest(javax.servlet.ServletRequest request)`
`javax.servlet.AsyncContext`	`startAsync()`
`javax.servlet.AsyncContext`	`startAsync(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response)`
`String`	`toString()`
`String`	`uuid()` Return the underlying `AtmosphereResource.uuid()`.
`javax.servlet.http.HttpServletRequest`	`wrappedRequest()`

Methods inherited from interface javax.servlet.http.HttpServletRequest
changeSessionId, upgrade

Methods inherited from interface javax.servlet.ServletRequest
getContentLengthLong

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

Interface AtmosphereRequest

Nested Class Summary

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletRequest

Method Summary

Methods inherited from interface javax.servlet.http.HttpServletRequest

Methods inherited from interface javax.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

getRemoteHost

getRemotePort

getRequestDispatcher

getScheme