|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.sun.jersey.spi.container.ContainerResponse
public class ContainerResponse
An out-bound HTTP response to be processed by the web application.
Containers instantiate, or inherit, and provide an instance to the
WebApplication
.
Constructor Summary | |
---|---|
ContainerResponse(WebApplication wa,
ContainerRequest request,
ContainerResponseWriter responseWriter)
Instantate a new ContainerResponse. |
Method Summary | |
---|---|
java.lang.annotation.Annotation[] |
getAnnotations()
Get the annotations associated with the response entity (if any). |
ContainerResponseWriter |
getContainerResponseWriter()
Get the container response writer. |
java.lang.Object |
getEntity()
|
java.lang.reflect.Type |
getEntityType()
|
static java.lang.String |
getHeaderValue(java.lang.Object headerValue)
Convert a header value, represented as a general object, to the string value. |
javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.Object> |
getHttpHeaders()
Get the HTTP response headers. |
java.io.OutputStream |
getOutputStream()
Get an OutputStream to which an entity may be written. |
javax.ws.rs.core.Response |
getResponse()
Get the response that was set. |
int |
getStatus()
|
boolean |
isCommitted()
Ascertain if a response has been committed to the container. |
boolean |
isResponseSet()
Check if the response has been set using the setReponse methods. |
void |
reset()
Reset the response to 204 (No content) with no headers. |
void |
setAnnotations(java.lang.annotation.Annotation[] annotations)
Set the annotations associated with the response entity (if any). |
void |
setContainerResponseWriter(ContainerResponseWriter responseWriter)
Set the container response writer. |
void |
setEntity(java.lang.Object entity)
Set the entity of the response. |
void |
setResponse(javax.ws.rs.core.Response response)
Set the response state from a Response instance. |
void |
setResponse(javax.ws.rs.core.Response r,
javax.ws.rs.core.MediaType contentType)
Set the response state from a Response instance. |
void |
setStatus(int status)
Set the status of the response. |
void |
write()
Write the response. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ContainerResponse(WebApplication wa, ContainerRequest request, ContainerResponseWriter responseWriter)
wa
- the web application.request
- the container request associated with this response.responseWriter
- the response writerMethod Detail |
---|
public static java.lang.String getHeaderValue(java.lang.Object headerValue)
This method defers to RuntimeDelegate.createHeaderDelegate(java.lang.Class
to
obtain a RuntimeDelegate.HeaderDelegate
to convert the value to a string.
Containers may use this method to convert the header values obtained
from the getHttpHeaders()
headerValue
- the header value as an object
public void write() throws java.io.IOException
The status and headers will be written by calling the method
ContainerResponseWriter.writeStatusAndHeaders(long, com.sun.jersey.spi.container.ContainerResponse)
on the provided
ContainerResponseWriter
instance. The OutputStream
returned from that method call is used to write the entity (if any)
to that OutputStream
. An appropriate MessageBodyWriter
will be found to write the entity.
javax.ws.rs.WebApplicationException
- if MessageBodyWriter
cannot be
found for the entity with a 406 (Not Acceptable) response.
java.io.IOException
- if there is an error writing the entitypublic void reset()
public ContainerResponseWriter getContainerResponseWriter()
public void setContainerResponseWriter(ContainerResponseWriter responseWriter)
responseWriter
- the container response writerpublic javax.ws.rs.core.Response getResponse()
HttpResponseContext
getResponse
in interface HttpResponseContext
public void setResponse(javax.ws.rs.core.Response response)
HttpResponseContext
setResponse
in interface HttpResponseContext
response
- the response.public void setResponse(javax.ws.rs.core.Response r, javax.ws.rs.core.MediaType contentType)
HttpResponseContext
setResponse
in interface HttpResponseContext
r
- the response.contentType
- the MIME media type to use for the Content-Type response
header if the header is not set by the response.public boolean isResponseSet()
HttpResponseContext
isResponseSet
in interface HttpResponseContext
public int getStatus()
getStatus
in interface HttpResponseContext
public void setStatus(int status)
HttpResponseContext
setStatus
in interface HttpResponseContext
status
- the status.public java.lang.Object getEntity()
getEntity
in interface HttpResponseContext
public java.lang.reflect.Type getEntityType()
getEntityType
in interface HttpResponseContext
public void setEntity(java.lang.Object entity)
HttpResponseContext
setEntity
in interface HttpResponseContext
entity
- the entity. If the entity is an instance of
GenericEntity
then the entity and entity type are
set from the entity and type of that GenericEntity
.public java.lang.annotation.Annotation[] getAnnotations()
HttpResponseContext
getAnnotations
in interface HttpResponseContext
public void setAnnotations(java.lang.annotation.Annotation[] annotations)
HttpResponseContext
setAnnotations
in interface HttpResponseContext
annotations
- the annotations.public javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.Object> getHttpHeaders()
HttpResponseContext
HttpResponseContext.setResponse(javax.ws.rs.core.Response)
will replace any headers previously set.
getHttpHeaders
in interface HttpResponseContext
public java.io.OutputStream getOutputStream() throws java.io.IOException
HttpResponseContext
OutputStream
to which an entity may be written.
The first byte written will result in the writing of thethe status code and headers.
getOutputStream
in interface HttpResponseContext
java.io.IOException
- if an IO error occurspublic boolean isCommitted()
HttpResponseContext
A response is committed if the status code, headers have been written to the container.
isCommitted
in interface HttpResponseContext
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |