org.atmosphere.cpr
Class AtmosphereRequest

java.lang.Object
  org.atmosphere.cpr.AtmosphereRequest

All Implemented Interfaces:

javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest

public class AtmosphereRequest
extends Object
implements javax.servlet.http.HttpServletRequest

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 moments between requests. You can use it's associated AtmosphereResponse to write bytes at any moment, making this object bi-directional.
You can retrieve the AtmosphereResource can be retrieved as an attribute FrameworkConfig.ATMOSPHERE_RESOURCE.

Author:

Jeanfrancois Arcand

Nested Class Summary

static class

AtmosphereRequest.Builder

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletRequest

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Method Summary

Map<String,Object>	attributes() Return the locally added attribute.
boolean	authenticate(javax.servlet.http.HttpServletResponse response)
AtmosphereRequest	body(String body)
void	destroy()
boolean	destroyed()
boolean	dispatchRequestAsynchronously() Dispatch the request asynchronously to container.
boolean	equals(Object o)
javax.servlet.AsyncContext	getAsyncContext()
Object	getAttribute(String s)
Enumeration<String>	getAttributeNames()
String	getAuthType()
String	getCharacterEncoding()
int	getContentLength()
String	getContentType()
String	getContextPath()
javax.servlet.http.Cookie[]	getCookies()
long	getDateHeader(String name)
javax.servlet.DispatcherType	getDispatcherType()
String	getHeader(String s)
String	getHeader(String s, boolean checkCase)
Enumeration<String>	getHeaderNames()
Enumeration	getHeaders(String name)
javax.servlet.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)
javax.servlet.http.Part	getPart(String name)
Collection<javax.servlet.http.Part>	getParts()
String	getPathInfo()
String	getPathTranslated()
String	getProtocol()
String	getQueryString()
BufferedReader	getReader()
String	getRealPath(String path)
String	getRemoteAddr()
String	getRemoteHost()
int	getRemotePort()
String	getRemoteUser()
javax.servlet.RequestDispatcher	getRequestDispatcher(String path)
String	getRequestedSessionId()
String	getRequestURI()
StringBuffer	getRequestURL()
String	getScheme()
String	getServerName()
int	getServerPort()
javax.servlet.ServletContext	getServletContext()
String	getServletPath()
javax.servlet.http.HttpSession	getSession()
javax.servlet.http.HttpSession	getSession(boolean create)
Principal	getUserPrincipal()
int	hashCode()
AtmosphereRequest	header(String name, String value) Add a header.
AtmosphereRequest	headers(Map<String,String> headers) Add all headers contained with the Map.
Map<String,String>	headersMap()
boolean	isAsyncStarted()
boolean	isAsyncSupported()
boolean	isDestroyable() Can this object be destroyed.
boolean	isRequestedSessionIdFromCookie()
boolean	isRequestedSessionIdFromUrl()
boolean	isRequestedSessionIdFromURL()
boolean	isRequestedSessionIdValid()
boolean	isSecure()
boolean	isUserInRole(String role)
static AtmosphereRequest	loadInMemory(javax.servlet.http.HttpServletRequest request, boolean loadInMemory) Copy the HttpServletRequest content inside an AtmosphereRequest.
void	login(String username, String password)
void	logout()
AtmosphereRequest	method(String m)
void	removeAttribute(String name)
void	setAttribute(String s, Object o)
void	setCharacterEncoding(String env)
javax.servlet.AsyncContext	startAsync()
javax.servlet.AsyncContext	startAsync(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response)
String	toString()
static AtmosphereRequest	wrap(javax.servlet.http.HttpServletRequest request) Wrap an HttpServletRequest.
javax.servlet.http.HttpServletRequest	wrappedRequest()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

destroyed

public boolean destroyed()

getPathInfo

public String getPathInfo()

Specified by:

getPathInfo in interface javax.servlet.http.HttpServletRequest

getPathTranslated

public String getPathTranslated()

Specified by:

getPathTranslated in interface javax.servlet.http.HttpServletRequest

getQueryString

public String getQueryString()

Specified by:

getQueryString in interface javax.servlet.http.HttpServletRequest

getRemoteUser

public String getRemoteUser()

Specified by:

getRemoteUser in interface javax.servlet.http.HttpServletRequest

getRequestedSessionId

public String getRequestedSessionId()

Specified by:

getRequestedSessionId in interface javax.servlet.http.HttpServletRequest

getMethod

public String getMethod()

Specified by:

getMethod in interface javax.servlet.http.HttpServletRequest

getPart

public javax.servlet.http.Part getPart(String name)
                                throws IOException,
                                       javax.servlet.ServletException

Specified by:

getPart in interface javax.servlet.http.HttpServletRequest

Throws:

IOException

javax.servlet.ServletException

getParts

public Collection<javax.servlet.http.Part> getParts()
                                             throws IOException,
                                                    javax.servlet.ServletException

