org.jboss.resteasy.client
Class ClientResponse<T>

java.lang.Object
  extended by javax.ws.rs.core.Response
      extended by org.jboss.resteasy.client.ClientResponse<T>
Direct Known Subclasses:
BaseClientResponse

public abstract class ClientResponse<T>
extends Response

Response extension for the RESTEasy client framework. Use this, or Response in your client proxy interface method return type declarations if you want access to the response entity as well as status and header information.

Version:
$Revision: 1 $
Author:
Bill Burke

Nested Class Summary
 
Nested classes/interfaces inherited from class javax.ws.rs.core.Response
Response.ResponseBuilder, Response.Status
 
Constructor Summary
ClientResponse()
           
 
Method Summary
abstract  T getEntity()
          Unmarshal the target entity from the response OutputStream.
abstract
<T2> T2
getEntity(java.lang.Class<T2> type)
          Extract the response body with the provided type information

This method actually does the reading on the OutputStream.

abstract
<T2> T2
getEntity(java.lang.Class<T2> type, java.lang.reflect.Type genericType)
          Extract the response body with the provided type information

This method actually does the reading on the OutputStream.

abstract
<T2> T2
getEntity(java.lang.Class<T2> type, java.lang.reflect.Type genericType, java.lang.annotation.Annotation[] annotations)
           
abstract
<T2> T2
getEntity(GenericType<T2> type)
          Extract the response body with the provided type information.
abstract
<T2> T2
getEntity(GenericType<T2> type, java.lang.annotation.Annotation[] annotations)
           
abstract  MultivaluedMap<java.lang.String,java.lang.String> getHeaders()
          This method returns the same exact map as Response.getMetadata() except as a map of strings rather than objects
abstract  LinkHeader getLinkHeader()
          Get the link headers of the response.
abstract  Response.Status getResponseStatus()
           
abstract  void releaseConnection()
           
 
Methods inherited from class javax.ws.rs.core.Response
created, fromResponse, getMetadata, getStatus, noContent, notAcceptable, notModified, notModified, notModified, ok, ok, ok, ok, ok, seeOther, serverError, status, status, temporaryRedirect
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ClientResponse

public ClientResponse()
Method Detail

getHeaders

public abstract MultivaluedMap<java.lang.String,java.lang.String> getHeaders()
This method returns the same exact map as Response.getMetadata() except as a map of strings rather than objects

Returns:

getResponseStatus

public abstract Response.Status getResponseStatus()

getEntity

public abstract T getEntity()
Unmarshal the target entity from the response OutputStream. You must have type information set via 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 Response
Returns:
See Also:
MessageBodyWriter

getEntity

public abstract <T2> T2 getEntity(java.lang.Class<T2> type)
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.

Type Parameters:
T2 -
Parameters:
type -
genericType -
Returns:

getEntity

public abstract <T2> T2 getEntity(java.lang.Class<T2> type,
                                  java.lang.reflect.Type genericType)
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.

Type Parameters:
T2 -
Parameters:
type -
genericType -
Returns:

getEntity

public abstract <T2> T2 getEntity(java.lang.Class<T2> type,
                                  java.lang.reflect.Type genericType,
                                  java.lang.annotation.Annotation[] annotations)
Type Parameters:
T2 -
Parameters:
type -
genericType -
annotations -
Returns:

getEntity

public abstract <T2> T2 getEntity(GenericType<T2> type)
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 list = response.getEntity(new GenericType() {});
 

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.

Type Parameters:
T2 -
Parameters:
type -
Returns:

getEntity

public abstract <T2> T2 getEntity(GenericType<T2> type,
                                  java.lang.annotation.Annotation[] annotations)
Type Parameters:
T2 -
Parameters:
type -
annotations -
Returns:

getLinkHeader

public abstract LinkHeader getLinkHeader()
Get the link headers of the response.

Returns:

releaseConnection

public abstract void releaseConnection()


Copyright © 2009. All Rights Reserved.