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