com.cerner.beadledom.jaxrs

Class DelegatingGenericResponse<T>

java.lang.Object

javax.ws.rs.core.Response

com.cerner.beadledom.jaxrs.DelegatingGenericResponse<T>

All Implemented Interfaces:

GenericResponse<T>, Closeable, AutoCloseable

public class DelegatingGenericResponse<T>
extends javax.ws.rs.core.Response
implements GenericResponse<T>

A GenericResponse implementation that delegates to an underlying JAX-RS Response.

Since:

1.3

Author:

John Leacox

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DelegatingGenericResponse(T body, ErrorBody errorBody, javax.ws.rs.core.Response rawResponse) This constructor exists so that DelegatingGenericResponse class can be extended.

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> DelegatingGenericResponse<T>	create(T body, javax.ws.rs.core.Response rawResponse) Creates a new DelegatingGenericResponse.
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() Null will be returned if there is no body present.
javax.ws.rs.core.EntityTag	getEntityTag() Gets the entity tag.
Type	getGenericType() Null will be returned if there is no body present.
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 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

DelegatingGenericResponse

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

This constructor exists so that DelegatingGenericResponse class can be extended.

DelegatingGenericResponse should not be instantiated directly.

Method Detail

create

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

Creates a new DelegatingGenericResponse.

If the rawResponse status code is in the range [200..300) the ErrorBody will be null. If the rawResponse status code is outside of the range [200..300) then a new ErrorBody will be created from the rawResponse and associated to this generic response.

Parameters:

body - the entity body of the response, may be null if no body is present

rawResponse - the raw JAX-RS response to delegate to

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()

Null will be returned if there is no body present.

getGenericType

public Type getGenericType()

Null will be returned if there is no body present.

getStatus

public int getStatus()

Description copied from interface: GenericResponse

Get the status of the response response.

Specified by:

getStatus in interface GenericResponse<T>

Specified by:

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

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>

Specified by:

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

getEntity

public Object getEntity()

Specified by:

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

readEntity

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

Specified by:

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

readEntity

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

Specified by:

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

readEntity

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

Specified by:

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

readEntity

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

Specified by:

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

hasEntity

public boolean hasEntity()

Specified by:

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

bufferEntity

public boolean bufferEntity()

Specified by:

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

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

Specified by:

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

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>

Specified by:

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

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>

Specified by:

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

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>

Specified by:

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

getAllowedMethods

public Set<String> getAllowedMethods()

Description copied from interface: GenericResponse

Gets the allowed HTTP methods.

Specified by:

getAllowedMethods in interface GenericResponse<T>

Specified by:

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

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>

Specified by:

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

getEntityTag

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

Description copied from interface: GenericResponse

Gets the entity tag.

Specified by:

getEntityTag in interface GenericResponse<T>

Specified by:

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

getDate

public Date getDate()

Description copied from interface: GenericResponse

Gets the resposne date, null if not present.

Specified by:

getDate in interface GenericResponse<T>

Specified by:

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

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>

Specified by:

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

getLocation

public URI getLocation()

Description copied from interface: GenericResponse

Gets the location, null if not present.

Specified by:

getLocation in interface GenericResponse<T>

Specified by:

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

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>

Specified by:

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

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>

Specified by:

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

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>

Specified by:

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

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>

Specified by:

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

See Also:

Response.getLinkBuilder(String)

getMetadata

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

Specified by:

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

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)

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>

Specified by:

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

See Also:

Response.getStringHeaders(), GenericResponse.getHeaders(), 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>

Specified by:

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

See Also:

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

toString

public String toString()

Overrides:

toString in class Object