BaseClientResponse (RESTEasy JAX-RS 3.9.0.Final API)

java.lang.Object
- javax.ws.rs.core.Response
- - org.jboss.resteasy.client.ClientResponse<T>
  - - org.jboss.resteasy.client.core.BaseClientResponse<T>

All Implemented Interfaces:

AutoCloseable
```
public class BaseClientResponse<T>
extends ClientResponse<T>
```
Version:

$Revision: 1 $

Author:

Bill Burke

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface BaseClientResponse.BaseClientResponseStreamFactory
- 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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`BaseClientResponse.BaseClientResponseStreamFactory`

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`alternateMediaType`
`protected Annotation[]`	`annotations`
`protected String`	`attributeExceptionsTo`
`protected Map<String,Object>`	`attributes`
`protected Exception`	`exception`
`protected ClientExecutor`	`executor`
`protected Type`	`genericReturnType`
`protected javax.ws.rs.core.MultivaluedMap<String,String>`	`headers`
`protected LinkHeader`	`linkHeader`
`protected Link`	`location`
`protected ResteasyProviderFactory`	`providerFactory`
`protected javax.ws.rs.ext.ReaderInterceptor[]`	`readerInterceptors`
`protected Class<?>`	`returnType`
`protected int`	`status`
`protected BaseClientResponse.BaseClientResponseStreamFactory`	`streamFactory`
`protected Object`	`unmarshaledEntity`
`protected boolean`	`wasReleased`

Constructor Summary

