org.atmosphere.cpr
Class AtmosphereResponse<A extends AsyncIOWriter>

java.lang.Object
  javax.servlet.ServletResponseWrapper
      javax.servlet.http.HttpServletResponseWrapper
          org.atmosphere.cpr.AtmosphereResponse<A>

Type Parameters:

A -

All Implemented Interfaces:

javax.servlet.http.HttpServletResponse, javax.servlet.ServletResponse

public class AtmosphereResponse<A extends AsyncIOWriter>
extends javax.servlet.http.HttpServletResponseWrapper

Wrapper around an HttpServletResponse which use an instance of WebSocket as a writer.

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletResponse

SC_ACCEPTED, SC_BAD_GATEWAY, SC_BAD_REQUEST, SC_CONFLICT, SC_CONTINUE, SC_CREATED, SC_EXPECTATION_FAILED, SC_FORBIDDEN, SC_FOUND, SC_GATEWAY_TIMEOUT, SC_GONE, SC_HTTP_VERSION_NOT_SUPPORTED, SC_INTERNAL_SERVER_ERROR, SC_LENGTH_REQUIRED, SC_METHOD_NOT_ALLOWED, SC_MOVED_PERMANENTLY, SC_MOVED_TEMPORARILY, SC_MULTIPLE_CHOICES, SC_NO_CONTENT, SC_NON_AUTHORITATIVE_INFORMATION, SC_NOT_ACCEPTABLE, SC_NOT_FOUND, SC_NOT_IMPLEMENTED, SC_NOT_MODIFIED, SC_OK, SC_PARTIAL_CONTENT, SC_PAYMENT_REQUIRED, SC_PRECONDITION_FAILED, SC_PROXY_AUTHENTICATION_REQUIRED, SC_REQUEST_ENTITY_TOO_LARGE, SC_REQUEST_TIMEOUT, SC_REQUEST_URI_TOO_LONG, SC_REQUESTED_RANGE_NOT_SATISFIABLE, SC_RESET_CONTENT, SC_SEE_OTHER, SC_SERVICE_UNAVAILABLE, SC_SWITCHING_PROTOCOLS, SC_TEMPORARY_REDIRECT, SC_UNAUTHORIZED, SC_UNSUPPORTED_MEDIA_TYPE, SC_USE_PROXY

Constructor Summary

AtmosphereResponse(A asyncIOWriter, AsyncProtocol asyncProtocol, javax.servlet.http.HttpServletRequest atmosphereRequest)

AtmosphereResponse(javax.servlet.http.HttpServletResponse r, A asyncIOWriter, AsyncProtocol asyncProtocol, javax.servlet.http.HttpServletRequest atmosphereRequest)

Method Summary

void	addCookie(javax.servlet.http.Cookie cookie)
void	addDateHeader(String name, long date)
void	addHeader(String name, String value)
void	addIntHeader(String name, int value)
boolean	containsHeader(String name)
A	getasyncIOWriter() Return the underlying WebSocket
String	getCharacterEncoding()
String	getContentType()
String	getHeader(String name)
Collection<String>	getHeaderNames()
Collection<String>	getHeaders(String name)
Locale	getLocale()
javax.servlet.ServletOutputStream	getOutputStream()
javax.servlet.http.HttpServletRequest	getRequest() Return the associated HttpServletRequest
int	getStatus()
String	getStatusMessage()
PrintWriter	getWriter()
Map<String,String>	headers()
boolean	isCommitted()
boolean	isWrapperFor(Class wrappedType)
boolean	isWrapperFor(javax.servlet.ServletResponse wrapped)
void	sendError(int sc)
void	sendError(int sc, String msg)
void	sendRedirect(String location)
void	setCharacterEncoding(String charset)
void	setContentLength(int len)
void	setContentType(String contentType)
void	setDateHeader(String name, long date)
void	setHeader(String name, String value)
void	setIntHeader(String name, int value)
void	setLocale(Locale locale)
void	setStatus(int status)
void	setStatus(int status, String statusMessage)

Methods inherited from class javax.servlet.http.HttpServletResponseWrapper

encodeRedirectUrl, encodeRedirectURL, encodeUrl, encodeURL

Methods inherited from class javax.servlet.ServletResponseWrapper

flushBuffer, getBufferSize, getResponse, reset, resetBuffer, setBufferSize, setResponse

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.servlet.ServletResponse

flushBuffer, getBufferSize, reset, resetBuffer, setBufferSize

Constructor Detail

AtmosphereResponse

public AtmosphereResponse(A asyncIOWriter,
                          AsyncProtocol asyncProtocol,
                          javax.servlet.http.HttpServletRequest atmosphereRequest)

AtmosphereResponse

public AtmosphereResponse(javax.servlet.http.HttpServletResponse r,
                          A asyncIOWriter,
                          AsyncProtocol asyncProtocol,
                          javax.servlet.http.HttpServletRequest atmosphereRequest)

Method Detail

addCookie

public void addCookie(javax.servlet.http.Cookie cookie)

Specified by:

addCookie in interface javax.servlet.http.HttpServletResponse

Overrides:

addCookie in class javax.servlet.http.HttpServletResponseWrapper

containsHeader

public boolean containsHeader(String name)

Specified by:

containsHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

containsHeader in class javax.servlet.http.HttpServletResponseWrapper

sendError

public void sendError(int sc,
                      String msg)
               throws IOException

Specified by:

sendError in interface javax.servlet.http.HttpServletResponse

Overrides:

