com.cerner.beadledom.resteasy

Class BuiltGenericResponse<T>

java.lang.Object

javax.ws.rs.core.Response

org.jboss.resteasy.specimpl.BuiltResponse

com.cerner.beadledom.resteasy.BuiltGenericResponse<T>

All Implemented Interfaces:

GenericResponse<T>, Closeable, AutoCloseable

public class BuiltGenericResponse<T>
extends org.jboss.resteasy.specimpl.BuiltResponse
implements GenericResponse<T>

An extension of the resteasy BuiltResponse class with additional implementations for GenericResponse.

Consumers should avoid depending on this class directly instead preferring to depend on the GenericResponse or Response types. This class is necessary for the internal workings of Resteasy because Resteasy is heavily dependent on the BuiltResponse class.

Since:

1.3

Author:

John Leacox

See Also:

BuiltResponse, GenericResponse

Nested Class Summary

Nested classes/interfaces inherited from class javax.ws.rs.core.Response

javax.ws.rs.core.Response.ResponseBuilder, javax.ws.rs.core.Response.Status, javax.ws.rs.core.Response.StatusType

Field Summary

Fields inherited from class org.jboss.resteasy.specimpl.BuiltResponse

annotations, entity, entityClass, genericType, isClosed, metadata, processor, reason, status

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BuiltGenericResponse(T body, ErrorBody errorBody, javax.ws.rs.core.Response rawResponse)

Method Summary

Modifier and Type	Method and Description
T	body() Get the response entity body, null if no entity body is present.
boolean	bufferEntity()
void	close() Closes the underlying response input stream.
static <T> BuiltGenericResponse<T>	create(T body, javax.ws.rs.core.Response rawResponse) Creates a new instance of BuiltGenericResponse with the specified body and underlying rawResponse.
ErrorBody	errorBody() Get the error body, null if the response is not an error or no entity body is present.
Set<String>	getAllowedMethods() Gets the allowed HTTP methods.
Map<String,javax.ws.rs.core.NewCookie>	getCookies() Gets any new cookies on the response.
Date	getDate() Gets the resposne date, null if not present.
Object	getEntity()
Class<?>	getEntityClass()
javax.ws.rs.core.EntityTag	getEntityTag() Gets the entity tag.
Type	getGenericType()
javax.ws.rs.core.MultivaluedMap<String,Object>	getHeaders() Gets a view of the response headers.
String	getHeaderString(String name) Gets a response header as a string value.
Locale	getLanguage() Gets the language of the response entity, null if not specified.
Date	getLastModified() Gets the last modified date, null if not present.
int	getLength() Gets the Content-Length of the response if present, -1 otherwise.
javax.ws.rs.core.Link	getLink(String relation) Gets the link for the relation, null if not present.
javax.ws.rs.core.Link.Builder	getLinkBuilder(String relation) Returns a link builder for the relation, null if not present.
Set<javax.ws.rs.core.Link>	getLinks() Gets the links from the response headers.
URI	getLocation() Gets the location, null if not present.
javax.ws.rs.core.MediaType	getMediaType() Gets the response entity media type, or null of there is no response entity.
javax.ws.rs.core.MultivaluedMap<String,Object>	getMetadata()
int	getStatus() Get the status of the response response.
javax.ws.rs.core.Response.StatusType	getStatusInfo() Get the status of the response response.
javax.ws.rs.core.MultivaluedMap<String,String>	getStringHeaders() Gets a view of the response headers.
boolean	hasEntity()
boolean	hasLink(String relation) Returns true if a link exists for the specified relation, false otherwise.
boolean	isSuccessful() Returns true if GenericResponse.getStatus() is in the range [200..300), false otherwise.
<U> U	readEntity(Class<U> entityType)
<U> U	readEntity(Class<U> entityType, Annotation[] annotations)
<U> U	readEntity(javax.ws.rs.core.GenericType<U> entityType)
<U> U	readEntity(javax.ws.rs.core.GenericType<U> entityType, Annotation[] annotations)
String	toString()

Methods inherited from class org.jboss.resteasy.specimpl.BuiltResponse

abortIfClosed, addMethodAnnotations, getAnnotations, getHeaderValueProcessor, getLinkHeaders, getReasonPhrase, isClosed, readEntity, setAnnotations, setEntity, setEntityClass, setGenericType, setMetadata, setReasonPhrase, setStatus, toHeaderString

Methods inherited from class javax.ws.rs.core.Response

