org.apache.http.impl.execchain

Class HttpResponseProxy

java.lang.Object

org.apache.http.impl.execchain.HttpResponseProxy

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, CloseableHttpResponse, HttpMessage, HttpResponse

@NotThreadSafe
 class HttpResponseProxy
extends java.lang.Object
implements CloseableHttpResponse

A proxy class for HttpResponse that can be used to release client connection associated with the original response.

Since:

4.3

Constructor Summary

Constructors

Constructor and Description
HttpResponseProxy(HttpResponse original, ConnectionHolder connHolder)

Method Summary

Methods

Modifier and Type	Method and Description
void	addHeader(Header header) Adds a header to this message.
void	addHeader(java.lang.String name, java.lang.String value) Adds a header to this message.
void	close()
boolean	containsHeader(java.lang.String name) Checks if a certain header is present in this message.
Header[]	getAllHeaders() Returns all the headers of this message.
HttpEntity	getEntity() Obtains the message entity of this response, if any.
Header	getFirstHeader(java.lang.String name) Returns the first header with a specified name of this message.
Header[]	getHeaders(java.lang.String name) Returns all the headers with a specified name of this message.
Header	getLastHeader(java.lang.String name) Returns the last header with a specified name of this message.
java.util.Locale	getLocale() Obtains the locale of this response.
HttpParams	getParams() Deprecated.
ProtocolVersion	getProtocolVersion() Returns the protocol version this message is compatible with.
StatusLine	getStatusLine() Obtains the status line of this response.
HeaderIterator	headerIterator() Returns an iterator of all the headers.
HeaderIterator	headerIterator(java.lang.String name) Returns an iterator of the headers with a given name.
void	removeHeader(Header header) Removes a header from this message.
void	removeHeaders(java.lang.String name) Removes all headers with a certain name from this message.
void	setEntity(HttpEntity entity) Associates a response entity with this response.
void	setHeader(Header header) Overwrites the first header with the same name.
void	setHeader(java.lang.String name, java.lang.String value) Overwrites the first header with the same name.
void	setHeaders(Header[] headers) Overwrites all the headers in the message.
void	setLocale(java.util.Locale loc) Changes the locale of this response.
void	setParams(HttpParams params) Deprecated.
void	setReasonPhrase(java.lang.String reason) Updates the status line of this response with a new reason phrase.
void	setStatusCode(int code) Updates the status line of this response with a new status code.
void	setStatusLine(ProtocolVersion ver, int code) Sets the status line of this response.
void	setStatusLine(ProtocolVersion ver, int code, java.lang.String reason) Sets the status line of this response with a reason phrase.
void	setStatusLine(StatusLine statusline) Sets the status line of this response.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpResponseProxy

public HttpResponseProxy(HttpResponse original,
                 ConnectionHolder connHolder)

Method Detail

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

getStatusLine

public StatusLine getStatusLine()

Description copied from interface: HttpResponse

Obtains the status line of this response. The status line can be set using one of the setStatusLine methods, or it can be initialized in a constructor.

Specified by:

getStatusLine in interface HttpResponse

Returns:

the status line, or null if not yet set

setStatusLine

public void setStatusLine(StatusLine statusline)

Description copied from interface: HttpResponse

Sets the status line of this response.

Specified by:

setStatusLine in interface HttpResponse

Parameters:

statusline - the status line of this response

setStatusLine

public void setStatusLine(ProtocolVersion ver,
                 int code)

Description copied from interface: HttpResponse

Sets the status line of this response. The reason phrase will be determined based on the current locale.

Specified by:

setStatusLine in interface HttpResponse

Parameters:

ver - the HTTP version

code - the status code

setStatusLine

public void setStatusLine(ProtocolVersion ver,
                 int code,
                 java.lang.String reason)

Description copied from interface: HttpResponse

Sets the status line of this response with a reason phrase.

Specified by:

setStatusLine in interface HttpResponse

Parameters:

ver - the HTTP version

code - the status code

reason - the reason phrase, or null to omit

setStatusCode

public void setStatusCode(int code)
                   throws java.lang.IllegalStateException

Description copied from interface: HttpResponse

Updates the status line of this response with a new status code.

Specified by:

setStatusCode in interface HttpResponse

Parameters:

code - the HTTP status code.

Throws:

java.lang.IllegalStateException - if the status line has not be set

See Also:

HttpStatus, HttpResponse.setStatusLine(StatusLine), HttpResponse.setStatusLine(ProtocolVersion,int)

setReasonPhrase

public void setReasonPhrase(java.lang.String reason)
                     throws java.lang.IllegalStateException

Description copied from interface: HttpResponse

Updates the status line of this response with a new reason phrase.

Specified by:

setReasonPhrase in interface HttpResponse

Parameters:

reason - the new reason phrase as a single-line string, or null to unset the reason phrase

Throws:

java.lang.IllegalStateException - if the status line has not be set

See Also:

HttpResponse.setStatusLine(StatusLine), HttpResponse.setStatusLine(ProtocolVersion,int)

getEntity

public HttpEntity getEntity()

Description copied from interface: HttpResponse

Obtains the message entity of this response, if any. The entity is provided by calling setEntity.

Specified by:

getEntity in interface HttpResponse

Returns:

the response entity, or null if there is none

setEntity

public void setEntity(HttpEntity entity)

Description copied from interface: HttpResponse

Associates a response entity with this response.

Please note that if an entity has already been set for this response and it depends on an input stream (HttpEntity.isStreaming() returns true), it must be fully consumed in order to ensure release of resources.

Specified by:

setEntity in interface HttpResponse

