HttpMessage Interface Reference

A generic HTTP message. More...

Inheritance diagram for HttpMessage:

Description

Holds what is common between requests and responses.

Author

Oleg Kalnichevski

Version

Revision

610823

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

containsHeader()

boolean containsHeader

(

String

name

)

Header values are ignored.

Parameters

name	the header name to check for.

Returns

true if at least one header with this name is present.

Implemented in AbstractHttpMessage.

getHeaders()

Header [] getHeaders

(

String

name

)

Header values are ignored. Headers are orderd in the sequence they will be sent over a connection.

Parameters

name	the name of the headers to return.

Returns

the headers whose name property equals name.

Implemented in AbstractHttpMessage.

getFirstHeader()

Header getFirstHeader

(

String

name

)

Header values are ignored. If there is more than one matching header in the message the first element of (String) is returned. If there is no matching header in the message null is returned.

Parameters

name	the name of the header to return.

Returns

the first header whose name property equals name or null if no such header could be found.

Implemented in AbstractHttpMessage.

getLastHeader()

Header getLastHeader

(

String

name

)

Header values are ignored. If there is more than one matching header in the message the last element of (String) is returned. If there is no matching header in the message null is returned.

Parameters

name	the name of the header to return.

Returns

the last header whose name property equals name. or null if no such header could be found.

Implemented in AbstractHttpMessage.

getAllHeaders()

Header [] getAllHeaders

(

)

Headers are orderd in the sequence they will be sent over a connection.

Returns

all the headers of this message

Implemented in AbstractHttpMessage.

addHeader() [1/2]

void addHeader

(

Header

header

)

The header will be appended to the end of the list.

Parameters

header

the header to append.

Implemented in AbstractHttpMessage.

addHeader() [2/2]

void addHeader	(	String	name,
		String	value
	)

The header will be appended to the end of the list.

Parameters

name	the name of the header.
value	the value of the header.

Implemented in AbstractHttpMessage.

setHeader() [1/2]

void setHeader

(

Header

header

)

The new header will be appended to the end of the list, if no header with the given name can be found.

Parameters

header

the header to set.

Implemented in AbstractHttpMessage.

setHeader() [2/2]

void setHeader	(	String	name,
		String	value
	)

The new header will be appended to the end of the list, if no header with the given name can be found.

Parameters

name	the name of the header.
value	the value of the header.

Implemented in AbstractHttpMessage.

setHeaders()

void setHeaders

(

Header[]

headers

)

Parameters

headers

the array of headers to set.

Implemented in AbstractHttpMessage.

removeHeader()

void removeHeader

(

Header

header

)

Parameters

header

the header to remove.

Implemented in AbstractHttpMessage.

removeHeaders()

void removeHeaders

(

String

name

)

Parameters

name	The name of the headers to remove.

Implemented in AbstractHttpMessage.

headerIterator() [1/2]

HeaderIterator headerIterator

(

)

Returns

Iterator that returns Header objects in the sequence they are sent over a connection.

Implemented in AbstractHttpMessage.

headerIterator() [2/2]

HeaderIterator headerIterator

(

String

name

)

Parameters

name	the name of the headers over which to iterate, or null for all headers

Returns

Iterator that returns Header objects with the argument name in the sequence they are sent over a connection.

Implemented in AbstractHttpMessage.

setParams()

void setParams

(

HttpParams

params

)

Parameters

params

the parameters

Implemented in AbstractHttpMessage.