accepted, accepted, created, fromResponse, noContent, notAcceptable, notModified, notModified, notModified, ok, ok, ok, ok, ok, seeOther, serverError, status, status, status, status, temporaryRedirect

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BuiltGenericResponse

protected BuiltGenericResponse(T body,
                               ErrorBody errorBody,
                               javax.ws.rs.core.Response rawResponse)

Method Detail

create

public static <T> BuiltGenericResponse<T> create(T body,
                                                 javax.ws.rs.core.Response rawResponse)

Creates a new instance of BuiltGenericResponse with the specified body and underlying rawResponse.

Parameters:

body - the response entity body

rawResponse - the underlying raw response

isSuccessful

public boolean isSuccessful()

Description copied from interface: GenericResponse

Returns true if GenericResponse.getStatus() is in the range [200..300), false otherwise.

Specified by:

isSuccessful in interface GenericResponse<T>

body

public T body()

Description copied from interface: GenericResponse

Get the response entity body, null if no entity body is present.

Specified by:

body in interface GenericResponse<T>

errorBody

public ErrorBody errorBody()

Description copied from interface: GenericResponse

Get the error body, null if the response is not an error or no entity body is present.

Specified by:

errorBody in interface GenericResponse<T>

getEntityClass

public Class<?> getEntityClass()

Overrides:

getEntityClass in class org.jboss.resteasy.specimpl.BuiltResponse

getGenericType

public Type getGenericType()

Overrides:

getGenericType in class org.jboss.resteasy.specimpl.BuiltResponse

getStatus

public int getStatus()

Description copied from interface: GenericResponse

Get the status of the response response.

Specified by:

getStatus in interface GenericResponse<T>

Overrides:

getStatus in class org.jboss.resteasy.specimpl.BuiltResponse

getStatusInfo

public javax.ws.rs.core.Response.StatusType getStatusInfo()

Description copied from interface: GenericResponse

Get the status of the response response.

Specified by:

getStatusInfo in interface GenericResponse<T>

Overrides:

getStatusInfo in class org.jboss.resteasy.specimpl.BuiltResponse

getEntity

public Object getEntity()

Overrides:

getEntity in class org.jboss.resteasy.specimpl.BuiltResponse

readEntity

public <U> U readEntity(Class<U> entityType)

Overrides:

readEntity in class org.jboss.resteasy.specimpl.BuiltResponse

readEntity

public <U> U readEntity(javax.ws.rs.core.GenericType<U> entityType)

Overrides:

readEntity in class org.jboss.resteasy.specimpl.BuiltResponse

readEntity

public <U> U readEntity(Class<U> entityType,
                        Annotation[] annotations)

Overrides:

readEntity in class org.jboss.resteasy.specimpl.BuiltResponse

readEntity

public <U> U readEntity(javax.ws.rs.core.GenericType<U> entityType,
                        Annotation[] annotations)

Overrides:

readEntity in class org.jboss.resteasy.specimpl.BuiltResponse

hasEntity

public boolean hasEntity()

Overrides:

hasEntity in class org.jboss.resteasy.specimpl.BuiltResponse

bufferEntity

public boolean bufferEntity()

Overrides:

bufferEntity in class org.jboss.resteasy.specimpl.BuiltResponse

close

public void close()

Description copied from interface: GenericResponse

Closes the underlying response input stream.

Specified by:

close in interface GenericResponse<T>

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class org.jboss.resteasy.specimpl.BuiltResponse

See Also:

Response.close()

getMediaType

public javax.ws.rs.core.MediaType getMediaType()

Description copied from interface: GenericResponse

Gets the response entity media type, or null of there is no response entity.

Specified by:

getMediaType in interface GenericResponse<T>

Overrides:

getMediaType in class org.jboss.resteasy.specimpl.BuiltResponse

getLanguage

public Locale getLanguage()

Description copied from interface: GenericResponse

Gets the language of the response entity, null if not specified.

Specified by:

getLanguage in interface GenericResponse<T>

Overrides:

getLanguage in class org.jboss.resteasy.specimpl.BuiltResponse

getLength

public int getLength()

Description copied from interface: GenericResponse

Gets the Content-Length of the response if present, -1 otherwise.

Specified by:

getLength in interface GenericResponse<T>

Overrides:

getLength in class org.jboss.resteasy.specimpl.BuiltResponse

getAllowedMethods

public Set<String> getAllowedMethods()

Description copied from interface: GenericResponse

Gets the allowed HTTP methods.

Specified by:

getAllowedMethods in interface GenericResponse<T>

