to top

Summary: Fields | Protected Ctors | Methods | Inherited Methods | [Expand All]

Since: API Level 1

public abstract class

AbstractHttpMessage

extends Object
implements HttpMessage

java.lang.Object
↳	org.apache.http.message.AbstractHttpMessage

Known Direct Subclasses

BasicHttpRequest, BasicHttpResponse, HttpRequestBase, RequestWrapper

Known Indirect Subclasses

BasicHttpEntityEnclosingRequest, EntityEnclosingRequestWrapper, HttpDelete, HttpEntityEnclosingRequestBase, HttpGet, HttpHead, HttpOptions, HttpPost, HttpPut, HttpTrace

Class Overview

Basic implementation of an HTTP message that can be modified.

Summary

Fields
protected HeaderGroup	headergroup
protected HttpParams	params

Protected Constructors
	AbstractHttpMessage(HttpParams params)
	AbstractHttpMessage()

Public Methods
void	addHeader(Header header) Adds a header to this message.
void	addHeader(String name, String value) Adds a header to this message.
boolean	containsHeader(String name) Checks if a certain header is present in this message.
Header[]	getAllHeaders() Returns all the headers of this message.
Header	getFirstHeader(String name) Returns the first header with a specified name of this message.
Header[]	getHeaders(String name) Returns all the headers with a specified name of this message.
Header	getLastHeader(String name) Returns the last header with a specified name of this message.
HttpParams	getParams() Returns the parameters effective for this message as set by `setParams(HttpParams)`.
HeaderIterator	headerIterator(String name) Returns an iterator of the headers with a given name.
HeaderIterator	headerIterator() Returns an iterator of all the headers.
void	removeHeader(Header header) Removes a header from this message.
void	removeHeaders(String name) Removes all headers with a certain name from this message.
void	setHeader(Header header) Overwrites the first header with the same name.
void	setHeader(String name, String value) Overwrites the first header with the same name.
void	setHeaders(Header[] headers) Overwrites all the headers in the message.
void	setParams(HttpParams params) Provides parameters to be used for the processing of this message.

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

From interface org.apache.http.HttpMessage

abstract void	addHeader(Header header) Adds a header to this message.
abstract void	addHeader(String name, String value) Adds a header to this message.
abstract boolean	containsHeader(String name) Checks if a certain header is present in this message.
abstract Header[]	getAllHeaders() Returns all the headers of this message.
abstract Header	getFirstHeader(String name) Returns the first header with a specified name of this message.
abstract Header[]	getHeaders(String name) Returns all the headers with a specified name of this message.
abstract Header	getLastHeader(String name) Returns the last header with a specified name of this message.
abstract HttpParams	getParams() Returns the parameters effective for this message as set by `setParams(HttpParams)`.
abstract ProtocolVersion	getProtocolVersion() Returns the protocol version this message is compatible with.
abstract HeaderIterator	headerIterator(String name) Returns an iterator of the headers with a given name.
abstract HeaderIterator	headerIterator() Returns an iterator of all the headers.
abstract void	removeHeader(Header header) Removes a header from this message.
abstract void	removeHeaders(String name) Removes all headers with a certain name from this message.
abstract void	setHeader(Header header) Overwrites the first header with the same name.
abstract void	setHeader(String name, String value) Overwrites the first header with the same name.
abstract void	setHeaders(Header[] headers) Overwrites all the headers in the message.
abstract void	setParams(HttpParams params) Provides parameters to be used for the processing of this message.

Fields

protected HeaderGroup headergroup

Since: API Level 1

protected HttpParams params

Since: API Level 1

Protected Constructors

protected AbstractHttpMessage (HttpParams params)

Since: API Level 1

protected AbstractHttpMessage ()

Since: API Level 1

Public Methods

public void addHeader (Header header)

Since: API Level 1

Adds a header to this message. The header will be appended to the end of the list.

Parameters

header	the header to append.

public void addHeader (String name, String value)

Since: API Level 1

Adds a header to this message. The header will be appended to the end of the list.

Parameters

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

public boolean containsHeader (String name)

Since: API Level 1

Checks if a certain header is present in this message. Header values are ignored.

Parameters

name	the header name to check for.

Returns

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

public Header[] getAllHeaders ()

Since: API Level 1

Returns all the headers of this message. Headers are orderd in the sequence they will be sent over a connection.

Returns

all the headers of this message

public Header getFirstHeader (String name)

Since: API Level 1

Returns the first header with a specified name of this message. Header values are ignored. If there is more than one matching header in the message the first element of getHeaders(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.

public Header[] getHeaders (String name)

Since: API Level 1

Returns all the headers with a specified name of this message. 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.

public Header getLastHeader (String name)

Since: API Level 1

Returns the last header with a specified name of this message. Header values are ignored. If there is more than one matching header in the message the last element of getHeaders(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.

public HttpParams getParams ()

Since: API Level 1

Returns the parameters effective for this message as set by setParams(HttpParams).

public HeaderIterator headerIterator (String name)

Since: API Level 1

Returns an iterator of the headers with a given 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.

public HeaderIterator headerIterator ()

Since: API Level 1

Returns an iterator of all the headers.

Returns

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

public void removeHeader (Header header)

Since: API Level 1

Removes a header from this message.

Parameters

header	the header to remove.

public void removeHeaders (String name)

Since: API Level 1

Removes all headers with a certain name from this message.

Parameters

name	The name of the headers to remove.

public void setHeader (Header header)

Since: API Level 1

Overwrites the first header with the same name. 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.

public void setHeader (String name, String value)

Since: API Level 1

Overwrites the first header with the same name. 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.

public void setHeaders (Header[] headers)

Since: API Level 1

Overwrites all the headers in the message.

Parameters

headers	the array of headers to set.

public void setParams (HttpParams params)

Since: API Level 1

Provides parameters to be used for the processing of this message.

Parameters

params	the parameters

Results

Interfaces

Classes

AbstractHttpMessage

Class Overview

Summary

Fields

protected HeaderGroup headergroup

protected HttpParams params

Protected Constructors

protected AbstractHttpMessage (HttpParams params)

protected AbstractHttpMessage ()

Public Methods

public void addHeader (Header header)

Parameters

public void addHeader (String name, String value)

Parameters

public boolean containsHeader (String name)

Parameters

Returns

public Header[] getAllHeaders ()

Returns

public Header getFirstHeader (String name)

Parameters

Returns

public Header[] getHeaders (String name)

Parameters

Returns

public Header getLastHeader (String name)

Parameters

Returns

public HttpParams getParams ()

public HeaderIterator headerIterator (String name)

Parameters

Returns

public HeaderIterator headerIterator ()

Returns

public void removeHeader (Header header)

Parameters

public void removeHeaders (String name)

Parameters

public void setHeader (Header header)

Parameters

public void setHeader (String name, String value)

Parameters

public void setHeaders (Header[] headers)

Parameters

public void setParams (HttpParams params)

Parameters