Description

Author: Oleg Kalnichevski

Version

Revision: 652956

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
StatusLine	getStatusLine ()
	Obtains the status line of this response. More...

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

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

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

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

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

void	setEntity (HttpEntity entity)
	Associates a response entity with 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	setLocale (Locale loc)
	Changes the locale of this response. More...

Public Member Functions inherited from HttpMessage
ProtocolVersion	getProtocolVersion ()
	Returns the protocol version this message is compatible with.

boolean	containsHeader (String name)
	Checks if a certain header is present in this message. More...

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

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

Header	getLastHeader (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 (Header header)
	Adds a header to this message. More...

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

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

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

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

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

void	removeHeaders (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...

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

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

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

Implemented in BasicHttpResponse.

◆ setStatusLine() [1/3]

void setStatusLine ( StatusLine statusline )

Parameters

statusline the status line of this response

Implemented in BasicHttpResponse.

◆ setStatusLine() [2/3]

void setStatusLine	(	ProtocolVersion	ver,
		int	code
	)

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

Parameters

ver	the HTTP version
code	the status code

Implemented in BasicHttpResponse.

◆ setStatusLine() [3/3]

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

Parameters

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

Implemented in BasicHttpResponse.

◆ setStatusCode()

void setStatusCode ( int code ) throws IllegalStateException

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