Constructors
Constructor and Description
`BaseClientResponse(BaseClientResponse.BaseClientResponseStreamFactory streamFactory)`
`BaseClientResponse(BaseClientResponse.BaseClientResponseStreamFactory streamFactory, ClientExecutor executor)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`bufferEntity()`
`void`	`checkFailureStatus()`
`void`	`close()`
`static ClientResponse`	`copyFromError(ClientResponse copy)` Store entity within a byte array input stream because we want to release the connection if a ClientResponseFailure is thrown.
`ClientResponseFailure`	`createResponseFailure(String message)`
`ClientResponseFailure`	`createResponseFailure(String message, Exception e)`
`protected void`	`finalize()`
`Set<String>`	`getAllowedMethods()`
`Annotation[]`	`getAnnotations()`
`String`	`getAttributeExceptionsTo()`
`Map<String,Object>`	`getAttributes()` Used to pass information to and between interceptors.
`Map<String,javax.ws.rs.core.NewCookie>`	`getCookies()`
`Date`	`getDate()`
`T`	`getEntity()` Unmarshal the target entity from the response OutputStream.
`<T2> T2`	`getEntity(Class<T2> type)` Extract the response body with the provided type information
`<T2> T2`	`getEntity(Class<T2> type, Type genericType)` Extract the response body with the provided type information
`<T2> T2`	`getEntity(Class<T2> type, Type genericType, Annotation[] anns)`
`<T2> T2`	`getEntity(GenericType<T2> genericType)` Extract the response body with the provided type information.
`<T2> T2`	`getEntity(GenericType<T2> genericType, Annotation[] ann)`
`javax.ws.rs.core.EntityTag`	`getEntityTag()`
`Exception`	`getException()`
`Link`	`getHeaderAsLink(String headerName)` Header is assumed to be a URL, a Link object is created from it if it exists.
`String`	`getHeaderString(String name)`
`Locale`	`getLanguage()`
`Date`	`getLastModified()`
`int`	`getLength()`
`javax.ws.rs.core.Link`	`getLink(String relation)`
`javax.ws.rs.core.Link.Builder`	`getLinkBuilder(String relation)`
`LinkHeader`	`getLinkHeader()` Get the link headers of the response.
`Set<javax.ws.rs.core.Link>`	`getLinks()`
`URI`	`getLocation()`
`Link`	`getLocationLink()` Get the Location header as a Link so you can easily execute on it.
`javax.ws.rs.core.MediaType`	`getMediaType()`
`javax.ws.rs.core.MultivaluedMap<String,Object>`	`getMetadata()`
`String`	`getResponseHeader(String headerKey)`
`javax.ws.rs.core.MultivaluedMap<String,String>`	`getResponseHeaders()` This method returns the same exact map as Response.getMetadata() except as a map of strings rather than objects
`javax.ws.rs.core.Response.Status`	`getResponseStatus()`
`Class<?>`	`getReturnType()`
`int`	`getStatus()`
`javax.ws.rs.core.Response.StatusType`	`getStatusInfo()`
`BaseClientResponse.BaseClientResponseStreamFactory`	`getStreamFactory()`
`javax.ws.rs.core.MultivaluedMap<String,String>`	`getStringHeaders()`
`boolean`	`hasEntity()`
`boolean`	`hasLink(String relation)`
`<T> T`	`readEntity(Class<T> entityType)`
`<T> T`	`readEntity(Class<T> entityType, Annotation[] annotations)`
`<T> T`	`readEntity(javax.ws.rs.core.GenericType<T> entityType)`
`<T> T`	`readEntity(javax.ws.rs.core.GenericType<T> entityType, Annotation[] annotations)`
`protected <T2> Object`	`readFrom(Class<T2> type, Type genericType, javax.ws.rs.core.MediaType media, Annotation[] annotations)`
`void`	`releaseConnection()`
`void`	`resetStream()` Attempts to reset the InputStream of the response.
`void`	`setAlternateMediaType(String alternateMediaType)`
`void`	`setAnnotations(Annotation[] annotations)`
`void`	`setAttributeExceptionsTo(String attributeExceptionsTo)`
`void`	`setAttributes(Map<String,Object> attributes)`
`void`	`setException(Exception exception)`
`void`	`setGenericReturnType(Type genericReturnType)`
`void`	`setHeaders(javax.ws.rs.core.MultivaluedMap<String,String> headers)`
`void`	`setProviderFactory(ResteasyProviderFactory providerFactory)`
`void`	`setReaderInterceptors(javax.ws.rs.ext.ReaderInterceptor[] readerInterceptors)`
`void`	`setReturnType(Class<T> returnType)`
`void`	`setStatus(int status)`
`void`	`setStreamFactory(BaseClientResponse.BaseClientResponseStreamFactory streamFactory)`
`void`	`setWasReleased(boolean wasReleased)`
`boolean`	`wasReleased()`

Methods inherited from class javax.ws.rs.core.Response
accepted, accepted, created, fromResponse, getHeaders, 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, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - providerFactory
```
protected ResteasyProviderFactory providerFactory
```
  - attributeExceptionsTo
```
protected String attributeExceptionsTo
```
  - headers
```
protected javax.ws.rs.core.MultivaluedMap<String,String> headers
```
  - alternateMediaType
```
protected String alternateMediaType
```
  - returnType
```
protected Class<?> returnType
```
  - genericReturnType
```
protected Type genericReturnType
```
  - annotations
```
protected Annotation[] annotations
```
  - status
```
protected int status
```
  - wasReleased
```
protected boolean wasReleased
```
  - unmarshaledEntity
```
protected Object unmarshaledEntity
```
  - readerInterceptors
```
protected javax.ws.rs.ext.ReaderInterceptor[] readerInterceptors
```
  - exception
```
protected Exception exception
```
  - streamFactory
```
protected BaseClientResponse.BaseClientResponseStreamFactory streamFactory
```
  - linkHeader
```
protected LinkHeader linkHeader
```
  - location
```
protected Link location
```
  - executor
```
protected ClientExecutor executor
```
  - attributes
```
protected Map<String,Object> attributes
```
- Constructor Detail
  - BaseClientResponse
```
public BaseClientResponse(BaseClientResponse.BaseClientResponseStreamFactory streamFactory,
                          ClientExecutor executor)