Specified by:

getParts in interface javax.servlet.http.HttpServletRequest

Throws:

IOException

javax.servlet.ServletException

getContentType

public String getContentType()

Specified by:

getContentType in interface javax.servlet.ServletRequest

getDispatcherType

public javax.servlet.DispatcherType getDispatcherType()

Specified by:

getDispatcherType in interface javax.servlet.ServletRequest

getServletPath

public String getServletPath()

Specified by:

getServletPath in interface javax.servlet.http.HttpServletRequest

getRequestURI

public String getRequestURI()

Specified by:

getRequestURI in interface javax.servlet.http.HttpServletRequest

getRequestURL

public StringBuffer getRequestURL()

Specified by:

getRequestURL in interface javax.servlet.http.HttpServletRequest

getHeaders

public Enumeration getHeaders(String name)

Specified by:

getHeaders in interface javax.servlet.http.HttpServletRequest

getIntHeader

public int getIntHeader(String name)

Specified by:

getIntHeader in interface javax.servlet.http.HttpServletRequest

getHeaderNames

public Enumeration<String> getHeaderNames()

Specified by:

getHeaderNames in interface javax.servlet.http.HttpServletRequest

authenticate

public boolean authenticate(javax.servlet.http.HttpServletResponse response)
                     throws IOException,
                            javax.servlet.ServletException

Specified by:

authenticate in interface javax.servlet.http.HttpServletRequest

Throws:

IOException

javax.servlet.ServletException

getAuthType

public String getAuthType()

Specified by:

getAuthType in interface javax.servlet.http.HttpServletRequest

getContextPath

public String getContextPath()

Specified by:

getContextPath in interface javax.servlet.http.HttpServletRequest

getCookies

public javax.servlet.http.Cookie[] getCookies()

Specified by:

getCookies in interface javax.servlet.http.HttpServletRequest

getDateHeader

public long getDateHeader(String name)

Specified by:

getDateHeader in interface javax.servlet.http.HttpServletRequest

getHeader

public String getHeader(String s)

Specified by:

getHeader in interface javax.servlet.http.HttpServletRequest

wrappedRequest

public javax.servlet.http.HttpServletRequest wrappedRequest()

getHeader

public String getHeader(String s,
                        boolean checkCase)

getParameter

public String getParameter(String s)

Specified by:

getParameter in interface javax.servlet.ServletRequest

getParameterMap

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

Specified by:

getParameterMap in interface javax.servlet.ServletRequest

getParameterNames

public Enumeration<String> getParameterNames()

Specified by:

getParameterNames in interface javax.servlet.ServletRequest

getParameterValues

public String[] getParameterValues(String s)

Specified by:

getParameterValues in interface javax.servlet.ServletRequest

getProtocol

public String getProtocol()

Specified by:

getProtocol in interface javax.servlet.ServletRequest

getInputStream

public javax.servlet.ServletInputStream getInputStream()
                                                throws IOException

Specified by:

getInputStream in interface javax.servlet.ServletRequest

Throws:

IOException

getReader

public BufferedReader getReader()
                         throws IOException

Specified by:

getReader in interface javax.servlet.ServletRequest

Throws:

IOException

getRealPath

public String getRealPath(String path)

Specified by:

getRealPath in interface javax.servlet.ServletRequest

headers

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

Add all headers contained with the Map.

Parameters:

headers -

Returns:

this;

header

public AtmosphereRequest header(String name,
                                String value)

Add a header.

Parameters:

name -

value -

Returns:

headersMap

public Map<String,String> headersMap()

method

public AtmosphereRequest method(String m)

body

public AtmosphereRequest body(String body)

setAttribute

public void setAttribute(String s,
                         Object o)

Specified by:

setAttribute in interface javax.servlet.ServletRequest

setCharacterEncoding

public void setCharacterEncoding(String env)
                          throws UnsupportedEncodingException

Specified by:

setCharacterEncoding in interface javax.servlet.ServletRequest

Throws:

UnsupportedEncodingException

startAsync

public javax.servlet.AsyncContext startAsync()

Specified by:

startAsync in interface javax.servlet.ServletRequest

startAsync

public javax.servlet.AsyncContext startAsync(javax.servlet.ServletRequest request,
                                             javax.servlet.ServletResponse response)

Specified by:

startAsync in interface javax.servlet.ServletRequest

getAsyncContext

public javax.servlet.AsyncContext getAsyncContext()

Specified by:

getAsyncContext in interface javax.servlet.ServletRequest

getAttribute

public Object getAttribute(String s)

Specified by:

getAttribute in interface javax.servlet.ServletRequest

removeAttribute

public void removeAttribute(String name)

Specified by:

removeAttribute in interface javax.servlet.ServletRequest

attributes

public Map<String,Object> attributes()

Return the locally added attribute.

Returns:

getSession

