org.apache.http
Interface HttpMessage

All Known Subinterfaces:
HttpEntityEnclosingRequest, HttpRequest, HttpResponse
All Known Implementing Classes:
AbstractHttpMessage, BasicHttpEntityEnclosingRequest, BasicHttpRequest, BasicHttpResponse

public interface HttpMessage

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

Since:
4.0
Version:
$Revision: 496070 $
Author:
Oleg Kalnichevski

Method Summary
 void addHeader(Header header)
          Adds a header to this message.
 void addHeader(java.lang.String name, java.lang.String value)
          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.
 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)
          Overwrites the first header with the same name.
 void setHeader(java.lang.String name, java.lang.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.
 

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.

Parameters:
name - the header name to check for.
Returns:
true if at least one header with this name is present.

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.

Parameters:
name - the name of the headers to return.
Returns:
the headers whose name property equals name.

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

Parameters:
name - the name of the header to return.
Returns:
the first header whose name property equals name.

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

Parameters:
name - the name of the header to return.
Returns:
the last header whose name property equals name.

getAllHeaders

public Header[] getAllHeaders()
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

addHeader

public void addHeader(Header header)
Adds a header to this message. The header will be appended to the end of the list.

Parameters:
header - the header to append.

addHeader

public void addHeader(java.lang.String name,
                      java.lang.String value)
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.

setHeader

public void setHeader(Header header)
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.

setHeader

public void setHeader(java.lang.String name,
                      java.lang.String value)
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.

setHeaders

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

Parameters:
headers - the array of headers to set.

removeHeader

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

Parameters:
header - the header to remove.

removeHeaders

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

Parameters:
name - The name of the headers to remove.

headerIterator

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

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

getParams

public HttpParams getParams()
Returns the parameters effective for this message as set by


setParams

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

Parameters:
params - the parameters


Copyright © 2005-2007 Apache Software Foundation. All Rights Reserved.