org.apache.http
public
interface
org.apache.http.HttpMessage
org.apache.http.HttpMessage |
|
A generic HTTP message.
Holds what is common between requests and responses.
Known Indirect Subclasses
AbstractHttpMessage,
BasicHttpEntityEnclosingRequest,
BasicHttpRequest,
BasicHttpResponse,
HttpDelete,
HttpEntityEnclosingRequest,
HttpEntityEnclosingRequestBase,
HttpGet,
HttpHead,
HttpOptions,
HttpPost,
HttpPut,
HttpRequest,
HttpRequestBase,
HttpResponse,
HttpTrace,
HttpUriRequest
Summary
Details
Public Methods
public
void
addHeader(String name, 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.
|
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.
|
public
boolean
containsHeader(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.
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
public
Header
getFirstHeader(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
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.
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)
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.
Returns the protocol version this message is compatible with.
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.
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)
Removes a header from this message.
Parameters
header
| the header to remove.
|
public
void
removeHeaders(String name)
Removes all headers with a certain name from this message.
Parameters
name
| The name of the headers to remove.
|
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.
|
public
void
setHeader(String name, 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.
|
public
void
setHeaders(Header[] headers)
Overwrites all the headers in the message.
Parameters
headers
| the array of headers to set.
|
public
void
setParams(HttpParams params)
Provides parameters to be used for the processing of this message.