public javax.servlet.http.HttpSession getSession()

Specified by:

getSession in interface javax.servlet.http.HttpServletRequest

getSession

public javax.servlet.http.HttpSession getSession(boolean create)

Specified by:

getSession in interface javax.servlet.http.HttpServletRequest

getUserPrincipal

public Principal getUserPrincipal()

Specified by:

getUserPrincipal in interface javax.servlet.http.HttpServletRequest

isRequestedSessionIdFromCookie

public boolean isRequestedSessionIdFromCookie()

Specified by:

isRequestedSessionIdFromCookie in interface javax.servlet.http.HttpServletRequest

isRequestedSessionIdFromUrl

public boolean isRequestedSessionIdFromUrl()

Specified by:

isRequestedSessionIdFromUrl in interface javax.servlet.http.HttpServletRequest

isRequestedSessionIdFromURL

public boolean isRequestedSessionIdFromURL()

Specified by:

isRequestedSessionIdFromURL in interface javax.servlet.http.HttpServletRequest

isRequestedSessionIdValid

public boolean isRequestedSessionIdValid()

Specified by:

isRequestedSessionIdValid in interface javax.servlet.http.HttpServletRequest

isUserInRole

public boolean isUserInRole(String role)

Specified by:

isUserInRole in interface javax.servlet.http.HttpServletRequest

login

public void login(String username,
                  String password)
           throws javax.servlet.ServletException

Specified by:

login in interface javax.servlet.http.HttpServletRequest

Throws:

javax.servlet.ServletException

logout

public void logout()
            throws javax.servlet.ServletException

Specified by:

logout in interface javax.servlet.http.HttpServletRequest

Throws:

javax.servlet.ServletException

getRemoteAddr

public String getRemoteAddr()

Specified by:

getRemoteAddr in interface javax.servlet.ServletRequest

getRemoteHost

public String getRemoteHost()

Specified by:

getRemoteHost in interface javax.servlet.ServletRequest

getRemotePort

public int getRemotePort()

Specified by:

getRemotePort in interface javax.servlet.ServletRequest

getRequestDispatcher

public javax.servlet.RequestDispatcher getRequestDispatcher(String path)

Specified by:

getRequestDispatcher in interface javax.servlet.ServletRequest

getScheme

public String getScheme()

Specified by:

getScheme in interface javax.servlet.ServletRequest

getServerName

public String getServerName()

Specified by:

getServerName in interface javax.servlet.ServletRequest

getServerPort

public int getServerPort()

Specified by:

getServerPort in interface javax.servlet.ServletRequest

getServletContext

public javax.servlet.ServletContext getServletContext()

Specified by:

getServletContext in interface javax.servlet.ServletRequest

isAsyncStarted

public boolean isAsyncStarted()

Specified by:

isAsyncStarted in interface javax.servlet.ServletRequest

isAsyncSupported

public boolean isAsyncSupported()

Specified by:

isAsyncSupported in interface javax.servlet.ServletRequest

isSecure

public boolean isSecure()

Specified by:

isSecure in interface javax.servlet.ServletRequest

getLocalName

public String getLocalName()

Specified by:

getLocalName in interface javax.servlet.ServletRequest

getLocalPort

public int getLocalPort()

Specified by:

getLocalPort in interface javax.servlet.ServletRequest

getLocalAddr

public String getLocalAddr()

Specified by:

getLocalAddr in interface javax.servlet.ServletRequest

getLocale

public Locale getLocale()

Specified by:

getLocale in interface javax.servlet.ServletRequest

getLocales

public Enumeration<Locale> getLocales()

Specified by:

getLocales in interface javax.servlet.ServletRequest

dispatchRequestAsynchronously

public boolean dispatchRequestAsynchronously()

Dispatch the request asynchronously to container. The default is false.

Returns:

true to dispatch asynchronously the request to container.

isDestroyable

public boolean isDestroyable()

Can this object be destroyed. Default is true.

getAttributeNames

public Enumeration<String> getAttributeNames()

Specified by:

getAttributeNames in interface javax.servlet.ServletRequest

getCharacterEncoding

public String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface javax.servlet.ServletRequest

getContentLength

public int getContentLength()

Specified by:

getContentLength in interface javax.servlet.ServletRequest

destroy

public void destroy()

wrap

public static final AtmosphereRequest wrap(javax.servlet.http.HttpServletRequest request)

Wrap an HttpServletRequest.

Parameters:

request - HttpServletRequest

Returns:

an AtmosphereRequest

loadInMemory

public static final AtmosphereRequest loadInMemory(javax.servlet.http.HttpServletRequest request,
                                                   boolean loadInMemory)

Copy the HttpServletRequest content inside an AtmosphereRequest. By default the returned AtmosphereRequest is not destroyable.

Parameters:

request - HttpServletRequest

Returns:

an AtmosphereRequest

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object