Package org.atmosphere.cpr

Interface AtmosphereResponse

All Superinterfaces:

HttpServletResponse, ServletResponse

All Known Implementing Classes:

AtmosphereResponseImpl

public interface AtmosphereResponse
extends HttpServletResponse

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	Interface	Description
static interface	AtmosphereResponse.Builder
static interface	AtmosphereResponse.WriteAction<E extends Exception>	Something run while the response writes through another writer (writeThrough(org.atmosphere.cpr.AsyncIOWriter, org.atmosphere.cpr.AtmosphereResponse.WriteAction<E>)).

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

Method Summary

Modifier and Type	Method	Description
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
AtmosphereResponse	delegateToNativeResponse(boolean delegateToNativeResponse)
void	destroy()
void	destroy(boolean force)
AtmosphereResponse	destroyable(boolean destroyable)
boolean	destroyed()
AsyncIOWriter	getAsyncIOWriter()	Return the underlying AsyncIOWriter.
ServletResponse	getResponse()
String	getStatusMessage()
Map<String,String>	headers()
boolean	isDestroyable()	Check if this object can be destroyed.
AtmosphereRequest	request()	Return the associated AtmosphereRequest.
AtmosphereResponse	request(AtmosphereRequest atmosphereRequest)	Set the associated AtmosphereRequest.
AtmosphereResource	resource()	The AtmosphereResource associated with this request.
void	setResponse(ServletResponse response)
String	uuid()	Return the AtmosphereResource.uuid() used by this object.
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.
default <E extends Exception> void	writeThrough(AsyncIOWriter writer, AtmosphereResponse.WriteAction<E> action)	Run action with this response writing through writer on the calling thread only, then through its own writer again; another thread writing to the response meanwhile writes through its own writer.

Methods inherited from interface jakarta.servlet.http.HttpServletResponse

addCookie, addDateHeader, addHeader, addIntHeader, containsHeader, encodeRedirectUrl, encodeRedirectURL, encodeUrl, encodeURL, getHeader, getHeaderNames, getHeaders, getStatus, getTrailerFields, sendError, sendError, sendRedirect, setDateHeader, setHeader, setIntHeader, setStatus, setStatus, setTrailerFields

Methods inherited from interface jakarta.servlet.ServletResponse

flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getWriter, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentLengthLong, setContentType, setLocale

Method Details

destroy

void destroy()

destroy

void destroy(boolean force)

destroyed

boolean destroyed()

delegateToNativeResponse

AtmosphereResponse delegateToNativeResponse(boolean delegateToNativeResponse)

getResponse

ServletResponse getResponse()

getStatusMessage

String getStatusMessage()

headers

Map<String,String> headers()

isDestroyable

boolean isDestroyable()

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

destroyable

AtmosphereResponse destroyable(boolean destroyable)

getAsyncIOWriter

AsyncIOWriter getAsyncIOWriter()

Return the underlying AsyncIOWriter.

asyncIOWriter

AtmosphereResponse asyncIOWriter(AsyncIOWriter asyncIOWriter)

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

Parameters:

asyncIOWriter - of AsyncIOWriter

Returns:

this

writeThrough

default <E extends Exception> void writeThrough(AsyncIOWriter writer,
 AtmosphereResponse.WriteAction<E> action)
                                         throws E

Run action with this response writing through writer on the calling thread only, then through its own writer again; another thread writing to the response meanwhile writes through its own writer. This default installs writer for every thread while action runs.

Type Parameters:

E - what action may throw

Parameters:

writer - the writer to write through while action runs

action - what writes to the response through writer

Throws:

E - when action throws it

request

AtmosphereRequest request()

Return the associated AtmosphereRequest.

Returns:

the associated AtmosphereRequest

request

AtmosphereResponse request(AtmosphereRequest atmosphereRequest)

Set the associated AtmosphereRequest.

Parameters:

atmosphereRequest - a AtmosphereRequest

Returns:

this

close

void close()
    throws IOException

Close the associated AsyncIOWriter.

Throws:

IOException

closeStreamOrWriter

void closeStreamOrWriter()

Close the associated

invalid reference

PrintWriter

or OutputStream

write

AtmosphereResponse write(String data)

Write the String by either using the

invalid reference

PrintWriter

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

Parameters:

data - the String to write

write

AtmosphereResponse write(String data,
 boolean writeUsingOriginalResponse)

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.

Parameters:

data - the String to write

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

write

AtmosphereResponse write(byte[] data)

Write the bytes by either using the

invalid reference

PrintWriter

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

Parameters:

data - the bytes to write

write

AtmosphereResponse write(byte[] data,
 boolean writeUsingOriginalResponse)

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.

Parameters:

data - the bytes to write

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

write

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

Write the bytes by either using the

invalid reference

PrintWriter

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

Parameters:

data - the bytes to write

offset - the first byte position to write

length - the data length

write

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

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.

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

AtmosphereResource resource()

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

Returns:

an AtmosphereResource, or null.

setResponse

void setResponse(ServletResponse response)

uuid

String uuid()

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

Returns:

the AtmosphereResource.uuid() used by this object.