Parameters:

entity - the entity to associate with this response, or null to unset

See Also:

HttpEntity.isStreaming(), EntityUtils.updateEntity(HttpResponse, HttpEntity)

getLocale

public java.util.Locale getLocale()

Description copied from interface: HttpResponse

Obtains the locale of this response. The locale is used to determine the reason phrase for the status code. It can be changed using setLocale.

Specified by:

getLocale in interface HttpResponse

Returns:

the locale of this response, never null

setLocale

public void setLocale(java.util.Locale loc)

Description copied from interface: HttpResponse

Changes the locale of this response.

Specified by:

setLocale in interface HttpResponse

Parameters:

loc - the new locale

getProtocolVersion

public ProtocolVersion getProtocolVersion()

Description copied from interface: HttpMessage

Returns the protocol version this message is compatible with.

Specified by:

getProtocolVersion in interface HttpMessage

containsHeader

public boolean containsHeader(java.lang.String name)

Description copied from interface: HttpMessage

Checks if a certain header is present in this message. Header values are ignored.

Specified by:

containsHeader in interface HttpMessage

Parameters:

name - the header name to check for.

Returns:

true if at least one header with this name is present.

getHeaders

public Header[] getHeaders(java.lang.String name)

Description copied from interface: HttpMessage

Returns all the headers with a specified name of this message. Header values are ignored. Headers are orderd in the sequence they will be sent over a connection.

Specified by:

getHeaders in interface HttpMessage

Parameters:

name - the name of the headers to return.

Returns:

the headers whose name property equals name.

getFirstHeader

public Header getFirstHeader(java.lang.String name)

Description copied from interface: HttpMessage

Returns the first header with a specified name of this message. Header values are ignored. If there is more than one matching header in the message the first element of HttpMessage.getHeaders(String) is returned. If there is no matching header in the message null is returned.

Specified by:

getFirstHeader in interface HttpMessage

Parameters:

name - the name of the header to return.

Returns:

the first header whose name property equals name or null if no such header could be found.

getLastHeader

public Header getLastHeader(java.lang.String name)

Description copied from interface: HttpMessage

Returns the last header with a specified name of this message. Header values are ignored. If there is more than one matching header in the message the last element of HttpMessage.getHeaders(String) is returned. If there is no matching header in the message null is returned.

Specified by:

getLastHeader in interface HttpMessage

Parameters:

name - the name of the header to return.

Returns:

the last header whose name property equals name. or null if no such header could be found.

getAllHeaders

public Header[] getAllHeaders()

Description copied from interface: HttpMessage

Returns all the headers of this message. Headers are orderd in the sequence they will be sent over a connection.

Specified by:

getAllHeaders in interface HttpMessage

Returns:

all the headers of this message

addHeader

public void addHeader(Header header)

Description copied from interface: HttpMessage

Adds a header to this message. The header will be appended to the end of the list.

Specified by:

addHeader in interface HttpMessage

Parameters:

header - the header to append.

addHeader

public void addHeader(java.lang.String name,
             java.lang.String value)

Description copied from interface: HttpMessage

Adds a header to this message. The header will be appended to the end of the list.

Specified by:

addHeader in interface HttpMessage

Parameters:

name - the name of the header.

value - the value of the header.

setHeader

public void setHeader(Header header)

Description copied from interface: HttpMessage

Overwrites the first header with the same name. The new header will be appended to the end of the list, if no header with the given name can be found.

Specified by:

setHeader in interface HttpMessage

Parameters:

header - the header to set.

setHeader

public void setHeader(java.lang.String name,
             java.lang.String value)

Description copied from interface: HttpMessage

Overwrites the first header with the same name. The new header will be appended to the end of the list, if no header with the given name can be found.

Specified by:

setHeader in interface HttpMessage

Parameters:

name - the name of the header.

value - the value of the header.

setHeaders

public void setHeaders(Header[] headers)

Description copied from interface: HttpMessage

Overwrites all the headers in the message.

Specified by:

setHeaders in interface HttpMessage

Parameters:

headers - the array of headers to set.

removeHeader

public void removeHeader(Header header)

Description copied from interface: HttpMessage

Removes a header from this message.

Specified by:

removeHeader in interface HttpMessage

Parameters:

header - the header to remove.

removeHeaders

public void removeHeaders(java.lang.String name)

Description copied from interface: HttpMessage

Removes all headers with a certain name from this message.

Specified by:

removeHeaders in interface HttpMessage

Parameters:

name - The name of the headers to remove.

headerIterator

public HeaderIterator headerIterator()

Description copied from interface: HttpMessage

Returns an iterator of all the headers.

Specified by:

headerIterator in interface HttpMessage

Returns:

Iterator that returns Header objects in the sequence they are sent over a connection.

headerIterator

public HeaderIterator headerIterator(java.lang.String name)

Description copied from interface: HttpMessage

Returns an iterator of the headers with a given name.

Specified by:

headerIterator in interface HttpMessage

Parameters:

name - the name of the headers over which to iterate, or null for all headers

Returns:

Iterator that returns Header objects with the argument name in the sequence they are sent over a connection.

getParams

@Deprecated
public HttpParams getParams()

Deprecated.

Description copied from interface: HttpMessage

Returns the parameters effective for this message as set by HttpMessage.setParams(HttpParams).

Specified by:

getParams in interface HttpMessage

setParams

@Deprecated
public void setParams(HttpParams params)

Deprecated.

Description copied from interface: HttpMessage

Provides parameters to be used for the processing of this message.

Specified by:

setParams in interface HttpMessage

Parameters:

params - the parameters

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object