Package org.atmosphere.cpr

Class AtmosphereRequestImpl

java.lang.Object

jakarta.servlet.ServletRequestWrapper

jakarta.servlet.http.HttpServletRequestWrapper

org.atmosphere.cpr.AtmosphereRequestImpl

All Implemented Interfaces:

HttpServletRequest, ServletRequest, AtmosphereRequest

public class AtmosphereRequestImpl
extends 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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AtmosphereRequestImpl.Body
static final class	AtmosphereRequestImpl.Builder
static final class	AtmosphereRequestImpl.LazyComputation
static class	AtmosphereRequestImpl.NoOpsRequest	Deprecated. Use NoOpsRequest directly instead.

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

Modifier and Type	Method	Description
boolean	authenticate(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)
static AtmosphereRequest	cloneRequest(HttpServletRequest request, boolean loadInMemory, boolean copySession, boolean isDestroyable, boolean createSession)	Copy the HttpServletRequest content inside an AtmosphereRequest.
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.
AsyncContext	getAsyncContext()
Object	getAttribute(String s)
Enumeration<String>	getAttributeNames()
String	getAuthType()
String	getCharacterEncoding()
int	getContentLength()
String	getContentType()
String	getContextPath()
Cookie[]	getCookies()
long	getDateHeader(String name)
DispatcherType	getDispatcherType()
String	getHeader(String s)
String	getHeader(String s, boolean checkCase)
Enumeration<String>	getHeaderNames()
Enumeration<String>	getHeaders(String name)
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)
Part	getPart(String name)
Collection<Part>	getParts()
String	getPathInfo()
String	getPathTranslated()
String	getProtocol()
String	getQueryString()
BufferedReader	getReader()
String	getRealPath(String path)
String	getRemoteAddr()
String	getRemoteHost()
int	getRemotePort()
String	getRemoteUser()
RequestDispatcher	getRequestDispatcher(String path)
String	getRequestedSessionId()
String	getRequestURI()
StringBuffer	getRequestURL()
String	getScheme()
String	getServerName()
int	getServerPort()
ServletContext	getServletContext()
String	getServletPath()
HttpSession	getSession()
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()	Check 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)
static AtmosphereRequest	newInstance()	Create an instance of this class without an associated HttpServletRequest.
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(ServletRequest request)
AsyncContext	startAsync()
AsyncContext	startAsync(ServletRequest request, ServletResponse response)
String	toString()
String	uuid()	Return the underlying AtmosphereResource.uuid().
static AtmosphereRequest	wrap(HttpServletRequest request)	Wrap an HttpServletRequest.
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 Details

destroyed

public boolean destroyed()

Specified by:

destroyed in interface AtmosphereRequest

destroyable

public AtmosphereRequest destroyable(boolean destroyable)

Specified by:

destroyable in interface AtmosphereRequest

getPathInfo

public String getPathInfo()

Specified by:

getPathInfo in interface HttpServletRequest

Overrides:

getPathInfo in class HttpServletRequestWrapper

getPathTranslated

public String getPathTranslated()

Specified by:

getPathTranslated in interface HttpServletRequest

Overrides:

getPathTranslated in class HttpServletRequestWrapper

getQueryString

public String getQueryString()

Specified by:

getQueryString in interface HttpServletRequest

Overrides:

getQueryString in class HttpServletRequestWrapper

getRemoteUser

public String getRemoteUser()

Specified by:

getRemoteUser in interface HttpServletRequest

Overrides:

getRemoteUser in class HttpServletRequestWrapper

getRequestedSessionId

public String getRequestedSessionId()

Specified by:

getRequestedSessionId in interface HttpServletRequest

Overrides:

getRequestedSessionId in class HttpServletRequestWrapper

getMethod

public String getMethod()

Specified by:

getMethod in interface HttpServletRequest

Overrides:

getMethod in class HttpServletRequestWrapper

getPart

public Part getPart(String name)
             throws IOException,
ServletException

Specified by:

getPart in interface HttpServletRequest

Overrides:

getPart in class HttpServletRequestWrapper

Throws:

IOException

ServletException

getParts

public Collection<Part> getParts()
                          throws IOException,
ServletException

Specified by:

getParts in interface HttpServletRequest

Overrides:

getParts in class HttpServletRequestWrapper

Throws:

IOException

ServletException

getContentType

public String getContentType()