```
  - BaseClientResponse
```
public BaseClientResponse(BaseClientResponse.BaseClientResponseStreamFactory streamFactory)
```
- Method Detail
  - copyFromError
```
public static ClientResponse copyFromError(ClientResponse copy)
```
    Store entity within a byte array input stream because we want to release the connection if a ClientResponseFailure is thrown. Copy status and headers, but ignore all type information stored in the ClientResponse.
    
    Parameters:
    
    copy -
    
    Returns:
  - getAttributes
```
public Map<String,Object> getAttributes()
```
    Description copied from class: ClientResponse
    
    Used to pass information to and between interceptors.
    
    Specified by:
    
    getAttributes in class ClientResponse<T>
    
    Returns:
  - setAttributes
```
public void setAttributes(Map<String,Object> attributes)
```
  - setReaderInterceptors
```
public void setReaderInterceptors(javax.ws.rs.ext.ReaderInterceptor[] readerInterceptors)
```
  - setStatus
```
public void setStatus(int status)
```
  - setHeaders
```
public void setHeaders(javax.ws.rs.core.MultivaluedMap<String,String> headers)
```
  - setProviderFactory
```
public void setProviderFactory(ResteasyProviderFactory providerFactory)
```
  - setReturnType
```
public void setReturnType(Class<T> returnType)
```
  - getReturnType
```
public Class<?> getReturnType()
```
  - setGenericReturnType
```
public void setGenericReturnType(Type genericReturnType)
```
  - setAnnotations
```
public void setAnnotations(Annotation[] annotations)
```
  - getAttributeExceptionsTo
```
public String getAttributeExceptionsTo()
```
  - setAttributeExceptionsTo
```
public void setAttributeExceptionsTo(String attributeExceptionsTo)
```
  - getException
```
public Exception getException()
```
  - setException
```
public void setException(Exception exception)
```
  - getAnnotations
```
public Annotation[] getAnnotations()
```
  - getResponseHeader
```
public String getResponseHeader(String headerKey)
```
  - getLinkHeader
```
public LinkHeader getLinkHeader()
```
    Description copied from class: ClientResponse
    
    Get the link headers of the response. All Link objects returned will automatically have the same ClientExecutor as the request.
    
    Specified by:
    
    getLinkHeader in class ClientResponse<T>
    
    Returns:
    
    non-null
  - getLocationLink
```
public Link getLocationLink()
```
    Description copied from class: ClientResponse
    
    Get the Location header as a Link so you can easily execute on it. All Link objects returned will automatically have the same ClientExecutor as the request.
    
    Specified by:
    
    getLocationLink in class ClientResponse<T>
    
    Returns:
  - getHeaderAsLink
```
public Link getHeaderAsLink(String headerName)
```
    Description copied from class: ClientResponse
    
    Header is assumed to be a URL, a Link object is created from it if it exists. Also, the type field of the link with be initialized if there is another header appended with -Type. i.e. if the header was "custom" it will also look for a header of custom-type and expect that this is a media type.
    All Link objects returned will automatically have the same ClientExecutor as the request.
    
    Specified by:
    
    getHeaderAsLink in class ClientResponse<T>
    
    Returns:
    
    null if it doesn't exist
  - setAlternateMediaType
```
public void setAlternateMediaType(String alternateMediaType)
```
  - getStreamFactory
```
public BaseClientResponse.BaseClientResponseStreamFactory getStreamFactory()
```
  - setStreamFactory
```
public void setStreamFactory(BaseClientResponse.BaseClientResponseStreamFactory streamFactory)
```
  - resetStream
```
public void resetStream()
```
    Description copied from class: ClientResponse
    
    Attempts to reset the InputStream of the response. Useful for refetching an entity after a marshalling failure
    
    Specified by:
    
    resetStream in class ClientResponse<T>
  - getEntity
```
public T getEntity()
```
    Description copied from class: ClientResponse
    
    Unmarshal the target entity from the response OutputStream. You must have type information set via <T> otherwise, this will not work.
    This method actually does the reading on the OutputStream. It will only do the read once. Afterwards, it will cache the result and return the cached result.
    
    Specified by:
    
    getEntity in class ClientResponse<T>
  - getEntity
```
public <T2> T2 getEntity(Class<T2> type)
```
    Description copied from class: ClientResponse
    
    Extract the response body with the provided type information
    This method actually does the reading on the OutputStream. It will only do the read once. Afterwards, it will cache the result and return the cached result.
    
    Specified by:
    
    getEntity in class ClientResponse<T>
    
    Returns:
  - getEntity
```
public <T2> T2 getEntity(Class<T2> type,
                         Type genericType)
