Package org.atmosphere.cpr

Class AtmosphereResponseImpl

java.lang.Object

jakarta.servlet.ServletResponseWrapper

jakarta.servlet.http.HttpServletResponseWrapper

org.atmosphere.cpr.AtmosphereResponseImpl

All Implemented Interfaces:

HttpServletResponse, ServletResponse, AtmosphereResponse, CompletionAware

public class AtmosphereResponseImpl
extends HttpServletResponseWrapper
implements AtmosphereResponse, CompletionAware

An Atmosphere's response representation. An AtmosphereResponse can be used to construct a bi-directional asynchronous application. If the underlying transport is a WebSocket or if its associated AtmosphereResource has been suspended, this object can be used to write message back to the client at any moment.
This object can delegate the write operation to AsyncIOWriter.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	AtmosphereResponseImpl.Builder

Field Summary

Fields inherited from interface jakarta.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

Constructors

Constructor	Description
AtmosphereResponseImpl(HttpServletResponse r, AsyncIOWriter asyncIOWriter, AtmosphereRequest atmosphereRequest, boolean destroyable)
AtmosphereResponseImpl(AsyncIOWriter asyncIOWriter, AtmosphereRequest atmosphereRequest, boolean destroyable)

Method Summary

Modifier and Type	Method	Description
void	addCookie(Cookie cookie)
void	addDateHeader(String name, long date)
void	addHeader(String name, String value)
void	addIntHeader(String name, int value)
AtmosphereResponse	asyncIOWriter(AsyncIOWriter asyncIOWriter)	Set an implementation of AsyncIOWriter that will be invoked every time a write operation is ready to be processed.
void	close()	Close the associated AsyncIOWriter.
void	closeStreamOrWriter()	Close the associated invalid reference PrintWriter or OutputStream
boolean	completed()
boolean	containsHeader(String name)
AtmosphereResponse	delegateToNativeResponse(boolean delegateToNativeResponse)
void	destroy()
void	destroy(boolean force)
AtmosphereResponse	destroyable(boolean destroyable)
boolean	destroyed()
String	encodeRedirectUrl(String url)
String	encodeRedirectURL(String url)
String	encodeUrl(String url)
String	encodeURL(String url)
void	flushBuffer()
AsyncIOWriter	getAsyncIOWriter()	Return the underlying AsyncIOWriter.
int	getBufferSize()
String	getCharacterEncoding()
String	getContentType()
String	getHeader(String name)
Collection<String>	getHeaderNames()
Collection<String>	getHeaders(String name)
Locale	getLocale()
ServletOutputStream	getOutputStream()
ServletResponse	getResponse()
int	getStatus()
String	getStatusMessage()
PrintWriter	getWriter()
Map<String,String>	headers()
boolean	isCommitted()
boolean	isDestroyable()	Check if this object can be destroyed.
static AtmosphereResponse	newInstance()	Create an instance not associated with any response parent.
static AtmosphereResponse	newInstance(AtmosphereConfig config, AtmosphereRequest request, WebSocket webSocket)	Create a new instance to use with WebSocket.
static AtmosphereResponse	newInstance(AtmosphereRequest request)	Create a new instance to use with WebSocket.
void	onComplete()
AtmosphereRequest	request()	Return the associated AtmosphereRequest.
AtmosphereResponse	request(AtmosphereRequest atmosphereRequest)	Set the associated AtmosphereRequest.
void	reset()
void	resetBuffer()
AtmosphereResource	resource()	The AtmosphereResource associated with this request.
void	sendError(int sc)
void	sendError(int sc, String msg)
void	sendRedirect(String location)
void	setBufferSize(int size)
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	setResponse(ServletResponse response)
void	setStatus(int status)
String	toString()
String	uuid()	Return the AtmosphereResource.uuid() used by this object.
static AtmosphereResponse	wrap(HttpServletResponse response)	Wrap an HttpServletResponse
AtmosphereResponse	write(byte[] data)	Write the bytes by either using the invalid reference PrintWriter or OutputStream.
AtmosphereResponse	write(byte[] data, boolean writeUsingOriginalResponse)	Write the String by either using the invalid reference PrintWriter or OutputStream.
AtmosphereResponse	write(byte[] data, int offset, int length)	Write the bytes by either using the invalid reference PrintWriter or OutputStream.
AtmosphereResponse	write(byte[] data, int offset, int length, boolean writeUsingOriginalResponse)	Write the String by either using the invalid reference PrintWriter or OutputStream.
AtmosphereResponse	write(String data)	Write the String by either using the invalid reference PrintWriter or OutputStream.
AtmosphereResponse	write(String data, boolean writeUsingOriginalResponse)	Write the String by either using the invalid reference PrintWriter or OutputStream.

