org.apache.http
Interface HttpResponse

All Superinterfaces:

HttpMessage

All Known Implementing Classes:

BasicHttpResponse

public interface HttpResponse

extends HttpMessage

An HTTP response.

Since:

4.0

Version:

$Revision: 505744 $

Author:

Oleg Kalnichevski

Method Summary

HttpEntity	getEntity() Obtains the message entity of this response, if any.
java.util.Locale	getLocale() Obtains the locale of this response.
StatusLine	getStatusLine() Obtains the status line of this response.
void	setEntity(HttpEntity entity) Associates a response entity with this response.
void	setLocale(java.util.Locale loc) Changes the locale of this response.
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(HttpVersion ver, int code) Sets the status line of this response.
void	setStatusLine(HttpVersion 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.

Methods inherited from interface org.apache.http.HttpMessage

addHeader, addHeader, containsHeader, getAllHeaders, getFirstHeader, getHeaders, getHttpVersion, getLastHeader, getParams, headerIterator, removeHeader, removeHeaders, setHeader, setHeader, setHeaders, setParams

Method Detail

getStatusLine

public StatusLine getStatusLine()

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

Returns:

the status line, or null if not yet set

setStatusLine

public void setStatusLine(StatusLine statusline)

Sets the status line of this response.

Parameters:

statusline - the status line of this response

setStatusLine

public void setStatusLine(HttpVersion ver,
                          int code)

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

setStatusLine

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

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

setStatusCode

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

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.

Throws:

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

See Also:

HttpStatus, setStatusLine(StatusLine), setStatusLine(HttpVersion,int)

setReasonPhrase

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

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

Throws:

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

See Also:

setStatusLine(StatusLine), setStatusLine(HttpVersion,int)

getEntity

public HttpEntity getEntity()

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

setEntity

public void setEntity(HttpEntity entity)

Associates a response entity with this response.

Parameters:

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

getLocale

public java.util.Locale getLocale()

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

setLocale

public void setLocale(java.util.Locale loc)

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

See Also:

getLocale, setStatusCode