org.atmosphere.cpr

Interface AtmosphereResponse

All Superinterfaces:

jakarta.servlet.http.HttpServletResponse, jakarta.servlet.ServletResponse

All Known Implementing Classes:

AtmosphereResponseImpl

public interface AtmosphereResponse
extends jakarta.servlet.http.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.

Author:

Jeanfrancois Arcand

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	AtmosphereResponse.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

Method Summary

Modifier and Type	Method and Description
void	addCookie(jakarta.servlet.http.Cookie cookie)
void	addDateHeader(java.lang.String name, long date)
void	addHeader(java.lang.String name, java.lang.String value)
void	addIntHeader(java.lang.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 PrintWriter or OutputStream
boolean	containsHeader(java.lang.String name)
AtmosphereResponse	delegateToNativeResponse(boolean delegateToNativeResponse)
void	destroy()
void	destroy(boolean force)
AtmosphereResponse	destroyable(boolean destroyable)
boolean	destroyed()
java.lang.String	encodeRedirectUrl(java.lang.String url)
java.lang.String	encodeRedirectURL(java.lang.String url)
java.lang.String	encodeUrl(java.lang.String url)
java.lang.String	encodeURL(java.lang.String url)
void	flushBuffer()
AsyncIOWriter	getAsyncIOWriter() Return the underlying AsyncIOWriter.
int	getBufferSize()
java.lang.String	getCharacterEncoding()
java.lang.String	getContentType()
java.lang.String	getHeader(java.lang.String name)
java.util.Collection<java.lang.String>	getHeaderNames()
java.util.Collection<java.lang.String>	getHeaders(java.lang.String name)
java.util.Locale	getLocale()
jakarta.servlet.ServletOutputStream	getOutputStream()
jakarta.servlet.ServletResponse	getResponse()
int	getStatus()
java.lang.String	getStatusMessage()
java.io.PrintWriter	getWriter()
java.util.Map<java.lang.String,java.lang.String>	headers()
boolean	isCommitted()
boolean	isDestroyable() Check if this object can be destroyed.
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, java.lang.String msg)
void	sendRedirect(java.lang.String location)
void	setBufferSize(int size)
void	setCharacterEncoding(java.lang.String charSet)
void	setContentLength(int len)
void	setContentType(java.lang.String contentType)
void	setDateHeader(java.lang.String name, long date)
void	setHeader(java.lang.String name, java.lang.String value)
void	setIntHeader(java.lang.String name, int value)
void	setLocale(java.util.Locale locale)
void	setResponse(jakarta.servlet.ServletResponse response)
void	setStatus(int status)
void	setStatus(int status, java.lang.String statusMessage)
java.lang.String	toString()
java.lang.String	uuid() Return the AtmosphereResource.uuid() used by this object.
AtmosphereResponse	write(byte[] data) Write the bytes by either using the PrintWriter or OutputStream.
AtmosphereResponse	write(byte[] data, boolean writeUsingOriginalResponse) Write the String by either using the PrintWriter or OutputStream.
AtmosphereResponse	write(byte[] data, int offset, int length) Write the bytes by either using the PrintWriter or OutputStream.
AtmosphereResponse	write(byte[] data, int offset, int length, boolean writeUsingOriginalResponse) Write the String by either using the PrintWriter or OutputStream.
AtmosphereResponse	write(java.lang.String data) Write the String by either using the PrintWriter or OutputStream.
AtmosphereResponse	write(java.lang.String data, boolean writeUsingOriginalResponse) Write the String by either using the PrintWriter or OutputStream.

Methods inherited from interface jakarta.servlet.http.HttpServletResponse

getTrailerFields, setTrailerFields

Methods inherited from interface jakarta.servlet.ServletResponse

setContentLengthLong

Method Detail

destroy

void destroy()

destroy

void destroy(boolean force)

destroyed

boolean destroyed()

addCookie

void addCookie(jakarta.servlet.http.Cookie cookie)

Specified by:

addCookie in interface jakarta.servlet.http.HttpServletResponse

containsHeader

boolean containsHeader(java.lang.String name)

Specified by:

containsHeader in interface jakarta.servlet.http.HttpServletResponse

encodeURL

java.lang.String encodeURL(java.lang.String url)

Specified by:

encodeURL in interface jakarta.servlet.http.HttpServletResponse

encodeRedirectURL

java.lang.String encodeRedirectURL(java.lang.String url)

Specified by:

encodeRedirectURL in interface jakarta.servlet.http.HttpServletResponse

encodeUrl

java.lang.String encodeUrl(java.lang.String url)

Specified by:

encodeUrl in interface jakarta.servlet.http.HttpServletResponse

encodeRedirectUrl

java.lang.String encodeRedirectUrl(java.lang.String url)

Specified by:

encodeRedirectUrl in interface jakarta.servlet.http.HttpServletResponse

delegateToNativeResponse

AtmosphereResponse delegateToNativeResponse(boolean delegateToNativeResponse)

sendError

void sendError(int sc,
               java.lang.String msg)
        throws java.io.IOException

Specified by:

sendError in interface jakarta.servlet.http.HttpServletResponse

Throws:

java.io.IOException

sendError

void sendError(int sc)
        throws java.io.IOException

Specified by:

