public class AtmosphereRequestImpl extends javax.servlet.http.HttpServletRequestWrapper implements AtmosphereRequest
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.
Modifier and Type | Class and Description |
---|---|
static class |
AtmosphereRequestImpl.Body |
static class |
AtmosphereRequestImpl.Builder |
static class |
AtmosphereRequestImpl.LazyComputation |
static class |
AtmosphereRequestImpl.NoOpsRequest |
AtmosphereRequest.LocalAttributes
public boolean destroyed()
destroyed
in interface AtmosphereRequest
public AtmosphereRequest destroyable(boolean destroyable)
destroyable
in interface AtmosphereRequest
public String getPathInfo()
AtmosphereRequest
getPathInfo
in interface javax.servlet.http.HttpServletRequest
getPathInfo
in interface AtmosphereRequest
getPathInfo
in class javax.servlet.http.HttpServletRequestWrapper
public String getPathTranslated()
AtmosphereRequest
getPathTranslated
in interface javax.servlet.http.HttpServletRequest
getPathTranslated
in interface AtmosphereRequest
getPathTranslated
in class javax.servlet.http.HttpServletRequestWrapper
public String getQueryString()
AtmosphereRequest
getQueryString
in interface javax.servlet.http.HttpServletRequest
getQueryString
in interface AtmosphereRequest
getQueryString
in class javax.servlet.http.HttpServletRequestWrapper
public String getRemoteUser()
AtmosphereRequest
getRemoteUser
in interface javax.servlet.http.HttpServletRequest
getRemoteUser
in interface AtmosphereRequest
getRemoteUser
in class javax.servlet.http.HttpServletRequestWrapper
public String getRequestedSessionId()
AtmosphereRequest
getRequestedSessionId
in interface javax.servlet.http.HttpServletRequest
getRequestedSessionId
in interface AtmosphereRequest
getRequestedSessionId
in class javax.servlet.http.HttpServletRequestWrapper
public String getMethod()
AtmosphereRequest
getMethod
in interface javax.servlet.http.HttpServletRequest
getMethod
in interface AtmosphereRequest
getMethod
in class javax.servlet.http.HttpServletRequestWrapper
public javax.servlet.http.Part getPart(String name) throws IOException, javax.servlet.ServletException
AtmosphereRequest
getPart
in interface javax.servlet.http.HttpServletRequest
getPart
in interface AtmosphereRequest
getPart
in class javax.servlet.http.HttpServletRequestWrapper
IOException
javax.servlet.ServletException
public Collection<javax.servlet.http.Part> getParts() throws IOException, javax.servlet.ServletException
AtmosphereRequest
getParts
in interface javax.servlet.http.HttpServletRequest
getParts
in interface AtmosphereRequest
getParts
in class javax.servlet.http.HttpServletRequestWrapper
IOException
javax.servlet.ServletException
public String getContentType()
AtmosphereRequest
getContentType
in interface javax.servlet.ServletRequest
getContentType
in interface AtmosphereRequest
getContentType
in class javax.servlet.ServletRequestWrapper
public javax.servlet.DispatcherType getDispatcherType()
AtmosphereRequest
getDispatcherType
in interface javax.servlet.ServletRequest
getDispatcherType
in interface AtmosphereRequest
getDispatcherType
in class javax.servlet.ServletRequestWrapper
public String getServletPath()
AtmosphereRequest
getServletPath
in interface javax.servlet.http.HttpServletRequest
getServletPath
in interface AtmosphereRequest
getServletPath
in class javax.servlet.http.HttpServletRequestWrapper
public String getRequestURI()
AtmosphereRequest
getRequestURI
in interface javax.servlet.http.HttpServletRequest
getRequestURI
in interface AtmosphereRequest
getRequestURI
in class javax.servlet.http.HttpServletRequestWrapper
public StringBuffer getRequestURL()
AtmosphereRequest
getRequestURL
in interface javax.servlet.http.HttpServletRequest
getRequestURL
in interface AtmosphereRequest
getRequestURL
in class javax.servlet.http.HttpServletRequestWrapper
public Enumeration getHeaders(String name)
AtmosphereRequest
getHeaders
in interface javax.servlet.http.HttpServletRequest
getHeaders
in interface AtmosphereRequest
getHeaders
in class javax.servlet.http.HttpServletRequestWrapper
public int getIntHeader(String name)
AtmosphereRequest
getIntHeader
in interface javax.servlet.http.HttpServletRequest
getIntHeader
in interface AtmosphereRequest
getIntHeader
in class javax.servlet.http.HttpServletRequestWrapper
public Enumeration<String> getHeaderNames()
AtmosphereRequest
getHeaderNames
in interface javax.servlet.http.HttpServletRequest
getHeaderNames
in interface AtmosphereRequest
getHeaderNames
in class javax.servlet.http.HttpServletRequestWrapper
public boolean authenticate(javax.servlet.http.HttpServletResponse response) throws IOException, javax.servlet.ServletException
AtmosphereRequest
authenticate
in interface javax.servlet.http.HttpServletRequest
authenticate
in interface AtmosphereRequest
authenticate
in class javax.servlet.http.HttpServletRequestWrapper
IOException
javax.servlet.ServletException
public String getAuthType()
AtmosphereRequest
getAuthType
in interface javax.servlet.http.HttpServletRequest
getAuthType
in interface AtmosphereRequest
getAuthType
in class javax.servlet.http.HttpServletRequestWrapper
public String getContextPath()
AtmosphereRequest
getContextPath
in interface javax.servlet.http.HttpServletRequest
getContextPath
in interface AtmosphereRequest
getContextPath
in class javax.servlet.http.HttpServletRequestWrapper
public javax.servlet.http.Cookie[] getCookies()
AtmosphereRequest
getCookies
in interface javax.servlet.http.HttpServletRequest
getCookies
in interface AtmosphereRequest
getCookies
in class javax.servlet.http.HttpServletRequestWrapper
public long getDateHeader(String name)
AtmosphereRequest
getDateHeader
in interface javax.servlet.http.HttpServletRequest
getDateHeader
in interface AtmosphereRequest
getDateHeader
in class javax.servlet.http.HttpServletRequestWrapper
public String getHeader(String s)
AtmosphereRequest
getHeader
in interface javax.servlet.http.HttpServletRequest
getHeader
in interface AtmosphereRequest
getHeader
in class javax.servlet.http.HttpServletRequestWrapper
public javax.servlet.http.HttpServletRequest wrappedRequest()
wrappedRequest
in interface AtmosphereRequest
public String getHeader(String s, boolean checkCase)
getHeader
in interface AtmosphereRequest
public String getParameter(String s)
AtmosphereRequest
getParameter
in interface javax.servlet.ServletRequest
getParameter
in interface AtmosphereRequest
getParameter
in class javax.servlet.ServletRequestWrapper
public Map<String,String[]> getParameterMap()
AtmosphereRequest
getParameterMap
in interface javax.servlet.ServletRequest
getParameterMap
in interface AtmosphereRequest
getParameterMap
in class javax.servlet.ServletRequestWrapper
public Enumeration<String> getParameterNames()
AtmosphereRequest
getParameterNames
in interface javax.servlet.ServletRequest
getParameterNames
in interface AtmosphereRequest
getParameterNames
in class javax.servlet.ServletRequestWrapper
public String[] getParameterValues(String s)
AtmosphereRequest
getParameterValues
in interface javax.servlet.ServletRequest
getParameterValues
in interface AtmosphereRequest
getParameterValues
in class javax.servlet.ServletRequestWrapper
public String getProtocol()
AtmosphereRequest
getProtocol
in interface javax.servlet.ServletRequest
getProtocol
in interface AtmosphereRequest
getProtocol
in class javax.servlet.ServletRequestWrapper
public javax.servlet.ServletInputStream getInputStream() throws IOException
AtmosphereRequest
getInputStream
in interface javax.servlet.ServletRequest
getInputStream
in interface AtmosphereRequest
getInputStream
in class javax.servlet.ServletRequestWrapper
IOException
public BufferedReader getReader() throws IOException
AtmosphereRequest
getReader
in interface javax.servlet.ServletRequest
getReader
in interface AtmosphereRequest
getReader
in class javax.servlet.ServletRequestWrapper
IOException
public String getRealPath(String path)
AtmosphereRequest
getRealPath
in interface javax.servlet.ServletRequest
getRealPath
in interface AtmosphereRequest
getRealPath
in class javax.servlet.ServletRequestWrapper
public AtmosphereRequest headers(Map<String,String> headers)
AtmosphereRequest
headers
in interface AtmosphereRequest
public AtmosphereRequest header(String name, String value)
AtmosphereRequest
header
in interface AtmosphereRequest
public AtmosphereRequest queryString(String qs)
AtmosphereRequest
queryString
in interface AtmosphereRequest
public Map<String,String> headersMap()
headersMap
in interface AtmosphereRequest
public Map<String,String[]> queryStringsMap()
queryStringsMap
in interface AtmosphereRequest
public AtmosphereRequest method(String m)
method
in interface AtmosphereRequest
public AtmosphereRequest contentType(String m)
contentType
in interface AtmosphereRequest
public AtmosphereRequest body(String body)
body
in interface AtmosphereRequest
public AtmosphereRequest body(byte[] bytes)
body
in interface AtmosphereRequest
public AtmosphereRequest body(InputStream body)
body
in interface AtmosphereRequest
public AtmosphereRequest body(Reader body)
body
in interface AtmosphereRequest
public AtmosphereRequestImpl.Body body()
AtmosphereRequest
body
in interface AtmosphereRequest
public AtmosphereRequest servletPath(String servletPath)
servletPath
in interface AtmosphereRequest
public AtmosphereRequest contextPath(String contextPath)
contextPath
in interface AtmosphereRequest
public AtmosphereRequest requestURI(String requestURI)
requestURI
in interface AtmosphereRequest
public void setAttribute(String s, Object o)
AtmosphereRequest
setAttribute
in interface javax.servlet.ServletRequest
setAttribute
in interface AtmosphereRequest
setAttribute
in class javax.servlet.ServletRequestWrapper
public void setCharacterEncoding(String env) throws UnsupportedEncodingException
AtmosphereRequest
setCharacterEncoding
in interface javax.servlet.ServletRequest
setCharacterEncoding
in interface AtmosphereRequest
setCharacterEncoding
in class javax.servlet.ServletRequestWrapper
UnsupportedEncodingException
public javax.servlet.AsyncContext startAsync()
AtmosphereRequest
startAsync
in interface javax.servlet.ServletRequest
startAsync
in interface AtmosphereRequest
startAsync
in class javax.servlet.ServletRequestWrapper
public javax.servlet.AsyncContext startAsync(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response)
AtmosphereRequest
startAsync
in interface javax.servlet.ServletRequest
startAsync
in interface AtmosphereRequest
startAsync
in class javax.servlet.ServletRequestWrapper
public javax.servlet.AsyncContext getAsyncContext()
AtmosphereRequest
getAsyncContext
in interface javax.servlet.ServletRequest
getAsyncContext
in interface AtmosphereRequest
getAsyncContext
in class javax.servlet.ServletRequestWrapper
public Object getAttribute(String s)
AtmosphereRequest
getAttribute
in interface javax.servlet.ServletRequest
getAttribute
in interface AtmosphereRequest
getAttribute
in class javax.servlet.ServletRequestWrapper
public void removeAttribute(String name)
AtmosphereRequest
removeAttribute
in interface javax.servlet.ServletRequest
removeAttribute
in interface AtmosphereRequest
removeAttribute
in class javax.servlet.ServletRequestWrapper
public AtmosphereRequest.LocalAttributes attributes()
AtmosphereRequest
attributes
in interface AtmosphereRequest
public javax.servlet.http.HttpSession getSession()
AtmosphereRequest
getSession
in interface javax.servlet.http.HttpServletRequest
getSession
in interface AtmosphereRequest
getSession
in class javax.servlet.http.HttpServletRequestWrapper
public javax.servlet.http.HttpSession getSession(boolean create)
AtmosphereRequest
getSession
in interface javax.servlet.http.HttpServletRequest
getSession
in interface AtmosphereRequest
getSession
in class javax.servlet.http.HttpServletRequestWrapper
public Principal getUserPrincipal()
AtmosphereRequest
getUserPrincipal
in interface javax.servlet.http.HttpServletRequest
getUserPrincipal
in interface AtmosphereRequest
getUserPrincipal
in class javax.servlet.http.HttpServletRequestWrapper
public boolean isRequestedSessionIdFromCookie()
AtmosphereRequest
isRequestedSessionIdFromCookie
in interface javax.servlet.http.HttpServletRequest
isRequestedSessionIdFromCookie
in interface AtmosphereRequest
isRequestedSessionIdFromCookie
in class javax.servlet.http.HttpServletRequestWrapper
public boolean isRequestedSessionIdFromUrl()
AtmosphereRequest
isRequestedSessionIdFromUrl
in interface javax.servlet.http.HttpServletRequest
isRequestedSessionIdFromUrl
in interface AtmosphereRequest
isRequestedSessionIdFromUrl
in class javax.servlet.http.HttpServletRequestWrapper
public boolean isRequestedSessionIdFromURL()
AtmosphereRequest
isRequestedSessionIdFromURL
in interface javax.servlet.http.HttpServletRequest
isRequestedSessionIdFromURL
in interface AtmosphereRequest
isRequestedSessionIdFromURL
in class javax.servlet.http.HttpServletRequestWrapper
public boolean isRequestedSessionIdValid()
AtmosphereRequest
isRequestedSessionIdValid
in interface javax.servlet.http.HttpServletRequest
isRequestedSessionIdValid
in interface AtmosphereRequest
isRequestedSessionIdValid
in class javax.servlet.http.HttpServletRequestWrapper
public boolean isUserInRole(String role)
AtmosphereRequest
isUserInRole
in interface javax.servlet.http.HttpServletRequest
isUserInRole
in interface AtmosphereRequest
isUserInRole
in class javax.servlet.http.HttpServletRequestWrapper
public void login(String username, String password) throws javax.servlet.ServletException
AtmosphereRequest
login
in interface javax.servlet.http.HttpServletRequest
login
in interface AtmosphereRequest
login
in class javax.servlet.http.HttpServletRequestWrapper
javax.servlet.ServletException
public void logout() throws javax.servlet.ServletException
AtmosphereRequest
logout
in interface javax.servlet.http.HttpServletRequest
logout
in interface AtmosphereRequest
logout
in class javax.servlet.http.HttpServletRequestWrapper
javax.servlet.ServletException
public String getRemoteAddr()
AtmosphereRequest
getRemoteAddr
in interface javax.servlet.ServletRequest
getRemoteAddr
in interface AtmosphereRequest
getRemoteAddr
in class javax.servlet.ServletRequestWrapper
public String getRemoteHost()
AtmosphereRequest
getRemoteHost
in interface javax.servlet.ServletRequest
getRemoteHost
in interface AtmosphereRequest
getRemoteHost
in class javax.servlet.ServletRequestWrapper
public int getRemotePort()
AtmosphereRequest
getRemotePort
in interface javax.servlet.ServletRequest
getRemotePort
in interface AtmosphereRequest
getRemotePort
in class javax.servlet.ServletRequestWrapper
public javax.servlet.RequestDispatcher getRequestDispatcher(String path)
AtmosphereRequest
getRequestDispatcher
in interface javax.servlet.ServletRequest
getRequestDispatcher
in interface AtmosphereRequest
getRequestDispatcher
in class javax.servlet.ServletRequestWrapper
public String getScheme()
AtmosphereRequest
getScheme
in interface javax.servlet.ServletRequest
getScheme
in interface AtmosphereRequest
getScheme
in class javax.servlet.ServletRequestWrapper
public String getServerName()
AtmosphereRequest
getServerName
in interface javax.servlet.ServletRequest
getServerName
in interface AtmosphereRequest
getServerName
in class javax.servlet.ServletRequestWrapper
public int getServerPort()
AtmosphereRequest
getServerPort
in interface javax.servlet.ServletRequest
getServerPort
in interface AtmosphereRequest
getServerPort
in class javax.servlet.ServletRequestWrapper
public javax.servlet.ServletContext getServletContext()
AtmosphereRequest
getServletContext
in interface javax.servlet.ServletRequest
getServletContext
in interface AtmosphereRequest
getServletContext
in class javax.servlet.ServletRequestWrapper
public boolean isAsyncStarted()
AtmosphereRequest
isAsyncStarted
in interface javax.servlet.ServletRequest
isAsyncStarted
in interface AtmosphereRequest
isAsyncStarted
in class javax.servlet.ServletRequestWrapper
public boolean isAsyncSupported()
AtmosphereRequest
isAsyncSupported
in interface javax.servlet.ServletRequest
isAsyncSupported
in interface AtmosphereRequest
isAsyncSupported
in class javax.servlet.ServletRequestWrapper
public boolean isSecure()
AtmosphereRequest
isSecure
in interface javax.servlet.ServletRequest
isSecure
in interface AtmosphereRequest
isSecure
in class javax.servlet.ServletRequestWrapper
public String getLocalName()
AtmosphereRequest
getLocalName
in interface javax.servlet.ServletRequest
getLocalName
in interface AtmosphereRequest
getLocalName
in class javax.servlet.ServletRequestWrapper
public int getLocalPort()
AtmosphereRequest
getLocalPort
in interface javax.servlet.ServletRequest
getLocalPort
in interface AtmosphereRequest
getLocalPort
in class javax.servlet.ServletRequestWrapper
public String getLocalAddr()
AtmosphereRequest
getLocalAddr
in interface javax.servlet.ServletRequest
getLocalAddr
in interface AtmosphereRequest
getLocalAddr
in class javax.servlet.ServletRequestWrapper
public Locale getLocale()
AtmosphereRequest
getLocale
in interface javax.servlet.ServletRequest
getLocale
in interface AtmosphereRequest
getLocale
in class javax.servlet.ServletRequestWrapper
public AtmosphereResource resource()
AtmosphereRequest
AtmosphereResource
associated with this request.resource
in interface AtmosphereRequest
AtmosphereResource
public Enumeration<Locale> getLocales()
AtmosphereRequest
getLocales
in interface javax.servlet.ServletRequest
getLocales
in interface AtmosphereRequest
getLocales
in class javax.servlet.ServletRequestWrapper
public boolean dispatchRequestAsynchronously()
AtmosphereRequest
dispatchRequestAsynchronously
in interface AtmosphereRequest
public boolean isDestroyable()
AtmosphereRequest
isDestroyable
in interface AtmosphereRequest
public AtmosphereRequest pathInfo(String pathInfo)
pathInfo
in interface AtmosphereRequest
public Enumeration<String> getAttributeNames()
AtmosphereRequest
getAttributeNames
in interface javax.servlet.ServletRequest
getAttributeNames
in interface AtmosphereRequest
getAttributeNames
in class javax.servlet.ServletRequestWrapper
public AtmosphereRequest.LocalAttributes localAttributes()
AtmosphereRequest
localAttributes
in interface AtmosphereRequest
public String getCharacterEncoding()
AtmosphereRequest
getCharacterEncoding
in interface javax.servlet.ServletRequest
getCharacterEncoding
in interface AtmosphereRequest
getCharacterEncoding
in class javax.servlet.ServletRequestWrapper
public int getContentLength()
AtmosphereRequest
getContentLength
in interface javax.servlet.ServletRequest
getContentLength
in interface AtmosphereRequest
getContentLength
in class javax.servlet.ServletRequestWrapper
public String uuid()
AtmosphereRequest
AtmosphereResource.uuid()
. May return "0" if no AtmosphereResource
is associated with this object.uuid
in interface AtmosphereRequest
AtmosphereResource.uuid()
public void destroy()
destroy
in interface AtmosphereRequest
public void destroy(boolean force)
destroy
in interface AtmosphereRequest
public void setRequest(javax.servlet.ServletRequest request)
AtmosphereRequest
setRequest
in interface AtmosphereRequest
setRequest
in class javax.servlet.ServletRequestWrapper
public static final AtmosphereRequest newInstance()
HttpServletRequest
.HttpServletRequest
public static final AtmosphereRequest wrap(javax.servlet.http.HttpServletRequest request)
HttpServletRequest
.request
- HttpServletRequest
AtmosphereRequest
public static final AtmosphereRequest cloneRequest(javax.servlet.http.HttpServletRequest request, boolean loadInMemory, boolean copySession, boolean isDestroyable, boolean createSession)
request
- HttpServletRequest
AtmosphereRequest
public String toString()
toString
in interface AtmosphereRequest
toString
in class Object
public String requestURL()
requestURL
in interface AtmosphereRequest
Copyright © 2016. All rights reserved.