ca.uhn.fhir.rest.client.apache

Class ApacheHttpResponse

java.lang.Object

ca.uhn.fhir.rest.client.apache.ApacheHttpResponse

All Implemented Interfaces:

IHttpResponse

public class ApacheHttpResponse
extends Object
implements IHttpResponse

A Http Response based on Apache. This is an adapter around the class HttpResponse

Author:

Peter Van Houte | peter.vanhoute@agfa.com | Agfa Healthcare

Constructor Summary

Constructors

Constructor and Description
ApacheHttpResponse(org.apache.http.HttpResponse theResponse)

Method Summary

Modifier and Type	Method and Description
void	bufferEntitity() Deprecated.
void	bufferEntity() Buffer the message entity data.
void	close() Close the response
Reader	createReader() Returna reader for the response entity
Map<String,List<String>>	getAllHeaders() Get map of the response headers and corresponding string values.
List<String>	getHeaders(String theName) Return all headers in the response with the given type
String	getMimeType() Extracts Content-Type value from the response exactly as specified by the Content-Type header.
org.apache.http.HttpResponse	getResponse()
int	getStatus() Get the status code associated with the response.
String	getStatusInfo() Get the response status information reason phrase associated with the response.
InputStream	readEntity() Read the message entity input stream as an InputStream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApacheHttpResponse

public ApacheHttpResponse(org.apache.http.HttpResponse theResponse)

Method Detail

bufferEntitity

@Deprecated
public void bufferEntitity()
                                throws IOException

Deprecated.

Specified by:

bufferEntitity in interface IHttpResponse

Throws:

IOException

bufferEntity

public void bufferEntity()
                  throws IOException

Description copied from interface: IHttpResponse

Buffer the message entity data.

In case the message entity is backed by an unconsumed entity input stream, all the bytes of the original entity input stream are read and stored in a local buffer. The original entity input stream is consumed.

In case the response entity instance is not backed by an unconsumed input stream an invocation of bufferEntity method is ignored and the method returns.

This operation is idempotent, i.e. it can be invoked multiple times with the same effect which also means that calling the bufferEntity() method on an already buffered (and thus closed) message instance is legal and has no further effect.

Buffering the message entity data allows for multiple invocations of readEntity(...) methods on the response instance.

Specified by:

bufferEntity in interface IHttpResponse

Throws:

IOException

close

public void close()

Description copied from interface: IHttpResponse

Close the response

Specified by:

close in interface IHttpResponse

createReader

public Reader createReader()
                    throws IOException

Description copied from interface: IHttpResponse

Returna reader for the response entity

Specified by:

createReader in interface IHttpResponse

Throws:

IOException

getAllHeaders

public Map<String,List<String>> getAllHeaders()

Description copied from interface: IHttpResponse

Get map of the response headers and corresponding string values.

Specified by:

getAllHeaders in interface IHttpResponse

Returns:

response headers as a map header keys and they values.

getHeaders

public List<String> getHeaders(String theName)

Description copied from interface: IHttpResponse

Return all headers in the response with the given type

Specified by:

getHeaders in interface IHttpResponse

getMimeType

public String getMimeType()

Description copied from interface: IHttpResponse

Extracts Content-Type value from the response exactly as specified by the Content-Type header. Returns null if not specified.

Specified by:

getMimeType in interface IHttpResponse

getResponse

public org.apache.http.HttpResponse getResponse()

Specified by:

getResponse in interface IHttpResponse

Returns:

the native response, depending on the client library used

getStatus

public int getStatus()

Description copied from interface: IHttpResponse

Get the status code associated with the response.

Specified by:

getStatus in interface IHttpResponse

Returns:

the response status code.

getStatusInfo

public String getStatusInfo()

Description copied from interface: IHttpResponse

Get the response status information reason phrase associated with the response.

Specified by:

getStatusInfo in interface IHttpResponse

Returns:

the reason phrase.

readEntity

public InputStream readEntity()
                       throws IOException

Description copied from interface: IHttpResponse

Read the message entity input stream as an InputStream.

Specified by:

readEntity in interface IHttpResponse

Throws:

IOException