to top

Since: API Level 1

public class

BasicHttpResponse

extends AbstractHttpMessage
implements HttpResponse

java.lang.Object
↳	org.apache.http.message.AbstractHttpMessage
	↳	org.apache.http.message.BasicHttpResponse

Class Overview

Basic implementation of an HTTP response that can be modified. This implementation makes sure that there always is a status line.

Summary

[Expand]

Inherited Fields

From class org.apache.http.message.AbstractHttpMessage

Public Constructors
	BasicHttpResponse(StatusLine statusline, ReasonPhraseCatalog catalog, Locale locale) Creates a new response.
	BasicHttpResponse(StatusLine statusline) Creates a response from a status line.
	BasicHttpResponse(ProtocolVersion ver, int code, String reason) Creates a response from elements of a status line.

Public Methods
HttpEntity	getEntity() Obtains the message entity of this response, if any.
Locale	getLocale() Obtains the locale of this response.
ProtocolVersion	getProtocolVersion() Returns the protocol version this message is compatible with.
StatusLine	getStatusLine() Obtains the status line of this response.
void	setEntity(HttpEntity entity) Associates a response entity with this response.
void	setLocale(Locale loc) Changes the locale of this response.
void	setReasonPhrase(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(StatusLine statusline) Sets the status line of this response.
void	setStatusLine(ProtocolVersion ver, int code) Sets the status line of this response.
void	setStatusLine(ProtocolVersion ver, int code, String reason) Sets the status line of this response with a reason phrase.

Protected Methods
String	getReason(int code) Looks up a reason phrase.

[Expand]

Inherited Methods

From class org.apache.http.message.AbstractHttpMessage

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

From interface org.apache.http.HttpMessage

abstract void	addHeader(Header header) Adds a header to this message.
abstract void	addHeader(String name, String value) Adds a header to this message.
abstract boolean	containsHeader(String name) Checks if a certain header is present in this message.
abstract Header[]	getAllHeaders() Returns all the headers of this message.
abstract Header	getFirstHeader(String name) Returns the first header with a specified name of this message.
abstract Header[]	getHeaders(String name) Returns all the headers with a specified name of this message.
abstract Header	getLastHeader(String name) Returns the last header with a specified name of this message.
abstract HttpParams	getParams() Returns the parameters effective for this message as set by `setParams(HttpParams)`.
abstract ProtocolVersion	getProtocolVersion() Returns the protocol version this message is compatible with.
abstract HeaderIterator	headerIterator(String name) Returns an iterator of the headers with a given name.
abstract HeaderIterator	headerIterator() Returns an iterator of all the headers.
abstract void	removeHeader(Header header) Removes a header from this message.
abstract void	removeHeaders(String name) Removes all headers with a certain name from this message.
abstract void	setHeader(Header header) Overwrites the first header with the same name.
abstract void	setHeader(String name, String value) Overwrites the first header with the same name.
abstract void	setHeaders(Header[] headers) Overwrites all the headers in the message.
abstract void	setParams(HttpParams params) Provides parameters to be used for the processing of this message.

From interface org.apache.http.HttpResponse

abstract HttpEntity	getEntity() Obtains the message entity of this response, if any.
abstract Locale	getLocale() Obtains the locale of this response.
abstract StatusLine	getStatusLine() Obtains the status line of this response.
abstract void	setEntity(HttpEntity entity) Associates a response entity with this response.
abstract void	setLocale(Locale loc) Changes the locale of this response.
abstract void	setReasonPhrase(String reason) Updates the status line of this response with a new reason phrase.
abstract void	setStatusCode(int code) Updates the status line of this response with a new status code.
abstract void	setStatusLine(StatusLine statusline) Sets the status line of this response.
abstract void	setStatusLine(ProtocolVersion ver, int code) Sets the status line of this response.
abstract void	setStatusLine(ProtocolVersion ver, int code, String reason) Sets the status line of this response with a reason phrase.

Public Constructors

public BasicHttpResponse (StatusLine statusline, ReasonPhraseCatalog catalog, Locale locale)

Since: API Level 1

Creates a new response. This is the constructor to which all others map.

Parameters

statusline	the status line
catalog	the reason phrase catalog, or `null` to disable automatic reason phrase lookup
locale	the locale for looking up reason phrases, or `null` for the system locale

public BasicHttpResponse (StatusLine statusline)

Since: API Level 1

Creates a response from a status line. The response will not have a reason phrase catalog and use the system default locale.

Parameters

statusline	the status line

public BasicHttpResponse (ProtocolVersion ver, int code, String reason)

Since: API Level 1

Creates a response from elements of a status line. The response will not have a reason phrase catalog and use the system default locale.

Parameters

ver	the protocol version of the response
code	the status code of the response
reason	the reason phrase to the status code, or `null`

Public Methods

public HttpEntity getEntity ()

Since: API Level 1

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

Returns

the response entity, or null if there is none

public Locale getLocale ()

Since: API Level 1

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.

Returns

the locale of this response, never null

public ProtocolVersion getProtocolVersion ()

Since: API Level 1

Returns the protocol version this message is compatible with.

public StatusLine getStatusLine ()

Since: API Level 1

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.

Returns

the status line, or null if not yet set

public void setEntity (HttpEntity entity)

Since: API Level 1

Associates a response entity with this response.

Parameters

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

public void setLocale (Locale loc)

Since: API Level 1

Changes the locale of this response. If there is a status line, it's reason phrase will be updated according to the status code and new locale.

Parameters

loc	the new locale

public void setReasonPhrase (String reason)

Since: API Level 1

Updates the status line of this response with a new reason phrase. The status line can only be updated if it is available. It must have been set either explicitly or in a constructor.

Parameters

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

public void setStatusCode (int code)

Since: API Level 1

Updates the status line of this response with a new status code. The status line can only be updated if it is available. It must have been set either explicitly or in a constructor.
The reason phrase will be updated according to the new status code, based on the current locale. It can be set explicitly using setReasonPhrase.

Parameters

code	the HTTP status code.

public void setStatusLine (StatusLine statusline)

Since: API Level 1

Sets the status line of this response.

Parameters

statusline	the status line of this response

public void setStatusLine (ProtocolVersion ver, int code)

Since: API Level 1

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

Parameters

ver	the HTTP version
code	the status code

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

Since: API Level 1

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

Parameters

ver	the HTTP version
code	the status code
reason	the reason phrase, or `null` to omit

Protected Methods

protected String getReason (int code)

Since: API Level 1

Looks up a reason phrase. This method evaluates the currently set catalog and locale. It also handles a missing catalog.

Parameters

code	the status code for which to look up the reason

Returns

the reason phrase, or null if there is none

Results

Interfaces

Classes

BasicHttpResponse

Class Overview

Summary

Public Constructors

public BasicHttpResponse (StatusLine statusline, ReasonPhraseCatalog catalog, Locale locale)

Parameters

public BasicHttpResponse (StatusLine statusline)

Parameters

public BasicHttpResponse (ProtocolVersion ver, int code, String reason)

Parameters

Public Methods

public HttpEntity getEntity ()

Returns

public Locale getLocale ()

Returns

public ProtocolVersion getProtocolVersion ()

public StatusLine getStatusLine ()

Returns

public void setEntity (HttpEntity entity)

Parameters

public void setLocale (Locale loc)

Parameters

public void setReasonPhrase (String reason)

Parameters

public void setStatusCode (int code)

Parameters

public void setStatusLine (StatusLine statusline)

Parameters

public void setStatusLine (ProtocolVersion ver, int code)

Parameters

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

Parameters

Protected Methods

protected String getReason (int code)

Parameters

Returns