Methods inherited from class jakarta.servlet.http.HttpServletResponseWrapper

getTrailerFields, setStatus, setTrailerFields

Methods inherited from class jakarta.servlet.ServletResponseWrapper

isWrapperFor, isWrapperFor, setContentLengthLong

Methods inherited from class java.lang.Object

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

Methods inherited from interface jakarta.servlet.http.HttpServletResponse

getTrailerFields, setStatus, setTrailerFields

Methods inherited from interface jakarta.servlet.ServletResponse

setContentLengthLong

Constructor Details

AtmosphereResponseImpl

public AtmosphereResponseImpl(AsyncIOWriter asyncIOWriter,
 AtmosphereRequest atmosphereRequest,
 boolean destroyable)

AtmosphereResponseImpl

public AtmosphereResponseImpl(HttpServletResponse r,
 AsyncIOWriter asyncIOWriter,
 AtmosphereRequest atmosphereRequest,
 boolean destroyable)

Method Details

destroy

public void destroy()

Specified by:

destroy in interface AtmosphereResponse

destroy

public void destroy(boolean force)

Specified by:

destroy in interface AtmosphereResponse

destroyed

public boolean destroyed()

Specified by:

destroyed in interface AtmosphereResponse

addCookie

public void addCookie(Cookie cookie)

Specified by:

addCookie in interface HttpServletResponse

Overrides:

addCookie in class HttpServletResponseWrapper

containsHeader

public boolean containsHeader(String name)

Specified by:

containsHeader in interface HttpServletResponse

Overrides:

containsHeader in class HttpServletResponseWrapper

encodeURL

public String encodeURL(String url)

Specified by:

encodeURL in interface HttpServletResponse

Overrides:

encodeURL in class HttpServletResponseWrapper

encodeRedirectURL

public String encodeRedirectURL(String url)

Specified by:

encodeRedirectURL in interface HttpServletResponse

Overrides:

encodeRedirectURL in class HttpServletResponseWrapper

encodeUrl

public String encodeUrl(String url)

Specified by:

encodeUrl in interface HttpServletResponse

Overrides:

encodeUrl in class HttpServletResponseWrapper

encodeRedirectUrl

public String encodeRedirectUrl(String url)

Specified by:

encodeRedirectUrl in interface HttpServletResponse

Overrides:

encodeRedirectUrl in class HttpServletResponseWrapper

delegateToNativeResponse

public AtmosphereResponse delegateToNativeResponse(boolean delegateToNativeResponse)

Specified by:

delegateToNativeResponse in interface AtmosphereResponse

sendError

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

Specified by:

sendError in interface HttpServletResponse

Overrides:

sendError in class HttpServletResponseWrapper

Throws:

IOException

sendError

public void sendError(int sc)
               throws IOException

Specified by:

sendError in interface HttpServletResponse

Overrides:

sendError in class HttpServletResponseWrapper

Throws:

IOException

sendRedirect

public void sendRedirect(String location)
                  throws IOException

Specified by:

sendRedirect in interface HttpServletResponse

Overrides:

sendRedirect in class HttpServletResponseWrapper

Throws:

IOException

setDateHeader

public void setDateHeader(String name,
 long date)

Specified by:

setDateHeader in interface HttpServletResponse

Overrides:

setDateHeader in class HttpServletResponseWrapper

addDateHeader

public void addDateHeader(String name,
 long date)

Specified by:

addDateHeader in interface HttpServletResponse

Overrides:

addDateHeader in class HttpServletResponseWrapper

setHeader

public void setHeader(String name,
 String value)

Specified by:

setHeader in interface HttpServletResponse

Overrides:

setHeader in class HttpServletResponseWrapper

addHeader

public void addHeader(String name,
 String value)

Specified by:

addHeader in interface HttpServletResponse

Overrides:

addHeader in class HttpServletResponseWrapper

setIntHeader

public void setIntHeader(String name,
 int value)

Specified by:

setIntHeader in interface HttpServletResponse

Overrides:

setIntHeader in class HttpServletResponseWrapper

addIntHeader

public void addIntHeader(String name,
 int value)

Specified by:

addIntHeader in interface HttpServletResponse

Overrides:

addIntHeader in class HttpServletResponseWrapper

setStatus

public void setStatus(int status)

Specified by:

setStatus in interface HttpServletResponse

Overrides:

setStatus in class HttpServletResponseWrapper

getStatus

public int getStatus()

Specified by:

getStatus in interface HttpServletResponse

Overrides:

getStatus in class HttpServletResponseWrapper

getResponse

public ServletResponse getResponse()

Specified by:

getResponse in interface AtmosphereResponse

Overrides:

getResponse in class ServletResponseWrapper

getStatusMessage

public String getStatusMessage()

Specified by:

getStatusMessage in interface AtmosphereResponse

headers

public Map<String,String> headers()

Specified by:

headers in interface AtmosphereResponse

getHeader

public String getHeader(String name)

Specified by:

getHeader in interface HttpServletResponse

Overrides:

getHeader in class HttpServletResponseWrapper

getHeaders

public Collection<String> getHeaders(String name)

Specified by:

getHeaders in interface HttpServletResponse

Overrides:

getHeaders in class HttpServletResponseWrapper

getHeaderNames

public Collection<String> getHeaderNames()

Specified by:

getHeaderNames in interface HttpServletResponse

Overrides:

getHeaderNames in class HttpServletResponseWrapper

setCharacterEncoding

public void setCharacterEncoding(String charSet)

Specified by:

setCharacterEncoding in interface ServletResponse

Overrides:

setCharacterEncoding in class ServletResponseWrapper

flushBuffer

public void flushBuffer()
                 throws IOException

Specified by:

flushBuffer in interface ServletResponse

Overrides:

flushBuffer in class ServletResponseWrapper

Throws:

IOException

getBufferSize

public int getBufferSize()

Specified by:

getBufferSize in interface ServletResponse

Overrides:

getBufferSize in class ServletResponseWrapper

getCharacterEncoding

public String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface ServletResponse

Overrides:

getCharacterEncoding in class ServletResponseWrapper

isDestroyable

public boolean isDestroyable()

Description copied from interface: AtmosphereResponse

Check if this object can be destroyed. Default is true.

Specified by:

isDestroyable in interface AtmosphereResponse

destroyable

public AtmosphereResponse destroyable(boolean destroyable)

Specified by:

destroyable in interface AtmosphereResponse

getOutputStream

public ServletOutputStream getOutputStream()
                                    throws IOException

Specified by:

getOutputStream in interface ServletResponse

Overrides:

getOutputStream in class ServletResponseWrapper

Throws:

IOException

getWriter

public PrintWriter getWriter()
                      throws IOException

Specified by:

getWriter in interface ServletResponse

Overrides:

getWriter in class ServletResponseWrapper

Throws:

IOException

setContentLength

public void setContentLength(int len)

Specified by:

setContentLength in interface ServletResponse

Overrides:

setContentLength in class ServletResponseWrapper

setContentType

public void setContentType(String contentType)

Specified by:

setContentType in interface ServletResponse

Overrides:

setContentType in class ServletResponseWrapper

getContentType

public String getContentType()

Specified by:

getContentType in interface ServletResponse

Overrides:

getContentType in class ServletResponseWrapper

isCommitted

public boolean isCommitted()

Specified by:

isCommitted in interface ServletResponse

Overrides:

isCommitted in class ServletResponseWrapper

reset

public void reset()

Specified by:

reset in interface ServletResponse

Overrides:

reset in class ServletResponseWrapper

resetBuffer

public void resetBuffer()

Specified by:

resetBuffer in interface ServletResponse

Overrides:

resetBuffer in class ServletResponseWrapper

setBufferSize

public void setBufferSize(int size)

Specified by:

setBufferSize in interface ServletResponse

Overrides:

setBufferSize in class ServletResponseWrapper

setLocale

public void setLocale(Locale locale)

Specified by:

setLocale in interface ServletResponse

Overrides:

setLocale in class ServletResponseWrapper

getLocale

public Locale getLocale()

Specified by:

getLocale in interface ServletResponse

Overrides:

getLocale in class ServletResponseWrapper

getAsyncIOWriter

public AsyncIOWriter getAsyncIOWriter()

Description copied from interface: AtmosphereResponse

Return the underlying AsyncIOWriter.

Specified by:

getAsyncIOWriter in interface AtmosphereResponse

asyncIOWriter

public AtmosphereResponse asyncIOWriter(AsyncIOWriter asyncIOWriter)

Description copied from interface: AtmosphereResponse

Set an implementation of AsyncIOWriter that will be invoked every time a write operation is ready to be processed.

Specified by:

asyncIOWriter in interface AtmosphereResponse

Parameters:

asyncIOWriter - of AsyncIOWriter

Returns:

this

request

public AtmosphereRequest request()

Description copied from interface: AtmosphereResponse

Return the associated AtmosphereRequest.

Specified by:

request in interface AtmosphereResponse

Returns:

the associated AtmosphereRequest

request

public AtmosphereResponse request(AtmosphereRequest atmosphereRequest)

Description copied from interface: AtmosphereResponse

Set the associated AtmosphereRequest.

Specified by:

request in interface AtmosphereResponse

Parameters:

atmosphereRequest - a AtmosphereRequest

Returns:

this

close

public void close()
           throws IOException

Description copied from interface: AtmosphereResponse

Close the associated AsyncIOWriter.

