Package org.atmosphere.cpr
Class AtmosphereRequestImpl
java.lang.Object
javax.servlet.ServletRequestWrapper
javax.servlet.http.HttpServletRequestWrapper
org.atmosphere.cpr.AtmosphereRequestImpl
- All Implemented Interfaces:
javax.servlet.http.HttpServletRequest,javax.servlet.ServletRequest,AtmosphereRequest
public class AtmosphereRequestImpl
extends javax.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 ClassesModifier and TypeClassDescriptionstatic final classstatic final classstatic final classstatic final classNested classes/interfaces inherited from interface org.atmosphere.cpr.AtmosphereRequest
AtmosphereRequest.LocalAttributes -
Field Summary
Fields inherited from interface javax.servlet.http.HttpServletRequest
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH -
Method Summary
Modifier and TypeMethodDescriptionReturn the locally added attributes.booleanauthenticate(javax.servlet.http.HttpServletResponse response) body()Return the request's body.body(byte[] bytes) body(InputStream body) static AtmosphereRequestcloneRequest(javax.servlet.http.HttpServletRequest request, boolean loadInMemory, boolean copySession, boolean isDestroyable, boolean createSession) Copy the HttpServletRequest content inside an AtmosphereRequest.contextPath(String contextPath) voiddestroy()voiddestroy(boolean force) destroyable(boolean destroyable) booleanbooleanDispatch the request asynchronously to container.javax.servlet.AsyncContextintjavax.servlet.http.Cookie[]longgetDateHeader(String name) javax.servlet.DispatcherTypegetHeaders(String name) javax.servlet.ServletInputStreamintgetIntHeader(String name) intString[]javax.servlet.http.PartCollection<javax.servlet.http.Part> getParts()getRealPath(String path) intjavax.servlet.RequestDispatchergetRequestDispatcher(String path) intjavax.servlet.ServletContextjavax.servlet.http.HttpSessionjavax.servlet.http.HttpSessiongetSession(boolean create) Add a header.Add all headers contained within the Map.booleanbooleanbooleanCjeck if this object can be destroyed.booleanbooleanbooleanbooleanbooleanisSecure()booleanisUserInRole(String role) Return a subset of the attributes set on this AtmosphereRequest, set locally by the framework or by an application.voidvoidlogout()static AtmosphereRequestCreate an instance of this class without an associatedHttpServletRequest.queryString(String qs) Set the query string.voidremoveAttribute(String name) requestURI(String requestURI) resource()TheAtmosphereResourceassociated with this request.servletPath(String servletPath) voidsetAttribute(String s, Object o) voidvoidsetRequest(javax.servlet.ServletRequest request) javax.servlet.AsyncContextjavax.servlet.AsyncContextstartAsync(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response) toString()uuid()Return the underlyingAtmosphereResource.uuid().static AtmosphereRequestwrap(javax.servlet.http.HttpServletRequest request) Wrap anHttpServletRequest.javax.servlet.http.HttpServletRequestMethods inherited from class javax.servlet.ServletRequestWrapper
getRequest, isWrapperFor, isWrapperFor
-
Method Details
-
destroyed
public boolean destroyed()- Specified by:
destroyedin interfaceAtmosphereRequest
-
destroyable
- Specified by:
destroyablein interfaceAtmosphereRequest
-
getPathInfo
Description copied from interface:AtmosphereRequest- Specified by:
getPathInfoin interfaceAtmosphereRequest- Specified by:
getPathInfoin interfacejavax.servlet.http.HttpServletRequest- Overrides:
getPathInfoin classjavax.servlet.http.HttpServletRequestWrapper
-
getPathTranslated
Description copied from interface:AtmosphereRequest- Specified by:
getPathTranslatedin interfaceAtmosphereRequest- Specified by:
getPathTranslatedin interfacejavax.servlet.http.HttpServletRequest- Overrides:
getPathTranslatedin classjavax.servlet.http.HttpServletRequestWrapper
-
getQueryString
Description copied from interface:AtmosphereRequest- Specified by:
getQueryStringin interfaceAtmosphereRequest- Specified by:
getQueryStringin interfacejavax.servlet.http.HttpServletRequest- Overrides:
getQueryStringin classjavax.servlet.http.HttpServletRequestWrapper
-
getRemoteUser
Description copied from interface:AtmosphereRequest- Specified by:
getRemoteUserin interfaceAtmosphereRequest- Specified by:
getRemoteUserin interfacejavax.servlet.http.HttpServletRequest- Overrides:
getRemoteUserin classjavax.servlet.http.HttpServletRequestWrapper
-
getRequestedSessionId
Description copied from interface:AtmosphereRequest- Specified by:
getRequestedSessionIdin interfaceAtmosphereRequest- Specified by:
getRequestedSessionIdin interfacejavax.servlet.http.HttpServletRequest- Overrides:
getRequestedSessionIdin classjavax.servlet.http.HttpServletRequestWrapper
-
getMethod
Description copied from interface:AtmosphereRequest- Specified by:
getMethodin interfaceAtmosphereRequest- Specified by:
getMethodin interfacejavax.servlet.http.HttpServletRequest- Overrides:
getMethodin classjavax.servlet.http.HttpServletRequestWrapper
-
getPart
public javax.servlet.http.Part getPart(String name) throws IOException, javax.servlet.ServletException Description copied from interface:AtmosphereRequest- Specified by:
getPartin interfaceAtmosphereRequest- Specified by:
getPartin interfacejavax.servlet.http.HttpServletRequest- Overrides:
getPartin classjavax.servlet.http.HttpServletRequestWrapper- Throws:
IOExceptionjavax.servlet.ServletException
-
getParts
public Collection<javax.servlet.http.Part> getParts() throws IOException, javax.servlet.ServletExceptionDescription copied from interface:AtmosphereRequest- Specified by:
getPartsin interfaceAtmosphereRequest- Specified by:
getPartsin interfacejavax.servlet.http.HttpServletRequest- Overrides:
getPartsin classjavax.servlet.http.HttpServletRequestWrapper- Throws:
IOExceptionjavax.servlet.ServletException
-
getContentType
Description copied from interface:AtmosphereRequest- Specified by:
getContentTypein interfaceAtmosphereRequest- Specified by:
getContentTypein interfacejavax.servlet.ServletRequest- Overrides:
getContentTypein classjavax.servlet.ServletRequestWrapper
-
getDispatcherType
public javax.servlet.DispatcherType getDispatcherType()Description copied from interface:AtmosphereRequest- Specified by:
getDispatcherTypein interfaceAtmosphereRequest- Specified by:
getDispatcherTypein interfacejavax.servlet.ServletRequest- Overrides:
getDispatcherTypein classjavax.servlet.ServletRequestWrapper
-
getServletPath
Description copied from interface:AtmosphereRequest- Specified by:
getServletPathin interfaceAtmosphereRequest- Specified by:
getServletPathin interfacejavax.servlet.http.HttpServletRequest- Overrides:
getServletPathin classjavax.servlet.http.HttpServletRequestWrapper
-
getRequestURI
Description copied from interface:AtmosphereRequest- Specified by:
getRequestURIin interfaceAtmosphereRequest- Specified by:
getRequestURIin interfacejavax.servlet.http.HttpServletRequest- Overrides:
getRequestURIin classjavax.servlet.http.HttpServletRequestWrapper
-
getRequestURL
Description copied from interface:AtmosphereRequest- Specified by:
getRequestURLin interfaceAtmosphereRequest- Specified by:
getRequestURLin interfacejavax.servlet.http.HttpServletRequest- Overrides:
getRequestURLin classjavax.servlet.http.HttpServletRequestWrapper
-
getHeaders
Description copied from interface:AtmosphereRequest- Specified by:
getHeadersin interfaceAtmosphereRequest- Specified by:
getHeadersin interfacejavax.servlet.http.HttpServletRequest- Overrides:
getHeadersin classjavax.servlet.http.HttpServletRequestWrapper
-
getIntHeader
Description copied from interface:AtmosphereRequest- Specified by:
getIntHeaderin interfaceAtmosphereRequest- Specified by:
getIntHeaderin interfacejavax.servlet.http.HttpServletRequest- Overrides:
getIntHeaderin classjavax.servlet.http.HttpServletRequestWrapper
-
getHeaderNames
Description copied from interface:AtmosphereRequest- Specified by:
getHeaderNamesin interfaceAtmosphereRequest- Specified by:
getHeaderNamesin interfacejavax.servlet.http.HttpServletRequest- Overrides:
getHeaderNamesin classjavax.servlet.http.HttpServletRequestWrapper
-
authenticate
public boolean authenticate(javax.servlet.http.HttpServletResponse response) throws IOException, javax.servlet.ServletException Description copied from interface:AtmosphereRequest- Specified by:
authenticatein interfaceAtmosphereRequest- Specified by:
authenticatein interfacejavax.servlet.http.HttpServletRequest- Overrides:
authenticatein classjavax.servlet.http.HttpServletRequestWrapper- Throws:
IOExceptionjavax.servlet.ServletException
-
getAuthType
Description copied from interface:AtmosphereRequest- Specified by:
getAuthTypein interfaceAtmosphereRequest- Specified by:
getAuthTypein interfacejavax.servlet.http.HttpServletRequest- Overrides:
getAuthTypein classjavax.servlet.http.HttpServletRequestWrapper
-
getContextPath
Description copied from interface:AtmosphereRequest- Specified by:
getContextPathin interfaceAtmosphereRequest- Specified by:
getContextPathin interfacejavax.servlet.http.HttpServletRequest- Overrides:
getContextPathin classjavax.servlet.http.HttpServletRequestWrapper
-
getCookies
public javax.servlet.http.Cookie[] getCookies()Description copied from interface:AtmosphereRequest- Specified by:
getCookiesin interfaceAtmosphereRequest- Specified by:
getCookiesin interfacejavax.servlet.http.HttpServletRequest- Overrides:
getCookiesin classjavax.servlet.http.HttpServletRequestWrapper
-
getDateHeader
Description copied from interface:AtmosphereRequest- Specified by:
getDateHeaderin interfaceAtmosphereRequest- Specified by:
getDateHeaderin interfacejavax.servlet.http.HttpServletRequest- Overrides:
getDateHeaderin classjavax.servlet.http.HttpServletRequestWrapper
-
getHeader
Description copied from interface:AtmosphereRequest- Specified by:
getHeaderin interfaceAtmosphereRequest- Specified by:
getHeaderin interfacejavax.servlet.http.HttpServletRequest- Overrides:
getHeaderin classjavax.servlet.http.HttpServletRequestWrapper
-
wrappedRequest
public javax.servlet.http.HttpServletRequest wrappedRequest()- Specified by:
wrappedRequestin interfaceAtmosphereRequest
-
getHeader
- Specified by:
getHeaderin interfaceAtmosphereRequest
-
getParameter
Description copied from interface:AtmosphereRequest- Specified by:
getParameterin interfaceAtmosphereRequest- Specified by:
getParameterin interfacejavax.servlet.ServletRequest- Overrides:
getParameterin classjavax.servlet.ServletRequestWrapper
-
getParameterMap
Description copied from interface:AtmosphereRequest- Specified by:
getParameterMapin interfaceAtmosphereRequest- Specified by:
getParameterMapin interfacejavax.servlet.ServletRequest- Overrides:
getParameterMapin classjavax.servlet.ServletRequestWrapper
-
getParameterNames
Description copied from interface:AtmosphereRequest- Specified by:
getParameterNamesin interfaceAtmosphereRequest- Specified by:
getParameterNamesin interfacejavax.servlet.ServletRequest- Overrides:
getParameterNamesin classjavax.servlet.ServletRequestWrapper
-
getParameterValues
Description copied from interface:AtmosphereRequest- Specified by:
getParameterValuesin interfaceAtmosphereRequest- Specified by:
getParameterValuesin interfacejavax.servlet.ServletRequest- Overrides:
getParameterValuesin classjavax.servlet.ServletRequestWrapper
-
getProtocol
Description copied from interface:AtmosphereRequest- Specified by:
getProtocolin interfaceAtmosphereRequest- Specified by:
getProtocolin interfacejavax.servlet.ServletRequest- Overrides:
getProtocolin classjavax.servlet.ServletRequestWrapper
-
getInputStream
Description copied from interface:AtmosphereRequest- Specified by:
getInputStreamin interfaceAtmosphereRequest- Specified by:
getInputStreamin interfacejavax.servlet.ServletRequest- Overrides:
getInputStreamin classjavax.servlet.ServletRequestWrapper- Throws:
IOException
-
getReader
Description copied from interface:AtmosphereRequest- Specified by:
getReaderin interfaceAtmosphereRequest- Specified by:
getReaderin interfacejavax.servlet.ServletRequest- Overrides:
getReaderin classjavax.servlet.ServletRequestWrapper- Throws:
IOException
-
getRealPath
Description copied from interface:AtmosphereRequest- Specified by:
getRealPathin interfaceAtmosphereRequest- Specified by:
getRealPathin interfacejavax.servlet.ServletRequest- Overrides:
getRealPathin classjavax.servlet.ServletRequestWrapper
-
headers
Description copied from interface:AtmosphereRequestAdd all headers contained within the Map.- Specified by:
headersin interfaceAtmosphereRequest- Parameters:
headers-- Returns:
- this;
-
header
Description copied from interface:AtmosphereRequestAdd a header.- Specified by:
headerin interfaceAtmosphereRequest- Parameters:
name-value-- Returns:
- this
-
queryString
Description copied from interface:AtmosphereRequestSet the query string.- Specified by:
queryStringin interfaceAtmosphereRequest- Parameters:
qs-- Returns:
- this
-
headersMap
- Specified by:
headersMapin interfaceAtmosphereRequest
-
queryStringsMap
- Specified by:
queryStringsMapin interfaceAtmosphereRequest
-
method
- Specified by:
methodin interfaceAtmosphereRequest
-
contentType
- Specified by:
contentTypein interfaceAtmosphereRequest
-
body
- Specified by:
bodyin interfaceAtmosphereRequest
-
body
- Specified by:
bodyin interfaceAtmosphereRequest
-
body
- Specified by:
bodyin interfaceAtmosphereRequest
-
body
- Specified by:
bodyin interfaceAtmosphereRequest
-
body
Description copied from interface:AtmosphereRequestReturn the request's body. This method will return an empty Body if the underlying container or framework is using InputStream or Reader.- Specified by:
bodyin interfaceAtmosphereRequest- Returns:
- the request body;
-
servletPath
- Specified by:
servletPathin interfaceAtmosphereRequest
-
contextPath
- Specified by:
contextPathin interfaceAtmosphereRequest
-
requestURI
- Specified by:
requestURIin interfaceAtmosphereRequest
-
setAttribute
Description copied from interface:AtmosphereRequest- Specified by:
setAttributein interfaceAtmosphereRequest- Specified by:
setAttributein interfacejavax.servlet.ServletRequest- Overrides:
setAttributein classjavax.servlet.ServletRequestWrapper
-
setCharacterEncoding
Description copied from interface:AtmosphereRequest- Specified by:
setCharacterEncodingin interfaceAtmosphereRequest- Specified by:
setCharacterEncodingin interfacejavax.servlet.ServletRequest- Overrides:
setCharacterEncodingin classjavax.servlet.ServletRequestWrapper- Throws:
UnsupportedEncodingException
-
startAsync
public javax.servlet.AsyncContext startAsync()Description copied from interface:AtmosphereRequest- Specified by:
startAsyncin interfaceAtmosphereRequest- Specified by:
startAsyncin interfacejavax.servlet.ServletRequest- Overrides:
startAsyncin classjavax.servlet.ServletRequestWrapper
-
startAsync
public javax.servlet.AsyncContext startAsync(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response) Description copied from interface:AtmosphereRequest- Specified by:
startAsyncin interfaceAtmosphereRequest- Specified by:
startAsyncin interfacejavax.servlet.ServletRequest- Overrides:
startAsyncin classjavax.servlet.ServletRequestWrapper
-
getAsyncContext
public javax.servlet.AsyncContext getAsyncContext()Description copied from interface:AtmosphereRequest- Specified by:
getAsyncContextin interfaceAtmosphereRequest- Specified by:
getAsyncContextin interfacejavax.servlet.ServletRequest- Overrides:
getAsyncContextin classjavax.servlet.ServletRequestWrapper
-
getAttribute
Description copied from interface:AtmosphereRequest- Specified by:
getAttributein interfaceAtmosphereRequest- Specified by:
getAttributein interfacejavax.servlet.ServletRequest- Overrides:
getAttributein classjavax.servlet.ServletRequestWrapper
-
removeAttribute
Description copied from interface:AtmosphereRequest- Specified by:
removeAttributein interfaceAtmosphereRequest- Specified by:
removeAttributein interfacejavax.servlet.ServletRequest- Overrides:
removeAttributein classjavax.servlet.ServletRequestWrapper
-
attributes
Description copied from interface:AtmosphereRequestReturn the locally added attributes.- Specified by:
attributesin interfaceAtmosphereRequest- Returns:
- the locally added attributes
-
getSession
public javax.servlet.http.HttpSession getSession()Description copied from interface:AtmosphereRequest- Specified by:
getSessionin interfaceAtmosphereRequest- Specified by:
getSessionin interfacejavax.servlet.http.HttpServletRequest- Overrides:
getSessionin classjavax.servlet.http.HttpServletRequestWrapper
-
getSession
public javax.servlet.http.HttpSession getSession(boolean create) Description copied from interface:AtmosphereRequest- Specified by:
getSessionin interfaceAtmosphereRequest- Specified by:
getSessionin interfacejavax.servlet.http.HttpServletRequest- Overrides:
getSessionin classjavax.servlet.http.HttpServletRequestWrapper
-
getUserPrincipal
Description copied from interface:AtmosphereRequest- Specified by:
getUserPrincipalin interfaceAtmosphereRequest- Specified by:
getUserPrincipalin interfacejavax.servlet.http.HttpServletRequest- Overrides:
getUserPrincipalin classjavax.servlet.http.HttpServletRequestWrapper
-
isRequestedSessionIdFromCookie
public boolean isRequestedSessionIdFromCookie()Description copied from interface:AtmosphereRequest- Specified by:
isRequestedSessionIdFromCookiein interfaceAtmosphereRequest- Specified by:
isRequestedSessionIdFromCookiein interfacejavax.servlet.http.HttpServletRequest- Overrides:
isRequestedSessionIdFromCookiein classjavax.servlet.http.HttpServletRequestWrapper
-
isRequestedSessionIdFromUrl
public boolean isRequestedSessionIdFromUrl()Description copied from interface:AtmosphereRequest- Specified by:
isRequestedSessionIdFromUrlin interfaceAtmosphereRequest- Specified by:
isRequestedSessionIdFromUrlin interfacejavax.servlet.http.HttpServletRequest- Overrides:
isRequestedSessionIdFromUrlin classjavax.servlet.http.HttpServletRequestWrapper
-
isRequestedSessionIdFromURL
public boolean isRequestedSessionIdFromURL()Description copied from interface:AtmosphereRequest- Specified by:
isRequestedSessionIdFromURLin interfaceAtmosphereRequest- Specified by:
isRequestedSessionIdFromURLin interfacejavax.servlet.http.HttpServletRequest- Overrides:
isRequestedSessionIdFromURLin classjavax.servlet.http.HttpServletRequestWrapper
-
isRequestedSessionIdValid
public boolean isRequestedSessionIdValid()Description copied from interface:AtmosphereRequest- Specified by:
isRequestedSessionIdValidin interfaceAtmosphereRequest- Specified by:
isRequestedSessionIdValidin interfacejavax.servlet.http.HttpServletRequest- Overrides:
isRequestedSessionIdValidin classjavax.servlet.http.HttpServletRequestWrapper
-
isUserInRole
Description copied from interface:AtmosphereRequest- Specified by:
isUserInRolein interfaceAtmosphereRequest- Specified by:
isUserInRolein interfacejavax.servlet.http.HttpServletRequest- Overrides:
isUserInRolein classjavax.servlet.http.HttpServletRequestWrapper
-
login
Description copied from interface:AtmosphereRequest- Specified by:
loginin interfaceAtmosphereRequest- Specified by:
loginin interfacejavax.servlet.http.HttpServletRequest- Overrides:
loginin classjavax.servlet.http.HttpServletRequestWrapper- Throws:
javax.servlet.ServletException
-
logout
public void logout() throws javax.servlet.ServletExceptionDescription copied from interface:AtmosphereRequest- Specified by:
logoutin interfaceAtmosphereRequest- Specified by:
logoutin interfacejavax.servlet.http.HttpServletRequest- Overrides:
logoutin classjavax.servlet.http.HttpServletRequestWrapper- Throws:
javax.servlet.ServletException
-
getRemoteAddr
Description copied from interface:AtmosphereRequest- Specified by:
getRemoteAddrin interfaceAtmosphereRequest- Specified by:
getRemoteAddrin interfacejavax.servlet.ServletRequest- Overrides:
getRemoteAddrin classjavax.servlet.ServletRequestWrapper
-
getRemoteHost
Description copied from interface:AtmosphereRequest- Specified by:
getRemoteHostin interfaceAtmosphereRequest- Specified by:
getRemoteHostin interfacejavax.servlet.ServletRequest- Overrides:
getRemoteHostin classjavax.servlet.ServletRequestWrapper
-
getRemotePort
public int getRemotePort()Description copied from interface:AtmosphereRequest- Specified by:
getRemotePortin interfaceAtmosphereRequest- Specified by:
getRemotePortin interfacejavax.servlet.ServletRequest- Overrides:
getRemotePortin classjavax.servlet.ServletRequestWrapper
-
getRequestDispatcher
Description copied from interface:AtmosphereRequest- Specified by:
getRequestDispatcherin interfaceAtmosphereRequest- Specified by:
getRequestDispatcherin interfacejavax.servlet.ServletRequest- Overrides:
getRequestDispatcherin classjavax.servlet.ServletRequestWrapper
-
getScheme
Description copied from interface:AtmosphereRequest- Specified by:
getSchemein interfaceAtmosphereRequest- Specified by:
getSchemein interfacejavax.servlet.ServletRequest- Overrides:
getSchemein classjavax.servlet.ServletRequestWrapper
-
getServerName
Description copied from interface:AtmosphereRequest- Specified by:
getServerNamein interfaceAtmosphereRequest- Specified by:
getServerNamein interfacejavax.servlet.ServletRequest- Overrides:
getServerNamein classjavax.servlet.ServletRequestWrapper
-
getServerPort
public int getServerPort()Description copied from interface:AtmosphereRequest- Specified by:
getServerPortin interfaceAtmosphereRequest- Specified by:
getServerPortin interfacejavax.servlet.ServletRequest- Overrides:
getServerPortin classjavax.servlet.ServletRequestWrapper
-
getServletContext
public javax.servlet.ServletContext getServletContext()Description copied from interface:AtmosphereRequest- Specified by:
getServletContextin interfaceAtmosphereRequest- Specified by:
getServletContextin interfacejavax.servlet.ServletRequest- Overrides:
getServletContextin classjavax.servlet.ServletRequestWrapper
-
isAsyncStarted
public boolean isAsyncStarted()Description copied from interface:AtmosphereRequest- Specified by:
isAsyncStartedin interfaceAtmosphereRequest- Specified by:
isAsyncStartedin interfacejavax.servlet.ServletRequest- Overrides:
isAsyncStartedin classjavax.servlet.ServletRequestWrapper
-
isAsyncSupported
public boolean isAsyncSupported()Description copied from interface:AtmosphereRequest- Specified by:
isAsyncSupportedin interfaceAtmosphereRequest- Specified by:
isAsyncSupportedin interfacejavax.servlet.ServletRequest- Overrides:
isAsyncSupportedin classjavax.servlet.ServletRequestWrapper
-
isSecure
public boolean isSecure()Description copied from interface:AtmosphereRequest- Specified by:
isSecurein interfaceAtmosphereRequest- Specified by:
isSecurein interfacejavax.servlet.ServletRequest- Overrides:
isSecurein classjavax.servlet.ServletRequestWrapper
-
getLocalName
Description copied from interface:AtmosphereRequest- Specified by:
getLocalNamein interfaceAtmosphereRequest- Specified by:
getLocalNamein interfacejavax.servlet.ServletRequest- Overrides:
getLocalNamein classjavax.servlet.ServletRequestWrapper
-
getLocalPort
public int getLocalPort()Description copied from interface:AtmosphereRequest- Specified by:
getLocalPortin interfaceAtmosphereRequest- Specified by:
getLocalPortin interfacejavax.servlet.ServletRequest- Overrides:
getLocalPortin classjavax.servlet.ServletRequestWrapper
-
getLocalAddr
Description copied from interface:AtmosphereRequest- Specified by:
getLocalAddrin interfaceAtmosphereRequest- Specified by:
getLocalAddrin interfacejavax.servlet.ServletRequest- Overrides:
getLocalAddrin classjavax.servlet.ServletRequestWrapper
-
getLocale
Description copied from interface:AtmosphereRequest- Specified by:
getLocalein interfaceAtmosphereRequest- Specified by:
getLocalein interfacejavax.servlet.ServletRequest- Overrides:
getLocalein classjavax.servlet.ServletRequestWrapper
-
resource
Description copied from interface:AtmosphereRequestTheAtmosphereResourceassociated with this request.- Specified by:
resourcein interfaceAtmosphereRequest- Returns:
- an
AtmosphereResource
-
getLocales
Description copied from interface:AtmosphereRequest- Specified by:
getLocalesin interfaceAtmosphereRequest- Specified by:
getLocalesin interfacejavax.servlet.ServletRequest- Overrides:
getLocalesin classjavax.servlet.ServletRequestWrapper
-
dispatchRequestAsynchronously
public boolean dispatchRequestAsynchronously()Description copied from interface:AtmosphereRequestDispatch the request asynchronously to container. The default is false.- Specified by:
dispatchRequestAsynchronouslyin interfaceAtmosphereRequest- Returns:
- true to dispatch the request asynchronously to container.
-
isDestroyable
public boolean isDestroyable()Description copied from interface:AtmosphereRequestCjeck if this object can be destroyed. Default is true.- Specified by:
isDestroyablein interfaceAtmosphereRequest
-
pathInfo
- Specified by:
pathInfoin interfaceAtmosphereRequest
-
getAttributeNames
Description copied from interface:AtmosphereRequest- Specified by:
getAttributeNamesin interfaceAtmosphereRequest- Specified by:
getAttributeNamesin interfacejavax.servlet.ServletRequest- Overrides:
getAttributeNamesin classjavax.servlet.ServletRequestWrapper
-
localAttributes
Description copied from interface:AtmosphereRequestReturn 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:
localAttributesin interfaceAtmosphereRequest- Returns:
- a
-
getCharacterEncoding
Description copied from interface:AtmosphereRequest- Specified by:
getCharacterEncodingin interfaceAtmosphereRequest- Specified by:
getCharacterEncodingin interfacejavax.servlet.ServletRequest- Overrides:
getCharacterEncodingin classjavax.servlet.ServletRequestWrapper
-
getContentLength
public int getContentLength()Description copied from interface:AtmosphereRequest- Specified by:
getContentLengthin interfaceAtmosphereRequest- Specified by:
getContentLengthin interfacejavax.servlet.ServletRequest- Overrides:
getContentLengthin classjavax.servlet.ServletRequestWrapper
-
uuid
Description copied from interface:AtmosphereRequestReturn the underlyingAtmosphereResource.uuid(). May return "0" if noAtmosphereResourceis associated with this object.- Specified by:
uuidin interfaceAtmosphereRequest- Returns:
- the underlying
AtmosphereResource.uuid()
-
destroy
public void destroy()- Specified by:
destroyin interfaceAtmosphereRequest
-
destroy
public void destroy(boolean force) - Specified by:
destroyin interfaceAtmosphereRequest
-
setRequest
public void setRequest(javax.servlet.ServletRequest request) Description copied from interface:AtmosphereRequest- Specified by:
setRequestin interfaceAtmosphereRequest- Overrides:
setRequestin classjavax.servlet.ServletRequestWrapper
-
newInstance
Create an instance of this class without an associatedHttpServletRequest.- Returns:
- an instance of this class without an associated
HttpServletRequest
-
wrap
Wrap anHttpServletRequest.- Parameters:
request-HttpServletRequest- Returns:
- an
AtmosphereRequest
-
cloneRequest
public static 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
- Specified by:
toStringin interfaceAtmosphereRequest- Overrides:
toStringin classObject
-
requestURL
- Specified by:
requestURLin interfaceAtmosphereRequest
-