Package org.atmosphere.cpr

Interface AtmosphereRequest

All Superinterfaces:

HttpServletRequest, ServletRequest

All Known Implementing Classes:

AtmosphereRequestImpl

public interface AtmosphereRequest
extends 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.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	AtmosphereRequest.Builder
static final class	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
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.
String	getHeader(String s, boolean checkCase)
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	isDestroyable()	Check if this object can be destroyed.
AtmosphereRequest.LocalAttributes	localAttributes()	Return a subset of the attributes set on this AtmosphereRequest, set locally by the framework or by an application.
AtmosphereRequest	method(String m)
AtmosphereRequest	pathInfo(String pathInfo)
AtmosphereRequest	queryString(String qs)	Set the query string.
Map<String,String[]>	queryStringsMap()
AtmosphereRequest	requestURI(String requestURI)
String	requestURL()
AtmosphereResource	resource()	The AtmosphereResource associated with this request.
AtmosphereRequest	servletPath(String servletPath)
String	uuid()	Return the underlying AtmosphereResource.uuid().
HttpServletRequest	wrappedRequest()

Methods inherited from interface jakarta.servlet.http.HttpServletRequest

authenticate, changeSessionId, getAuthType, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getHttpServletMapping, getIntHeader, getMethod, getPart, getParts, getPathInfo, getPathTranslated, getQueryString, getRemoteUser, getRequestedSessionId, getRequestURI, getRequestURL, getServletPath, getSession, getSession, getTrailerFields, getUserPrincipal, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isTrailerFieldsReady, isUserInRole, login, logout, newPushBuilder, upgrade

Methods inherited from interface jakarta.servlet.ServletRequest

getAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentLengthLong, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getScheme, getServerName, getServerPort, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, removeAttribute, setAttribute, setCharacterEncoding, startAsync, startAsync

Method Details

destroyed

boolean destroyed()

destroyable

AtmosphereRequest destroyable(boolean destroyable)

wrappedRequest

HttpServletRequest wrappedRequest()

getHeader

String getHeader(String s,
 boolean checkCase)

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)

resource

AtmosphereResource resource()

The AtmosphereResource associated with this request.

Returns:

an AtmosphereResource

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()

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

pathInfo

AtmosphereRequest pathInfo(String pathInfo)

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

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)

requestURL

String requestURL()