HttpMessage

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> apache >> [ http overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.apache.http.HttpMessage

SOURCE |

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.http
Interface HttpMessage

All Known Subinterfaces:: HttpEntityEnclosingRequest, HttpRequest, HttpResponse

public interface HttpMessage

A generic HTTP message. Holds what is common between requests and responses.

Since:: 4.0
Version:: $Revision: 391251 $

Method Summary

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

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

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

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

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

HttpVersion getHttpVersion()
          Returns the HTTP version this message is compatible with.

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

org.apache.http.params.HttpParams getParams()
          Returns the parameters effective for this message as set by

java.util.Iterator headerIterator()
          Returns an iterator of all the headers.

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

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

void setHeader(Header header)
          Adds a header to this message.

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

Method Detail

getHttpVersion

public HttpVersion getHttpVersion()

Returns the HTTP version this message is compatible with.

containsHeader

public boolean containsHeader(java.lang.String name)

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

getHeaders

public Header[] getHeaders(java.lang.String name)

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.

getFirstHeader

public Header getFirstHeader(java.lang.String name)

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

getLastHeader

public Header getLastHeader(java.lang.String name)

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

getAllHeaders

public Header[] getAllHeaders()

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

addHeader

public void addHeader(Header header)

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

setHeader

public void setHeader(Header header)

Adds a header to this message. The new header will be appended to the end of the list. Existing headers with the same name will be removed.

removeHeader

public void removeHeader(Header header)

Removes a header from this message.

removeHeaders

public void removeHeaders(java.lang.String name)

Removes all headers with a certain name from this message.

headerIterator

public java.util.Iterator headerIterator()

Returns an iterator of all the headers.

getParams

public org.apache.http.params.HttpParams getParams()

Returns the parameters effective for this message as set by

setParams

public void setParams(org.apache.http.params.HttpParams params)

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