Basic implementation of an HTTP response that can be modified. More...

Inheritance diagram for BasicHttpResponse:

Description

This implementation makes sure that there always is a status line.

Author: Oleg Kalnichevski

Version

Revision: 573864

Since: 4.0

Notice

The following notice applies to the original API on which this API is based, and to its documentation. The documentation of this API has been revised from the original.

/*
 * Copyright (C) 2006 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

Public Member Functions
	BasicHttpResponse (final StatusLine statusline, final ReasonPhraseCatalog catalog, final Locale locale)
	Creates a new response. More...

	BasicHttpResponse (final StatusLine statusline)
	Creates a response from a status line. More...

	BasicHttpResponse (final ProtocolVersion ver, final int code, final String reason)
	Creates a response from elements of a status line. More...

ProtocolVersion	getProtocolVersion ()
	Returns the protocol version this message is compatible with.

StatusLine	getStatusLine ()
	Obtains the status line of this response. More...

HttpEntity	getEntity ()
	Obtains the message entity of this response, if any. More...

Locale	getLocale ()
	Obtains the locale of this response. More...

void	setStatusLine (final StatusLine statusline)
	Sets the status line of this response. More...

void	setStatusLine (final ProtocolVersion ver, final int code)
	Sets the status line of this response. More...

void	setStatusLine (final ProtocolVersion ver, final int code, final String reason)
	Sets the status line of this response with a reason phrase. More...

void	setStatusCode (int code)
	Updates the status line of this response with a new status code. More...

void	setReasonPhrase (String reason)
	Updates the status line of this response with a new reason phrase. More...

void	setEntity (final HttpEntity entity)
	Associates a response entity with this response. More...

void	setLocale (Locale loc)
	Changes the locale of this response. More...

Public Member Functions inherited from AbstractHttpMessage
boolean	containsHeader (String name)
	Checks if a certain header is present in this message. More...

Header[]	getHeaders (final String name)
	Returns all the headers with a specified name of this message. More...

Header	getFirstHeader (final String name)
	Returns the first header with a specified name of this message. More...

Header	getLastHeader (final String name)
	Returns the last header with a specified name of this message. More...

Header[]	getAllHeaders ()
	Returns all the headers of this message. More...

void	addHeader (final Header header)
	Adds a header to this message. More...

void	addHeader (final String name, final String value)
	Adds a header to this message. More...

void	setHeader (final Header header)
	Overwrites the first header with the same name. More...

void	setHeader (final String name, final String value)
	Overwrites the first header with the same name. More...

void	setHeaders (final Header[] headers)
	Overwrites all the headers in the message. More...

void	removeHeader (final Header header)
	Removes a header from this message. More...

void	removeHeaders (final String name)
	Removes all headers with a certain name from this message. More...

HeaderIterator	headerIterator ()
	Returns an iterator of all the headers. More...

HeaderIterator	headerIterator (String name)
	Returns an iterator of the headers with a given name. More...

HttpParams	getParams ()
	Returns the parameters effective for this message as set by setParams(com.good.gd.apache.http.params.HttpParams).

void	setParams (final HttpParams params)
	Provides parameters to be used for the processing of this message. More...

Protected Member Functions
String	getReason (int code)
	Looks up a reason phrase. More...

Constructor & Destructor Documentation

◆ BasicHttpResponse() [1/3]

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

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

◆ BasicHttpResponse() [2/3]

BasicHttpResponse ( final StatusLine statusline )

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

Parameters

statusline the status line

◆ BasicHttpResponse() [3/3]

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

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`

Member Function Documentation

◆ getStatusLine()

StatusLine getStatusLine ( )

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

Implements HttpResponse.

◆ getEntity()

HttpEntity getEntity ( )

The entity is provided by calling setEntity .

Returns: the response entity, or null if there is none

Implements HttpResponse.

◆ getLocale()

Locale getLocale ( )

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

Implements HttpResponse.

◆ setStatusLine() [1/3]

void setStatusLine ( final StatusLine statusline )

Parameters

statusline the status line of this response

Implements HttpResponse.

◆ setStatusLine() [2/3]

void setStatusLine	(	final ProtocolVersion	ver,
		final int	code
	)

The reason phrase will be determined based on the current locale .

Parameters

ver	the HTTP version
code	the status code

Implements HttpResponse.

◆ setStatusLine() [3/3]

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

Parameters

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

Implements HttpResponse.

◆ setStatusCode()

void setStatusCode ( int 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.

Exceptions

IllegalStateException if the status line has not be set

See also: HttpStatus; setStatusLine(com.good.gd.apache.http.StatusLine); setStatusLine(com.good.gd.apache.http.ProtocolVersion,int)

Implements HttpResponse.

◆ setReasonPhrase()

void setReasonPhrase ( String reason )

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

Exceptions

IllegalStateException if the status line has not be set

See also: setStatusLine(com.good.gd.apache.http.StatusLine); setStatusLine(com.good.gd.apache.http.ProtocolVersion,int)

Implements HttpResponse.

◆ setEntity()

void setEntity ( final HttpEntity entity )

Parameters

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

Implements HttpResponse.

◆ setLocale()

void setLocale ( Locale loc )

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 getLocale; setStatusCode setStatusCode

Implements HttpResponse.

◆ getReason()

String getReason ( int code )

protected

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

Description

Notice

Public Member Functions

Protected Member Functions

Constructor & Destructor Documentation

◆ BasicHttpResponse() [1/3]

◆ BasicHttpResponse() [2/3]

◆ BasicHttpResponse() [3/3]

Member Function Documentation

◆ getStatusLine()

◆ getEntity()

◆ getLocale()

◆ setStatusLine() [1/3]

◆ setStatusLine() [2/3]

◆ setStatusLine() [3/3]

◆ setStatusCode()

◆ setReasonPhrase()

◆ setEntity()

◆ setLocale()

◆ getReason()