Android APIs
public class

BasicHttpResponse

extends AbstractHttpMessage
implements HttpResponse
java.lang.Object
   ↳ org.apache.http.message.AbstractHttpMessage
     ↳ org.apache.http.message.BasicHttpResponse

This class was deprecated in API level 22.
Please use openConnection() instead. Please visit this webpage for further details.

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
From interface org.apache.http.HttpMessage
From interface org.apache.http.HttpResponse

Public Constructors

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

Added in 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)

Added in 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)

Added in 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 ()

Added in 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 ()

Added in 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 ()

Added in API level 1

Returns the protocol version this message is compatible with.

public StatusLine getStatusLine ()

Added in 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)

Added in 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)

Added in 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)

Added in 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)

Added in 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)

Added in 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)

Added in 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)

Added in 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)

Added in 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