org.jboss.resteasy.client.jaxrs.internal

Class ClientResponse

java.lang.Object

javax.ws.rs.core.Response

org.jboss.resteasy.specimpl.BuiltResponse

org.jboss.resteasy.client.jaxrs.internal.ClientResponse

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

AbortedResponse

public abstract class ClientResponse
extends BuiltResponse

Version:

$Revision: 1 $

Author:

Bill Burke

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

Modifier and Type	Field and Description
protected byte[]	bufferedEntity
protected ClientConfiguration	configuration
protected Map<String,Object>	properties
protected boolean	streamFullyRead

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	ClientResponse(ClientConfiguration configuration)

Method Summary

Modifier and Type	Method and Description
void	abortIfClosed()
boolean	bufferEntity()
void	close()
protected void	finalize()
Object	getEntity()
Class<?>	getEntityClass()
protected InputStream	getEntityStream()
protected HeaderValueProcessor	getHeaderValueProcessor()
protected abstract InputStream	getInputStream()
Map<String,Object>	getProperties()
boolean	hasEntity()
void	noReleaseConnection() In case of an InputStream or Reader and a invocation that returns no Response object, we need to make sure the GC does not close the returned InputStream or Reader
<T> T	readEntity(Class<T> type, Type genericType, Annotation[] anns)
protected <T> Object	readFrom(Class<T> type, Type genericType, javax.ws.rs.core.MediaType media, Annotation[] annotations)
abstract void	releaseConnection() Release underlying connection but do not close.
abstract void	releaseConnection(boolean consumeInputStream) Release underlying connection but do not close.
protected void	resetEntity()
void	setClientConfiguration(ClientConfiguration configuration)
void	setHeaders(javax.ws.rs.core.MultivaluedMap<String,String> headers)
protected abstract void	setInputStream(InputStream is)
void	setProperties(Map<String,Object> properties)

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

addMethodAnnotations, getAllowedMethods, getAnnotations, getCookies, getDate, getEntityTag, getGenericType, getHeaderString, getLanguage, getLastModified, getLength, getLink, getLinkBuilder, getLinkHeaders, getLinks, getLocation, getMediaType, getMetadata, getReasonPhrase, getStatus, getStatusInfo, getStringHeaders, hasLink, isClosed, readEntity, readEntity, readEntity, readEntity, setAnnotations, setEntity, setEntityClass, setGenericType, setMetadata, setReasonPhrase, setStatus, toHeaderString

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

properties

protected Map<String,Object> properties

configuration

protected ClientConfiguration configuration

bufferedEntity

protected byte[] bufferedEntity

streamFullyRead

protected boolean streamFullyRead

Constructor Detail

ClientResponse

protected ClientResponse(ClientConfiguration configuration)

Method Detail

setHeaders

public void setHeaders(javax.ws.rs.core.MultivaluedMap<String,String> headers)

setProperties

public void setProperties(Map<String,Object> properties)

getProperties

public Map<String,Object> getProperties()

setClientConfiguration

public void setClientConfiguration(ClientConfiguration configuration)

getEntity

public Object getEntity()

Overrides:

getEntity in class BuiltResponse

getEntityClass

public Class<?> getEntityClass()

Overrides:

getEntityClass in class BuiltResponse

hasEntity

public boolean hasEntity()

Overrides:

hasEntity in class BuiltResponse

noReleaseConnection

public void noReleaseConnection()

In case of an InputStream or Reader and a invocation that returns no Response object, we need to make sure the GC does not close the returned InputStream or Reader

close

public void close()

Specified by:

close in interface AutoCloseable

Overrides:

close in class BuiltResponse

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

getHeaderValueProcessor

protected HeaderValueProcessor getHeaderValueProcessor()

Overrides:

getHeaderValueProcessor in class BuiltResponse

getInputStream

protected abstract InputStream getInputStream()

getEntityStream

protected InputStream getEntityStream()

setInputStream

protected abstract void setInputStream(InputStream is)

releaseConnection

public abstract void releaseConnection()
                                throws IOException

Release underlying connection but do not close.

Throws:

IOException - if I/O error occurred

releaseConnection

public abstract void releaseConnection(boolean consumeInputStream)
                                throws IOException

Release underlying connection but do not close.

Parameters:

consumeInputStream - boolean to indicate either the underlying input stream must be fully read before releasing the connection or not.

For most HTTP connection implementations, consuming the underlying input stream before releasing the connection will help to ensure connection reusability with respect of Keep-Alive policy.

Throws:

IOException - if I/O error occured

readEntity

public <T> T readEntity(Class<T> type,
                        Type genericType,
                        Annotation[] anns)

Overrides:

readEntity in class BuiltResponse

readFrom

protected <T> Object readFrom(Class<T> type,
                              Type genericType,
                              javax.ws.rs.core.MediaType media,
                              Annotation[] annotations)

bufferEntity

public boolean bufferEntity()

Overrides:

bufferEntity in class BuiltResponse

resetEntity

protected void resetEntity()

abortIfClosed

public void abortIfClosed()

Overrides:

abortIfClosed in class BuiltResponse