```
    Description copied from class: ClientResponse
    
    Extract the response body with the provided type information
    This method actually does the reading on the OutputStream. It will only do the read once. Afterwards, it will cache the result and return the cached result.
    
    Specified by:
    
    getEntity in class ClientResponse<T>
    
    Returns:
  - getEntity
```
public <T2> T2 getEntity(Class<T2> type,
                         Type genericType,
                         Annotation[] anns)
```
    Specified by:
    
    getEntity in class ClientResponse<T>
    
    Returns:
  - getMediaType
```
public javax.ws.rs.core.MediaType getMediaType()
```
    Specified by:
    
    getMediaType in class javax.ws.rs.core.Response
  - readFrom
```
protected <T2> Object readFrom(Class<T2> type,
                               Type genericType,
                               javax.ws.rs.core.MediaType media,
                               Annotation[] annotations)
```
  - getEntity
```
public <T2> T2 getEntity(GenericType<T2> genericType)
```
    Description copied from class: ClientResponse
    Extract the response body with the provided type information. GenericType is a trick used to pass in generic type information to the resteasy runtime.
    For example:
```
 List  <String > list = response.getEntity(new GenericType <List <String >>() {});
 
```
    This method actually does the reading on the OutputStream. It will only do the read once. Afterwards, it will cache the result and return the cached result.
    Specified by:
    
    getEntity in class ClientResponse<T>
    
    Returns:
  - getEntity
```
public <T2> T2 getEntity(GenericType<T2> genericType,
                         Annotation[] ann)
```
    Specified by:
    
    getEntity in class ClientResponse<T>
    
    Returns:
  - getResponseHeaders
```
public javax.ws.rs.core.MultivaluedMap<String,String> getResponseHeaders()
```
    Description copied from class: ClientResponse
    
    This method returns the same exact map as Response.getMetadata() except as a map of strings rather than objects
    
    Specified by:
    
    getResponseHeaders in class ClientResponse<T>
    
    Returns:
  - getMetadata
```
public javax.ws.rs.core.MultivaluedMap<String,Object> getMetadata()
```
    Specified by:
    
    getMetadata in class javax.ws.rs.core.Response
  - getStatus
```
public int getStatus()
```
    Specified by:
    
    getStatus in class javax.ws.rs.core.Response
  - getStatusInfo
```
public javax.ws.rs.core.Response.StatusType getStatusInfo()
```
    Specified by:
    
    getStatusInfo in class javax.ws.rs.core.Response
  - checkFailureStatus
```
public void checkFailureStatus()
```
  - createResponseFailure
```
public ClientResponseFailure createResponseFailure(String message)
```
  - createResponseFailure
```
public ClientResponseFailure createResponseFailure(String message,
                                                   Exception e)
```
  - getResponseStatus
```
public javax.ws.rs.core.Response.Status getResponseStatus()
```
    Specified by:
    
    getResponseStatus in class ClientResponse<T>
  - wasReleased
```
public boolean wasReleased()
```
  - setWasReleased
```
public void setWasReleased(boolean wasReleased)
```
  - releaseConnection
```
public final void releaseConnection()
```
    Specified by:
    
    releaseConnection in class ClientResponse<T>
  - finalize
```
protected final void finalize()
                       throws Throwable
```
    Overrides:
    
    finalize in class Object
    
    Throws:
    
    Throwable
  - readEntity
```
public <T> T readEntity(Class<T> entityType)
```
    Specified by:
    
    readEntity in class javax.ws.rs.core.Response
  - readEntity
```
public <T> T readEntity(javax.ws.rs.core.GenericType<T> entityType)
```
    Specified by:
    
    readEntity in class javax.ws.rs.core.Response
  - readEntity
```
public <T> T readEntity(Class<T> entityType,
                        Annotation[] annotations)
```
    Specified by:
    
    readEntity in class javax.ws.rs.core.Response
  - readEntity
```
public <T> T readEntity(javax.ws.rs.core.GenericType<T> 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()
```
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in class javax.ws.rs.core.Response
  - getHeaderString
```
public String getHeaderString(String name)
```
    Specified by:
    
    getHeaderString in class javax.ws.rs.core.Response
  - getLanguage
```
public Locale getLanguage()
```
    Specified by:
    
    getLanguage in class javax.ws.rs.core.Response
  - getLength
```
public int getLength()
```
    Specified by:
    
    getLength in class javax.ws.rs.core.Response
  - getCookies
```
public Map<String,javax.ws.rs.core.NewCookie> getCookies()
```
    Specified by:
    
    getCookies in class javax.ws.rs.core.Response
  - getEntityTag
```
public javax.ws.rs.core.EntityTag getEntityTag()
```
    Specified by:
    
    getEntityTag in class javax.ws.rs.core.Response
  - getDate
```
public Date getDate()
```
    Specified by:
    
    getDate in class javax.ws.rs.core.Response
  - getLastModified
```
public Date getLastModified()
```
    Specified by:
    
    getLastModified in class javax.ws.rs.core.Response
  - getLinks
```
public Set<javax.ws.rs.core.Link> getLinks()
```
    Specified by:
    
    getLinks in class javax.ws.rs.core.Response
  - hasLink
```
public boolean hasLink(String relation)
```
    Specified by:
    
    hasLink in class javax.ws.rs.core.Response
  - getLink
```
public javax.ws.rs.core.Link getLink(String relation)
```
    Specified by:
    
    getLink in class javax.ws.rs.core.Response
  - getLinkBuilder
```
public javax.ws.rs.core.Link.Builder getLinkBuilder(String relation)
```
    Specified by:
    
    getLinkBuilder in class javax.ws.rs.core.Response
  - getLocation
```
public URI getLocation()
```
    Specified by:
    
    getLocation in class javax.ws.rs.core.Response
  - getAllowedMethods
```
public Set<String> getAllowedMethods()
```
    Specified by:
    
    getAllowedMethods in class javax.ws.rs.core.Response
  - getStringHeaders
```
public javax.ws.rs.core.MultivaluedMap<String,String> getStringHeaders()
```
    Specified by:
    
    getStringHeaders in class javax.ws.rs.core.Response

Class BaseClientResponse<T>

Nested Class Summary

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

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

providerFactory

attributeExceptionsTo

headers

alternateMediaType

returnType

genericReturnType

annotations

status

wasReleased

unmarshaledEntity

readerInterceptors

exception

streamFactory

linkHeader

location

executor

attributes

Constructor Detail

BaseClientResponse

BaseClientResponse

Method Detail

copyFromError

getAttributes

setAttributes

setReaderInterceptors

setStatus

setHeaders

setProviderFactory

setReturnType

getReturnType

setGenericReturnType

setAnnotations

getAttributeExceptionsTo

setAttributeExceptionsTo

getException

setException

getAnnotations

getResponseHeader

getLinkHeader

getLocationLink

getHeaderAsLink

setAlternateMediaType

getStreamFactory

setStreamFactory

resetStream

getEntity

getEntity

getEntity

getEntity

getMediaType

readFrom

getEntity

getEntity

getResponseHeaders

getMetadata

getStatus

getStatusInfo

checkFailureStatus

createResponseFailure

createResponseFailure

getResponseStatus

wasReleased

setWasReleased

releaseConnection

finalize

readEntity

readEntity

readEntity

readEntity

hasEntity

bufferEntity