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