Overrides:

getAllowedMethods in class org.jboss.resteasy.specimpl.BuiltResponse

getCookies

public Map<String,javax.ws.rs.core.NewCookie> getCookies()

Description copied from interface: GenericResponse

Gets any new cookies on the response.

Specified by:

getCookies in interface GenericResponse<T>

Overrides:

getCookies in class org.jboss.resteasy.specimpl.BuiltResponse

getEntityTag

public javax.ws.rs.core.EntityTag getEntityTag()

Description copied from interface: GenericResponse

Gets the entity tag.

Specified by:

getEntityTag in interface GenericResponse<T>

Overrides:

getEntityTag in class org.jboss.resteasy.specimpl.BuiltResponse

getDate

public Date getDate()

Description copied from interface: GenericResponse

Gets the resposne date, null if not present.

Specified by:

getDate in interface GenericResponse<T>

Overrides:

getDate in class org.jboss.resteasy.specimpl.BuiltResponse

getLastModified

public Date getLastModified()

Description copied from interface: GenericResponse

Gets the last modified date, null if not present.

Specified by:

getLastModified in interface GenericResponse<T>

Overrides:

getLastModified in class org.jboss.resteasy.specimpl.BuiltResponse

getLocation

public URI getLocation()

Description copied from interface: GenericResponse

Gets the location, null if not present.

Specified by:

getLocation in interface GenericResponse<T>

Overrides:

getLocation in class org.jboss.resteasy.specimpl.BuiltResponse

getLinks

public Set<javax.ws.rs.core.Link> getLinks()

Description copied from interface: GenericResponse

Gets the links from the response headers.

Specified by:

getLinks in interface GenericResponse<T>

Overrides:

getLinks in class org.jboss.resteasy.specimpl.BuiltResponse

See Also:

Response.getLinks()

hasLink

public boolean hasLink(String relation)

Description copied from interface: GenericResponse

Returns true if a link exists for the specified relation, false otherwise.

Specified by:

hasLink in interface GenericResponse<T>

Overrides:

hasLink in class org.jboss.resteasy.specimpl.BuiltResponse

getLink

public javax.ws.rs.core.Link getLink(String relation)

Description copied from interface: GenericResponse

Gets the link for the relation, null if not present.

Specified by:

getLink in interface GenericResponse<T>

Overrides:

getLink in class org.jboss.resteasy.specimpl.BuiltResponse

See Also:

Response.getLink(String)

getLinkBuilder

public javax.ws.rs.core.Link.Builder getLinkBuilder(String relation)

Description copied from interface: GenericResponse

Returns a link builder for the relation, null if not present.

Specified by:

getLinkBuilder in interface GenericResponse<T>

Overrides:

getLinkBuilder in class org.jboss.resteasy.specimpl.BuiltResponse

See Also:

Response.getLinkBuilder(String)

getMetadata

public javax.ws.rs.core.MultivaluedMap<String,Object> getMetadata()

Overrides:

getMetadata in class org.jboss.resteasy.specimpl.BuiltResponse

getStringHeaders

public javax.ws.rs.core.MultivaluedMap<String,String> getStringHeaders()

Description copied from interface: GenericResponse

Gets a view of the response headers.

Specified by:

getStringHeaders in interface GenericResponse<T>

Overrides:

getStringHeaders in class org.jboss.resteasy.specimpl.BuiltResponse

See Also:

Response.getStringHeaders(), GenericResponse.getHeaders(), GenericResponse.getHeaderString(java.lang.String)

getHeaders

public javax.ws.rs.core.MultivaluedMap<String,Object> getHeaders()

Description copied from interface: GenericResponse

Gets a view of the response headers.

Specified by:

getHeaders in interface GenericResponse<T>

Overrides:

getHeaders in class javax.ws.rs.core.Response

See Also:

Response.getHeaders(), GenericResponse.getStringHeaders(), GenericResponse.getHeaderString(java.lang.String)

getHeaderString

public String getHeaderString(String name)

Description copied from interface: GenericResponse

Gets a response header as a string value.

If the header contains multiple values, they will be joined by a ',' character, null if the header is not present.

Specified by:

getHeaderString in interface GenericResponse<T>

Overrides:

getHeaderString in class org.jboss.resteasy.specimpl.BuiltResponse

See Also:

Response.getHeaderString(String), GenericResponse.getHeaders(), GenericResponse.getHeaderString(java.lang.String)

toString

public String toString()

Overrides:

toString in class Object