Specified by:

getContentType in interface ServletRequest

Overrides:

getContentType in class ServletRequestWrapper

getDispatcherType

public DispatcherType getDispatcherType()

Specified by:

getDispatcherType in interface ServletRequest

Overrides:

getDispatcherType in class ServletRequestWrapper

getServletPath

public String getServletPath()

Specified by:

getServletPath in interface HttpServletRequest

Overrides:

getServletPath in class HttpServletRequestWrapper

getRequestURI

public String getRequestURI()

Specified by:

getRequestURI in interface HttpServletRequest

Overrides:

getRequestURI in class HttpServletRequestWrapper

getRequestURL

public StringBuffer getRequestURL()

Specified by:

getRequestURL in interface HttpServletRequest

Overrides:

getRequestURL in class HttpServletRequestWrapper

getHeaders

public Enumeration<String> getHeaders(String name)

Specified by:

getHeaders in interface HttpServletRequest

Overrides:

getHeaders in class HttpServletRequestWrapper

getIntHeader

public int getIntHeader(String name)

Specified by:

getIntHeader in interface HttpServletRequest

Overrides:

getIntHeader in class HttpServletRequestWrapper

getHeaderNames

public Enumeration<String> getHeaderNames()

Specified by:

getHeaderNames in interface HttpServletRequest

Overrides:

getHeaderNames in class HttpServletRequestWrapper

authenticate

public boolean authenticate(HttpServletResponse response)
                     throws IOException,
ServletException

Specified by:

authenticate in interface HttpServletRequest

Overrides:

authenticate in class HttpServletRequestWrapper

Throws:

IOException

ServletException

getAuthType

public String getAuthType()

Specified by:

getAuthType in interface HttpServletRequest

Overrides:

getAuthType in class HttpServletRequestWrapper

getContextPath

public String getContextPath()

Specified by:

getContextPath in interface HttpServletRequest

Overrides:

getContextPath in class HttpServletRequestWrapper

getCookies

public Cookie[] getCookies()

Specified by:

getCookies in interface HttpServletRequest

Overrides:

getCookies in class HttpServletRequestWrapper

getDateHeader

public long getDateHeader(String name)

Specified by:

getDateHeader in interface HttpServletRequest

Overrides:

getDateHeader in class HttpServletRequestWrapper

getHeader

public String getHeader(String s)

Specified by:

getHeader in interface HttpServletRequest

Overrides:

getHeader in class HttpServletRequestWrapper

wrappedRequest

public HttpServletRequest wrappedRequest()

Specified by:

wrappedRequest in interface AtmosphereRequest

getHeader

public String getHeader(String s,
 boolean checkCase)

Specified by:

getHeader in interface AtmosphereRequest

getParameter

public String getParameter(String s)

Specified by:

getParameter in interface ServletRequest

Overrides:

getParameter in class ServletRequestWrapper

getParameterMap

public Map<String,String[]> getParameterMap()

Specified by:

getParameterMap in interface ServletRequest

Overrides:

getParameterMap in class ServletRequestWrapper

getParameterNames

public Enumeration<String> getParameterNames()

Specified by:

getParameterNames in interface ServletRequest

Overrides:

getParameterNames in class ServletRequestWrapper

getParameterValues

public String[] getParameterValues(String s)

Specified by:

getParameterValues in interface ServletRequest

Overrides:

getParameterValues in class ServletRequestWrapper

getProtocol

public String getProtocol()

Specified by:

getProtocol in interface ServletRequest

Overrides:

getProtocol in class ServletRequestWrapper

getInputStream

public ServletInputStream getInputStream()
                                  throws IOException

Specified by:

getInputStream in interface ServletRequest

Overrides:

getInputStream in class ServletRequestWrapper

Throws:

IOException

getReader

public BufferedReader getReader()
                         throws IOException

Specified by:

getReader in interface ServletRequest

Overrides:

getReader in class ServletRequestWrapper

Throws:

IOException

getRealPath

public String getRealPath(String path)

Specified by:

getRealPath in interface ServletRequest

Overrides:

getRealPath in class ServletRequestWrapper

headers

public AtmosphereRequest headers(Map<String,String> headers)

Description copied from interface: AtmosphereRequest

Add all headers contained within the Map.

Specified by:

headers in interface AtmosphereRequest

Parameters:

headers -

Returns:

this;

header

