public interface AtmosphereResponse
extends javax.servlet.http.HttpServletResponse
AtmosphereResource
has been
suspended, this object can be used to write message back to the client at any moment.
AsyncIOWriter
.Modifier and Type | Interface and Description |
---|---|
static interface |
AtmosphereResponse.Builder |
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
Modifier and Type | Method and Description |
---|---|
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) |
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(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() |
javax.servlet.ServletOutputStream |
getOutputStream() |
javax.servlet.ServletResponse |
getResponse() |
int |
getStatus() |
String |
getStatusMessage() |
PrintWriter |
getWriter() |
Map<String,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,
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(javax.servlet.ServletResponse response) |
void |
setStatus(int status) |
void |
setStatus(int status,
String statusMessage) |
String |
toString() |
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(String data)
Write the String by either using the
PrintWriter or OutputStream . |
AtmosphereResponse |
write(String data,
boolean writeUsingOriginalResponse)
Write the String by either using the
PrintWriter or OutputStream . |
void destroy()
void destroy(boolean force)
boolean destroyed()
void addCookie(javax.servlet.http.Cookie cookie)
addCookie
in interface javax.servlet.http.HttpServletResponse
boolean containsHeader(String name)
containsHeader
in interface javax.servlet.http.HttpServletResponse
String encodeURL(String url)
encodeURL
in interface javax.servlet.http.HttpServletResponse
String encodeRedirectURL(String url)
encodeRedirectURL
in interface javax.servlet.http.HttpServletResponse
String encodeUrl(String url)
encodeUrl
in interface javax.servlet.http.HttpServletResponse
String encodeRedirectUrl(String url)
encodeRedirectUrl
in interface javax.servlet.http.HttpServletResponse
AtmosphereResponse delegateToNativeResponse(boolean delegateToNativeResponse)
void sendError(int sc, String msg) throws IOException
sendError
in interface javax.servlet.http.HttpServletResponse
IOException
void sendError(int sc) throws IOException
sendError
in interface javax.servlet.http.HttpServletResponse
IOException
void sendRedirect(String location) throws IOException
sendRedirect
in interface javax.servlet.http.HttpServletResponse
IOException
void setDateHeader(String name, long date)
setDateHeader
in interface javax.servlet.http.HttpServletResponse
void addDateHeader(String name, long date)
addDateHeader
in interface javax.servlet.http.HttpServletResponse
void setHeader(String name, String value)
setHeader
in interface javax.servlet.http.HttpServletResponse
void addHeader(String name, String value)
addHeader
in interface javax.servlet.http.HttpServletResponse
void setIntHeader(String name, int value)
setIntHeader
in interface javax.servlet.http.HttpServletResponse
void addIntHeader(String name, int value)
addIntHeader
in interface javax.servlet.http.HttpServletResponse
void setStatus(int status)
setStatus
in interface javax.servlet.http.HttpServletResponse
void setStatus(int status, String statusMessage)
setStatus
in interface javax.servlet.http.HttpServletResponse
int getStatus()
getStatus
in interface javax.servlet.http.HttpServletResponse
javax.servlet.ServletResponse getResponse()
String getStatusMessage()
String getHeader(String name)
getHeader
in interface javax.servlet.http.HttpServletResponse
Collection<String> getHeaders(String name)
getHeaders
in interface javax.servlet.http.HttpServletResponse
Collection<String> getHeaderNames()
getHeaderNames
in interface javax.servlet.http.HttpServletResponse
void setCharacterEncoding(String charSet)
setCharacterEncoding
in interface javax.servlet.ServletResponse
void flushBuffer() throws IOException
flushBuffer
in interface javax.servlet.ServletResponse
IOException
int getBufferSize()
getBufferSize
in interface javax.servlet.ServletResponse
String getCharacterEncoding()
getCharacterEncoding
in interface javax.servlet.ServletResponse
boolean isDestroyable()
AtmosphereResponse destroyable(boolean destroyable)
javax.servlet.ServletOutputStream getOutputStream() throws IOException
getOutputStream
in interface javax.servlet.ServletResponse
IOException
PrintWriter getWriter() throws IOException
getWriter
in interface javax.servlet.ServletResponse
IOException
void setContentLength(int len)
setContentLength
in interface javax.servlet.ServletResponse
void setContentType(String contentType)
setContentType
in interface javax.servlet.ServletResponse
String getContentType()
getContentType
in interface javax.servlet.ServletResponse
boolean isCommitted()
isCommitted
in interface javax.servlet.ServletResponse
void reset()
reset
in interface javax.servlet.ServletResponse
void resetBuffer()
resetBuffer
in interface javax.servlet.ServletResponse
void setBufferSize(int size)
setBufferSize
in interface javax.servlet.ServletResponse
void setLocale(Locale locale)
setLocale
in interface javax.servlet.ServletResponse
Locale getLocale()
getLocale
in interface javax.servlet.ServletResponse
AsyncIOWriter getAsyncIOWriter()
AsyncIOWriter
.AtmosphereResponse asyncIOWriter(AsyncIOWriter asyncIOWriter)
AsyncIOWriter
that will be invoked every time a write operation is ready to be
processed.asyncIOWriter
- of AsyncIOWriter
AtmosphereRequest request()
AtmosphereRequest
.AtmosphereRequest
AtmosphereResponse request(AtmosphereRequest atmosphereRequest)
AtmosphereRequest
.atmosphereRequest
- a AtmosphereRequest
void close() throws IOException
AsyncIOWriter
.IOException
void closeStreamOrWriter()
PrintWriter
or OutputStream
AtmosphereResponse write(String data)
PrintWriter
or OutputStream
. The decision is
based on the request attribute ApplicationConfig.PROPERTY_USE_STREAM
data
- the String to writeAtmosphereResponse write(String data, boolean writeUsingOriginalResponse)
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
.data
- the String to writewriteUsingOriginalResponse
- if true, execute the write without invoking the AsyncIOWriter
AtmosphereResponse write(byte[] data)
PrintWriter
or OutputStream
. The decision is
based on the request attribute ApplicationConfig.PROPERTY_USE_STREAM
.data
- the bytes to writeAtmosphereResponse write(byte[] data, boolean writeUsingOriginalResponse)
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
.data
- the bytes to writewriteUsingOriginalResponse
- if true, execute the write without invoking the AsyncIOWriter
AtmosphereResponse write(byte[] data, int offset, int length)
PrintWriter
or OutputStream
. The decision is
based on the request attribute ApplicationConfig.PROPERTY_USE_STREAM
.data
- the bytes to writeoffset
- the first byte position to writelength
- the data lengthAtmosphereResponse write(byte[] data, int offset, int length, boolean writeUsingOriginalResponse)
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
.data
- the bytes to writeoffset
- the first byte position to writelength
- the data lengthwriteUsingOriginalResponse
- if true, execute the write without invoking the AsyncIOWriter
AtmosphereResource resource()
AtmosphereResource
associated with this request. If the request hasn't been suspended, this
method will return null.AtmosphereResource
, or null.void setResponse(javax.servlet.ServletResponse response)
String uuid()
AtmosphereResource.uuid()
used by this object.AtmosphereResource.uuid()
used by this object.Copyright © 2016. All rights reserved.