public class AdaptingContainerResponse extends ContainerResponse
ContainerResponse.| Modifier and Type | Field and Description |
|---|---|
protected ContainerResponse |
acr
The adapted container response.
|
| Modifier | Constructor and Description |
|---|---|
protected |
AdaptingContainerResponse(ContainerResponse acr)
Create the adapting container response.
|
| Modifier and Type | Method and Description |
|---|---|
java.lang.annotation.Annotation[] |
getAnnotations()
Get the annotations associated with the response entity (if any).
|
ContainerRequest |
getContainerRequest()
Get the container request.
|
ContainerResponseWriter |
getContainerResponseWriter()
Get the container response writer.
|
java.lang.Object |
getEntity() |
java.lang.reflect.Type |
getEntityType() |
MultivaluedMap<java.lang.String,java.lang.Object> |
getHttpHeaders()
Get the HTTP response headers.
|
java.lang.Throwable |
getMappedThrowable()
Get the throwable (if any) that was mapped to a response.
|
MediaType |
getMediaType()
Get the media type of the response entity.
|
MessageBodyWorkers |
getMessageBodyWorkers()
Get the message body workers.
|
java.lang.Object |
getOriginalEntity()
Get the original entity instance that was set by
HttpResponseContext.setEntity(java.lang.Object). |
java.io.OutputStream |
getOutputStream()
Get an
OutputStream to which an entity may be written. |
Response |
getResponse()
Get the response that was set.
|
int |
getStatus() |
Response.StatusType |
getStatusType() |
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.
|
boolean |
mapException(java.lang.Throwable e)
Map an exception to a response.
|
void |
mapMappableContainerException(MappableContainerException e)
Map the cause of a mappable container exception to a response.
|
void |
mapWebApplicationException(WebApplicationException e)
Map a web application exception to a response.
|
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 |
setContainerRequest(ContainerRequest request)
Set the container request.
|
void |
setContainerResponseWriter(ContainerResponseWriter responseWriter)
Set the container response writer.
|
void |
setEntity(java.lang.Object entity)
Set the entity of the response.
|
void |
setEntity(java.lang.Object entity,
java.lang.reflect.Type entityType) |
void |
setResponse(Response response)
Set the response state from a Response instance.
|
void |
setStatus(int status)
Set the status of the response.
|
void |
setStatusType(Response.StatusType statusType)
Set the status type of the response.
|
void |
write()
Write the response.
|
getHeaderValueprotected final ContainerResponse acr
protected AdaptingContainerResponse(ContainerResponse acr)
acr - the container response to adapt.public void write()
throws java.io.IOException
ContainerResponse
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.
write in class ContainerResponsejava.io.IOException - if there is an error writing the entitypublic void reset()
ContainerResponsereset in class ContainerResponsepublic ContainerRequest getContainerRequest()
ContainerResponsegetContainerRequest in class ContainerResponsepublic void setContainerRequest(ContainerRequest request)
ContainerResponsesetContainerRequest in class ContainerResponserequest - the container request.public ContainerResponseWriter getContainerResponseWriter()
ContainerResponsegetContainerResponseWriter in class ContainerResponsepublic void setContainerResponseWriter(ContainerResponseWriter responseWriter)
ContainerResponsesetContainerResponseWriter in class ContainerResponseresponseWriter - the container response writerpublic MessageBodyWorkers getMessageBodyWorkers()
ContainerResponsegetMessageBodyWorkers in class ContainerResponsepublic void mapMappableContainerException(MappableContainerException e)
ContainerResponseIf the cause cannot be mapped and then that cause is re-thrown if a runtime exception otherwise the mappable container exception is re-thrown.
mapMappableContainerException in class ContainerResponsee - the mappable container exception whose cause will be mapped to
a response.public void mapWebApplicationException(WebApplicationException e)
ContainerResponsemapWebApplicationException in class ContainerResponsee - the web application exception.public boolean mapException(java.lang.Throwable e)
ContainerResponsemapException in class ContainerResponsee - the exception.public Response getResponse()
HttpResponseContextgetResponse in interface HttpResponseContextgetResponse in class ContainerResponsepublic void setResponse(Response response)
HttpResponseContextsetResponse in interface HttpResponseContextsetResponse in class ContainerResponseresponse - the response.public boolean isResponseSet()
HttpResponseContextisResponseSet in interface HttpResponseContextisResponseSet in class ContainerResponsepublic java.lang.Throwable getMappedThrowable()
HttpResponseContextgetMappedThrowable in interface HttpResponseContextgetMappedThrowable in class ContainerResponsepublic Response.StatusType getStatusType()
getStatusType in interface HttpResponseContextgetStatusType in class ContainerResponsepublic void setStatusType(Response.StatusType statusType)
HttpResponseContextsetStatusType in interface HttpResponseContextsetStatusType in class ContainerResponsestatusType - the status type.public int getStatus()
getStatus in interface HttpResponseContextgetStatus in class ContainerResponsepublic void setStatus(int status)
HttpResponseContextsetStatus in interface HttpResponseContextsetStatus in class ContainerResponsestatus - the status.public java.lang.Object getEntity()
getEntity in interface HttpResponseContextgetEntity in class ContainerResponsepublic java.lang.reflect.Type getEntityType()
getEntityType in interface HttpResponseContextgetEntityType in class ContainerResponsepublic java.lang.Object getOriginalEntity()
HttpResponseContextHttpResponseContext.setEntity(java.lang.Object).getOriginalEntity in interface HttpResponseContextgetOriginalEntity in class ContainerResponsepublic void setEntity(java.lang.Object entity)
HttpResponseContext
If the entity is an instance of GenericEntity then the entity
and entity type are set from the entity and type of that
GenericEntity. Otherwise, the entity is set from the entity
parameter and the type is the class of that parameter.
If it is necessary to wrap an entity that may have been set with an
instance of GenericEntity then utilize the
HttpResponseContext.getOriginalEntity(), for example:
HttpResponseContext r = ...
r.setEntity(wrap(getOriginalEntity()));
setEntity in interface HttpResponseContextsetEntity in class ContainerResponseentity - the entity.public void setEntity(java.lang.Object entity,
java.lang.reflect.Type entityType)
setEntity in class ContainerResponsepublic java.lang.annotation.Annotation[] getAnnotations()
HttpResponseContextgetAnnotations in interface HttpResponseContextgetAnnotations in class ContainerResponsepublic void setAnnotations(java.lang.annotation.Annotation[] annotations)
HttpResponseContextsetAnnotations in interface HttpResponseContextsetAnnotations in class ContainerResponseannotations - the annotations.public MultivaluedMap<java.lang.String,java.lang.Object> getHttpHeaders()
HttpResponseContextHttpResponseContext.setResponse(javax.ws.rs.core.Response)
will replace any headers previously set.getHttpHeaders in interface HttpResponseContextgetHttpHeaders in class ContainerResponsepublic MediaType getMediaType()
HttpResponseContextgetMediaType in interface HttpResponseContextgetMediaType in class ContainerResponsepublic java.io.OutputStream getOutputStream()
throws java.io.IOException
HttpResponseContextOutputStream 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 HttpResponseContextgetOutputStream in class ContainerResponsejava.io.IOException - if an IO error occurspublic boolean isCommitted()
HttpResponseContextA response is committed if the status code, headers have been written to the container.
isCommitted in interface HttpResponseContextisCommitted in class ContainerResponseCopyright © 2016 Oracle Corporation. All Rights Reserved.