sendError in interface jakarta.servlet.http.HttpServletResponse

Throws:

java.io.IOException

sendRedirect

void sendRedirect(java.lang.String location)
           throws java.io.IOException

Specified by:

sendRedirect in interface jakarta.servlet.http.HttpServletResponse

Throws:

java.io.IOException

setDateHeader

void setDateHeader(java.lang.String name,
                   long date)

Specified by:

setDateHeader in interface jakarta.servlet.http.HttpServletResponse

addDateHeader

void addDateHeader(java.lang.String name,
                   long date)

Specified by:

addDateHeader in interface jakarta.servlet.http.HttpServletResponse

setHeader

void setHeader(java.lang.String name,
               java.lang.String value)

Specified by:

setHeader in interface jakarta.servlet.http.HttpServletResponse

addHeader

void addHeader(java.lang.String name,
               java.lang.String value)

Specified by:

addHeader in interface jakarta.servlet.http.HttpServletResponse

setIntHeader

void setIntHeader(java.lang.String name,
                  int value)

Specified by:

setIntHeader in interface jakarta.servlet.http.HttpServletResponse

addIntHeader

void addIntHeader(java.lang.String name,
                  int value)

Specified by:

addIntHeader in interface jakarta.servlet.http.HttpServletResponse

setStatus

void setStatus(int status)

Specified by:

setStatus in interface jakarta.servlet.http.HttpServletResponse

setStatus

void setStatus(int status,
               java.lang.String statusMessage)

Specified by:

setStatus in interface jakarta.servlet.http.HttpServletResponse

getStatus

int getStatus()

Specified by:

getStatus in interface jakarta.servlet.http.HttpServletResponse

getResponse

jakarta.servlet.ServletResponse getResponse()

getStatusMessage

java.lang.String getStatusMessage()

headers

java.util.Map<java.lang.String,java.lang.String> headers()

getHeader

java.lang.String getHeader(java.lang.String name)

Specified by:

getHeader in interface jakarta.servlet.http.HttpServletResponse

getHeaders

java.util.Collection<java.lang.String> getHeaders(java.lang.String name)

Specified by:

getHeaders in interface jakarta.servlet.http.HttpServletResponse

getHeaderNames

java.util.Collection<java.lang.String> getHeaderNames()

Specified by:

getHeaderNames in interface jakarta.servlet.http.HttpServletResponse

setCharacterEncoding

void setCharacterEncoding(java.lang.String charSet)

Specified by:

setCharacterEncoding in interface jakarta.servlet.ServletResponse

flushBuffer

void flushBuffer()
          throws java.io.IOException

Specified by:

flushBuffer in interface jakarta.servlet.ServletResponse

Throws:

java.io.IOException

getBufferSize

int getBufferSize()

Specified by:

getBufferSize in interface jakarta.servlet.ServletResponse

getCharacterEncoding

java.lang.String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface jakarta.servlet.ServletResponse

isDestroyable

boolean isDestroyable()

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

destroyable

AtmosphereResponse destroyable(boolean destroyable)

getOutputStream

jakarta.servlet.ServletOutputStream getOutputStream()
                                             throws java.io.IOException

Specified by:

getOutputStream in interface jakarta.servlet.ServletResponse

Throws:

java.io.IOException

getWriter

java.io.PrintWriter getWriter()
                       throws java.io.IOException

Specified by:

getWriter in interface jakarta.servlet.ServletResponse

Throws:

java.io.IOException

setContentLength

void setContentLength(int len)

Specified by:

setContentLength in interface jakarta.servlet.ServletResponse

setContentType

void setContentType(java.lang.String contentType)

Specified by:

setContentType in interface jakarta.servlet.ServletResponse

getContentType

java.lang.String getContentType()

Specified by:

getContentType in interface jakarta.servlet.ServletResponse

isCommitted

boolean isCommitted()

Specified by:

isCommitted in interface jakarta.servlet.ServletResponse

reset

void reset()

Specified by:

reset in interface jakarta.servlet.ServletResponse

resetBuffer

void resetBuffer()

Specified by:

resetBuffer in interface jakarta.servlet.ServletResponse

setBufferSize

void setBufferSize(int size)

Specified by:

setBufferSize in interface jakarta.servlet.ServletResponse

setLocale

void setLocale(java.util.Locale locale)

Specified by:

setLocale in interface jakarta.servlet.ServletResponse

getLocale

java.util.Locale getLocale()

Specified by:

getLocale in interface jakarta.servlet.ServletResponse

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

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 java.io.IOException

Close the associated AsyncIOWriter.

Throws:

java.io.IOException

closeStreamOrWriter

void closeStreamOrWriter()

Close the associated PrintWriter or OutputStream

write

AtmosphereResponse write(java.lang.String data)

Write the String by either using the PrintWriter or OutputStream. The decision is based on the request attribute ApplicationConfig.PROPERTY_USE_STREAM

Parameters:

data - the String to write

write

AtmosphereResponse write(java.lang.String data,
                         boolean writeUsingOriginalResponse)

Write the String by either using the 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 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 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 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 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(jakarta.servlet.ServletResponse response)

uuid

java.lang.String uuid()

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

Returns:

the AtmosphereResource.uuid() used by this object.

toString

java.lang.String toString()

Overrides:

toString in class java.lang.Object