com.sun.jersey.api.client
Class ClientResponse

java.lang.Object
  extended by com.sun.jersey.api.client.ClientResponse

public class ClientResponse
extends java.lang.Object

A client (in-bound) HTTP response.

Author:
Paul.Sandoz@Sun.Com

Field Summary
protected static javax.ws.rs.ext.RuntimeDelegate.HeaderDelegate<java.util.Date> dateDelegate
           
protected static javax.ws.rs.ext.RuntimeDelegate.HeaderDelegate<javax.ws.rs.core.EntityTag> entityTagDelegate
           
 
Constructor Summary
ClientResponse(int status, InBoundHeaders headers, java.io.InputStream entity, MessageBodyWorkers workers)
           
 
Method Summary
 java.util.List<javax.ws.rs.core.NewCookie> getCookies()
          Get the list of cookies.
<T> T
getEntity(java.lang.Class<T> c)
          Get the entity of the response.
<T> T
getEntity(GenericType<T> gt)
          Get the entity of the response.
 java.io.InputStream getEntityInputStream()
          Get the input stream of the response.
 javax.ws.rs.core.EntityTag getEntityTag()
          Get the entity tag.
 java.lang.String getLanguage()
          Get the language.
 java.util.Date getLastModified()
          Get the last modified date.
 java.net.URI getLocation()
          Get the location.
 javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> getMetadata()
          Get the HTTP headers of the response.
 java.util.Map<java.lang.String,java.lang.Object> getProperties()
          Get the map of response properties.
 java.util.Date getResponseDate()
          Get response date (server side).
 javax.ws.rs.core.Response.Status getResponseStatus()
          Get the status code.
 int getStatus()
          Get the status code.
 javax.ws.rs.core.MediaType getType()
          Get the media type of the response.
 boolean hasEntity()
           
 void setEntityInputStream(java.io.InputStream entity)
          Set the input stream of the response.
 void setResponseStatus(javax.ws.rs.core.Response.Status status)
          Set the status code.
 void setStatus(int status)
          Set the status code.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

entityTagDelegate

protected static final javax.ws.rs.ext.RuntimeDelegate.HeaderDelegate<javax.ws.rs.core.EntityTag> entityTagDelegate

dateDelegate

protected static final javax.ws.rs.ext.RuntimeDelegate.HeaderDelegate<java.util.Date> dateDelegate
Constructor Detail

ClientResponse

public ClientResponse(int status,
                      InBoundHeaders headers,
                      java.io.InputStream entity,
                      MessageBodyWorkers workers)
Method Detail

getProperties

public java.util.Map<java.lang.String,java.lang.Object> getProperties()
Get the map of response properties.

A response property is an application-defined property that may be added by the user, a filter, or the handler that is managing the connection.

Returns:
the map of response properties.

getStatus

public int getStatus()
Get the status code.

Returns:
the status code.

setStatus

public void setStatus(int status)
Set the status code.

Parameters:
status - the status code.

getResponseStatus

public javax.ws.rs.core.Response.Status getResponseStatus()
Get the status code.

Returns:
the status code, or null if the underlying status code was set using the method setStatus(int) and there is no mapping between the the integer value and the Response.Status enumeration value.

setResponseStatus

public void setResponseStatus(javax.ws.rs.core.Response.Status status)
Set the status code.

Parameters:
status - the status code.

getMetadata

public javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> getMetadata()
Get the HTTP headers of the response.

Returns:
the HTTP headers of the response.

hasEntity

public boolean hasEntity()
Returns:
true if there is an entity present in the response.

getEntityInputStream

public java.io.InputStream getEntityInputStream()
Get the input stream of the response.

Returns:
the input stream of the response.

setEntityInputStream

public void setEntityInputStream(java.io.InputStream entity)
Set the input stream of the response.

Parameters:
entity - the input stream of the response.

getEntity

public <T> T getEntity(java.lang.Class<T> c)
            throws java.lang.IllegalArgumentException,
                   UniformInterfaceException
Get the entity of the response.

If the entity is not an instance of Closeable then the entity input stream is closed.

Type Parameters:
T - the type of the response.
Parameters:
c - the type of the entity.
Returns:
an instance of the type c.
Throws:
java.lang.IllegalArgumentException
UniformInterfaceException - if the response status is 204 (No Contnet).

getEntity

public <T> T getEntity(GenericType<T> gt)
            throws java.lang.IllegalArgumentException,
                   UniformInterfaceException
Get the entity of the response.

If the entity is not an instance of Closeable then the entity input stream is closed.

Type Parameters:
T - the type of the response.
Parameters:
gt - the generic type of the entity.
Returns:
an instance of the type represented by the generic type.
Throws:
java.lang.IllegalArgumentException
UniformInterfaceException - if the response status is 204 (No Content).

getType

public javax.ws.rs.core.MediaType getType()
Get the media type of the response.

Returns:
the media type.

getLocation

public java.net.URI getLocation()
Get the location.

Returns:
the location.

getEntityTag

public javax.ws.rs.core.EntityTag getEntityTag()
Get the entity tag.

Returns:
the entity tag.

getLastModified

public java.util.Date getLastModified()
Get the last modified date.

Returns:
the last modified date.

getResponseDate

public java.util.Date getResponseDate()
Get response date (server side).

Returns:
the server side response date.

getLanguage

public java.lang.String getLanguage()
Get the language.

Returns:
the language.

getCookies

public java.util.List<javax.ws.rs.core.NewCookie> getCookies()
Get the list of cookies.

Returns:
the cookies.

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object


Copyright © 2009 Sun Microsystems, Inc. All Rights Reserved.