Specified by:

close in interface AtmosphereResponse

Throws:

IOException

closeStreamOrWriter

public void closeStreamOrWriter()

Description copied from interface: AtmosphereResponse

Close the associated

invalid reference

PrintWriter

or OutputStream

Specified by:

closeStreamOrWriter in interface AtmosphereResponse

write

public AtmosphereResponse write(String data)

Description copied from interface: AtmosphereResponse

Write the String by either using the

invalid reference

PrintWriter

or OutputStream. The decision is based on the request attribute ApplicationConfig.PROPERTY_USE_STREAM

Specified by:

write in interface AtmosphereResponse

Parameters:

data - the String to write

write

public AtmosphereResponse write(String data,
 boolean writeUsingOriginalResponse)

Description copied from interface: AtmosphereResponse

Write the String by either using the

invalid reference

PrintWriter

or OutputStream. The decision is based on the request attribute ApplicationConfig.PROPERTY_USE_STREAM. If writeUsingOriginalResponse is set to true, execute the write without invoking the defined AsyncIOWriter.

Specified by:

write in interface AtmosphereResponse

Parameters:

data - the String to write

writeUsingOriginalResponse - if true, execute the write without invoking the AsyncIOWriter

write

public AtmosphereResponse write(byte[] data)

Description copied from interface: AtmosphereResponse

Write the bytes by either using the

invalid reference

PrintWriter

or OutputStream. The decision is based on the request attribute ApplicationConfig.PROPERTY_USE_STREAM.

Specified by:

write in interface AtmosphereResponse

Parameters:

data - the bytes to write

write

public AtmosphereResponse write(byte[] data,
 boolean writeUsingOriginalResponse)

Description copied from interface: AtmosphereResponse

Write the String by either using the

invalid reference

PrintWriter

or OutputStream. The decision is based on the request attribute ApplicationConfig.PROPERTY_USE_STREAM. If writeUsingOriginalResponse is set to true, execute the write without invoking the defined AsyncIOWriter.

Specified by:

write in interface AtmosphereResponse

Parameters:

data - the bytes to write

writeUsingOriginalResponse - if true, execute the write without invoking the AsyncIOWriter

write

public AtmosphereResponse write(byte[] data,
 int offset,
 int length)

Description copied from interface: AtmosphereResponse

Write the bytes by either using the

invalid reference

PrintWriter

or OutputStream. The decision is based on the request attribute ApplicationConfig.PROPERTY_USE_STREAM.

Specified by:

write in interface AtmosphereResponse

Parameters:

data - the bytes to write

offset - the first byte position to write

length - the data length

write

public AtmosphereResponse write(byte[] data,
 int offset,
 int length,
 boolean writeUsingOriginalResponse)

Description copied from interface: AtmosphereResponse

Write the String by either using the

invalid reference

PrintWriter

or OutputStream. The decision is based on the request attribute ApplicationConfig.PROPERTY_USE_STREAM. If writeUsingOriginalResponse is set to true, execute the write without invoking the defined AsyncIOWriter.

Specified by:

write in interface AtmosphereResponse

Parameters:

data - the bytes to write

offset - the first byte position to write

length - the data length

writeUsingOriginalResponse - if true, execute the write without invoking the AsyncIOWriter

resource

public AtmosphereResource resource()

Description copied from interface: AtmosphereResponse

The AtmosphereResource associated with this request. If the request hasn't been suspended, this method will return null.

Specified by:

resource in interface AtmosphereResponse

Returns:

an AtmosphereResource, or null.

setResponse

public void setResponse(ServletResponse response)

Specified by:

setResponse in interface AtmosphereResponse

Overrides:

setResponse in class ServletResponseWrapper

newInstance

public static AtmosphereResponse newInstance()

Create an instance not associated with any response parent.

newInstance

public static AtmosphereResponse newInstance(AtmosphereRequest request)

Create a new instance to use with WebSocket.

newInstance

public static AtmosphereResponse newInstance(AtmosphereConfig config,
 AtmosphereRequest request,
 WebSocket webSocket)

Create a new instance to use with WebSocket.

wrap

public static AtmosphereResponse wrap(HttpServletResponse response)

Wrap an HttpServletResponse

Parameters:

response - HttpServletResponse

Returns:

an AtmosphereResponse

uuid

public String uuid()

Description copied from interface: AtmosphereResponse

Return the AtmosphereResource.uuid() used by this object.

Specified by:

uuid in interface AtmosphereResponse

Returns:

the AtmosphereResource.uuid() used by this object.

toString

public String toString()

Overrides:

toString in class Object

onComplete

public void onComplete()

Specified by:

onComplete in interface CompletionAware

completed

public boolean completed()

Specified by:

completed in interface CompletionAware