public AtmosphereRequest header(String name,
 String value)

Description copied from interface: AtmosphereRequest

Add a header.

Specified by:

header in interface AtmosphereRequest

Parameters:

name -

value -

Returns:

this

queryString

public AtmosphereRequest queryString(String qs)

Description copied from interface: AtmosphereRequest

Set the query string.

Specified by:

queryString in interface AtmosphereRequest

Parameters:

qs -

Returns:

this

headersMap

public Map<String,String> headersMap()

Specified by:

headersMap in interface AtmosphereRequest

queryStringsMap

public Map<String,String[]> queryStringsMap()

Specified by:

queryStringsMap in interface AtmosphereRequest

method

public AtmosphereRequest method(String m)

Specified by:

method in interface AtmosphereRequest

contentType

public AtmosphereRequest contentType(String m)

Specified by:

contentType in interface AtmosphereRequest

body

public AtmosphereRequest body(String body)

Specified by:

body in interface AtmosphereRequest

body

public AtmosphereRequest body(byte[] bytes)

Specified by:

body in interface AtmosphereRequest

body

public AtmosphereRequest body(InputStream body)

Specified by:

body in interface AtmosphereRequest

body

public AtmosphereRequest body(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(String servletPath)

Specified by:

servletPath in interface AtmosphereRequest

contextPath

public AtmosphereRequest contextPath(String contextPath)

Specified by:

contextPath in interface AtmosphereRequest

requestURI

public AtmosphereRequest requestURI(String requestURI)

Specified by:

requestURI in interface AtmosphereRequest

setAttribute

public void setAttribute(String s,
 Object o)

Specified by:

setAttribute in interface ServletRequest

Overrides:

setAttribute in class ServletRequestWrapper

setCharacterEncoding

public void setCharacterEncoding(String env)
                          throws UnsupportedEncodingException

Specified by:

setCharacterEncoding in interface ServletRequest

Overrides:

setCharacterEncoding in class ServletRequestWrapper

Throws:

UnsupportedEncodingException

startAsync

public AsyncContext startAsync()

Specified by:

startAsync in interface ServletRequest

Overrides:

startAsync in class ServletRequestWrapper

startAsync

public AsyncContext startAsync(ServletRequest request,
 ServletResponse response)

Specified by:

startAsync in interface ServletRequest

Overrides:

startAsync in class ServletRequestWrapper

getAsyncContext

public AsyncContext getAsyncContext()

Specified by:

getAsyncContext in interface ServletRequest

Overrides:

getAsyncContext in class ServletRequestWrapper

getAttribute

public Object getAttribute(String s)

Specified by:

getAttribute in interface ServletRequest

Overrides:

getAttribute in class ServletRequestWrapper

removeAttribute

public void removeAttribute(String name)

Specified by:

removeAttribute in interface ServletRequest

Overrides:

removeAttribute in class ServletRequestWrapper

getSession

public HttpSession getSession()

Specified by:

getSession in interface HttpServletRequest

Overrides:

getSession in class HttpServletRequestWrapper

getSession

public HttpSession getSession(boolean create)

Specified by:

getSession in interface HttpServletRequest

Overrides:

getSession in class HttpServletRequestWrapper

getUserPrincipal

public Principal getUserPrincipal()

Specified by:

getUserPrincipal in interface HttpServletRequest

Overrides:

getUserPrincipal in class HttpServletRequestWrapper

isRequestedSessionIdFromCookie

public boolean isRequestedSessionIdFromCookie()

Specified by:

isRequestedSessionIdFromCookie in interface HttpServletRequest

Overrides:

isRequestedSessionIdFromCookie in class HttpServletRequestWrapper

isRequestedSessionIdFromUrl

public boolean isRequestedSessionIdFromUrl()

Specified by:

isRequestedSessionIdFromUrl in interface HttpServletRequest

Overrides:

isRequestedSessionIdFromUrl in class HttpServletRequestWrapper

isRequestedSessionIdFromURL

public boolean isRequestedSessionIdFromURL()

Specified by:

isRequestedSessionIdFromURL in interface HttpServletRequest

Overrides:

isRequestedSessionIdFromURL in class HttpServletRequestWrapper

isRequestedSessionIdValid

public boolean isRequestedSessionIdValid()

Specified by:

isRequestedSessionIdValid in interface HttpServletRequest

Overrides:

isRequestedSessionIdValid in class HttpServletRequestWrapper

isUserInRole

public boolean isUserInRole(String role)

Specified by:

isUserInRole in interface HttpServletRequest

Overrides:

isUserInRole in class HttpServletRequestWrapper

login

public void login(String username,
 String password)
           throws ServletException

Specified by:

login in interface HttpServletRequest

Overrides:

login in class HttpServletRequestWrapper

Throws:

ServletException

logout

public void logout()
            throws ServletException

Specified by:

logout in interface HttpServletRequest

Overrides:

logout in class HttpServletRequestWrapper

Throws:

ServletException

getRemoteAddr

public String getRemoteAddr()

Specified by:

getRemoteAddr in interface ServletRequest

Overrides:

getRemoteAddr in class ServletRequestWrapper

getRemoteHost

public String getRemoteHost()

Specified by:

getRemoteHost in interface ServletRequest

Overrides:

getRemoteHost in class ServletRequestWrapper

getRemotePort

public int getRemotePort()

Specified by:

getRemotePort in interface ServletRequest

Overrides:

getRemotePort in class ServletRequestWrapper

getRequestDispatcher

public RequestDispatcher getRequestDispatcher(String path)

Specified by:

getRequestDispatcher in interface ServletRequest

Overrides:

getRequestDispatcher in class ServletRequestWrapper

getScheme

public String getScheme()

Specified by:

getScheme in interface ServletRequest

Overrides:

getScheme in class ServletRequestWrapper

getServerName

public String getServerName()

Specified by:

getServerName in interface ServletRequest

Overrides:

getServerName in class ServletRequestWrapper

getServerPort

public int getServerPort()

Specified by:

getServerPort in interface ServletRequest

Overrides:

getServerPort in class ServletRequestWrapper

getServletContext

public ServletContext getServletContext()

Specified by:

getServletContext in interface ServletRequest

Overrides:

getServletContext in class ServletRequestWrapper

isAsyncStarted

public boolean isAsyncStarted()

Specified by:

isAsyncStarted in interface ServletRequest

Overrides:

isAsyncStarted in class ServletRequestWrapper

isAsyncSupported

public boolean isAsyncSupported()

Specified by:

isAsyncSupported in interface ServletRequest

Overrides:

isAsyncSupported in class ServletRequestWrapper

isSecure

public boolean isSecure()

Specified by:

isSecure in interface ServletRequest

Overrides:

isSecure in class ServletRequestWrapper

getLocalName

public String getLocalName()

Specified by:

getLocalName in interface ServletRequest

Overrides:

getLocalName in class ServletRequestWrapper

getLocalPort

public int getLocalPort()

Specified by:

getLocalPort in interface ServletRequest

Overrides:

getLocalPort in class ServletRequestWrapper

getLocalAddr

public String getLocalAddr()

Specified by:

getLocalAddr in interface ServletRequest

Overrides:

getLocalAddr in class ServletRequestWrapper

getLocale

public Locale getLocale()

Specified by:

getLocale in interface ServletRequest

Overrides:

getLocale in class 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 Enumeration<Locale> getLocales()

Specified by:

getLocales in interface ServletRequest

Overrides:

getLocales in class 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

Check if this object can be destroyed. Default is true.

Specified by:

isDestroyable in interface AtmosphereRequest

pathInfo

public AtmosphereRequest pathInfo(String pathInfo)

Specified by:

pathInfo in interface AtmosphereRequest

getAttributeNames

public Enumeration<String> getAttributeNames()

Specified by:

getAttributeNames in interface ServletRequest

Overrides:

getAttributeNames in class 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 String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface ServletRequest

Overrides:

getCharacterEncoding in class ServletRequestWrapper

getContentLength

public int getContentLength()

Specified by:

getContentLength in interface ServletRequest

Overrides:

getContentLength in class ServletRequestWrapper

uuid

public 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(ServletRequest request)

Overrides:

setRequest in class ServletRequestWrapper

newInstance

public static 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 AtmosphereRequest wrap(HttpServletRequest request)

Wrap an HttpServletRequest.

Parameters:

request - HttpServletRequest

Returns:

an AtmosphereRequest

cloneRequest

public static AtmosphereRequest cloneRequest(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 String toString()

Overrides:

toString in class Object

requestURL

public String requestURL()

Specified by:

requestURL in interface AtmosphereRequest