sendError in class javax.servlet.http.HttpServletResponseWrapper

Throws:

IOException

sendError

public void sendError(int sc)
               throws IOException

Specified by:

sendError in interface javax.servlet.http.HttpServletResponse

Overrides:

sendError in class javax.servlet.http.HttpServletResponseWrapper

Throws:

IOException

sendRedirect

public void sendRedirect(String location)
                  throws IOException

Specified by:

sendRedirect in interface javax.servlet.http.HttpServletResponse

Overrides:

sendRedirect in class javax.servlet.http.HttpServletResponseWrapper

Throws:

IOException

setDateHeader

public void setDateHeader(String name,
                          long date)

Specified by:

setDateHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

setDateHeader in class javax.servlet.http.HttpServletResponseWrapper

addDateHeader

public void addDateHeader(String name,
                          long date)

Specified by:

addDateHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

addDateHeader in class javax.servlet.http.HttpServletResponseWrapper

setHeader

public void setHeader(String name,
                      String value)

Specified by:

setHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

setHeader in class javax.servlet.http.HttpServletResponseWrapper

addHeader

public void addHeader(String name,
                      String value)

Specified by:

addHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

addHeader in class javax.servlet.http.HttpServletResponseWrapper

setIntHeader

public void setIntHeader(String name,
                         int value)

Specified by:

setIntHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

setIntHeader in class javax.servlet.http.HttpServletResponseWrapper

addIntHeader

public void addIntHeader(String name,
                         int value)

Specified by:

addIntHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

addIntHeader in class javax.servlet.http.HttpServletResponseWrapper

setStatus

public void setStatus(int status)

Specified by:

setStatus in interface javax.servlet.http.HttpServletResponse

Overrides:

setStatus in class javax.servlet.http.HttpServletResponseWrapper

setStatus

public void setStatus(int status,
                      String statusMessage)

Specified by:

setStatus in interface javax.servlet.http.HttpServletResponse

Overrides:

setStatus in class javax.servlet.http.HttpServletResponseWrapper

getStatus

public int getStatus()

Specified by:

getStatus in interface javax.servlet.http.HttpServletResponse

Overrides:

getStatus in class javax.servlet.http.HttpServletResponseWrapper

getStatusMessage

public String getStatusMessage()

headers

public Map<String,String> headers()

getHeader

public String getHeader(String name)

Specified by:

getHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

getHeader in class javax.servlet.http.HttpServletResponseWrapper

getHeaders

public Collection<String> getHeaders(String name)

Specified by:

getHeaders in interface javax.servlet.http.HttpServletResponse

Overrides:

getHeaders in class javax.servlet.http.HttpServletResponseWrapper

getHeaderNames

public Collection<String> getHeaderNames()

Specified by:

getHeaderNames in interface javax.servlet.http.HttpServletResponse

Overrides:

getHeaderNames in class javax.servlet.http.HttpServletResponseWrapper

setCharacterEncoding

public void setCharacterEncoding(String charset)

Specified by:

setCharacterEncoding in interface javax.servlet.ServletResponse

Overrides:

setCharacterEncoding in class javax.servlet.ServletResponseWrapper

getCharacterEncoding

public String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface javax.servlet.ServletResponse

Overrides:

getCharacterEncoding in class javax.servlet.ServletResponseWrapper

getOutputStream

public javax.servlet.ServletOutputStream getOutputStream()
                                                  throws IOException

Specified by:

getOutputStream in interface javax.servlet.ServletResponse

Overrides:

getOutputStream in class javax.servlet.ServletResponseWrapper

Throws:

IOException

getWriter

public PrintWriter getWriter()
                      throws IOException

Specified by:

getWriter in interface javax.servlet.ServletResponse

Overrides:

getWriter in class javax.servlet.ServletResponseWrapper

Throws:

IOException

setContentLength

public void setContentLength(int len)

Specified by:

setContentLength in interface javax.servlet.ServletResponse

Overrides:

setContentLength in class javax.servlet.ServletResponseWrapper

setContentType

public void setContentType(String contentType)

Specified by:

setContentType in interface javax.servlet.ServletResponse

Overrides:

setContentType in class javax.servlet.ServletResponseWrapper

getContentType

public String getContentType()

Specified by:

getContentType in interface javax.servlet.ServletResponse

Overrides:

getContentType in class javax.servlet.ServletResponseWrapper

isCommitted

public boolean isCommitted()

Specified by:

isCommitted in interface javax.servlet.ServletResponse

Overrides:

isCommitted in class javax.servlet.ServletResponseWrapper

setLocale

public void setLocale(Locale locale)

Specified by:

setLocale in interface javax.servlet.ServletResponse

Overrides:

setLocale in class javax.servlet.ServletResponseWrapper

getLocale

public Locale getLocale()

Specified by:

getLocale in interface javax.servlet.ServletResponse

Overrides:

getLocale in class javax.servlet.ServletResponseWrapper

isWrapperFor

public boolean isWrapperFor(javax.servlet.ServletResponse wrapped)

Overrides:

isWrapperFor in class javax.servlet.ServletResponseWrapper

isWrapperFor

public boolean isWrapperFor(Class wrappedType)

Overrides:

isWrapperFor in class javax.servlet.ServletResponseWrapper

getasyncIOWriter

public A getasyncIOWriter()

Return the underlying WebSocket

Returns:

A

getRequest

public javax.servlet.http.HttpServletRequest getRequest()

Return the associated HttpServletRequest

Returns:

the associated HttpServletRequest