• BlackBerry Dynamics
  • Runtime library for Android applications
  • 12.0.1.79
AbstractHttpMessage Class Referenceabstract

Basic implementation of an HTTP message that can be modified. More...

Inheritance diagram for AbstractHttpMessage:
HttpMessage HttpRequestBase RequestWrapper BasicHttpRequest BasicHttpResponse HttpDelete HttpEntityEnclosingRequestBase HttpGet HttpHead HttpOptions HttpTrace EntityEnclosingRequestWrapper BasicHttpEntityEnclosingRequest

Description

Author
Oleg Kalnichevski
Version
Revision
620287
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

boolean containsHeader (String name)
 Checks if a certain header is present in this message. More...
 
Header[] getHeaders (final String name)
 Returns all the headers with a specified name of this message. More...
 
Header getFirstHeader (final String name)
 Returns the first header with a specified name of this message. More...
 
Header getLastHeader (final 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 (final Header header)
 Adds a header to this message. More...
 
void addHeader (final String name, final String value)
 Adds a header to this message. More...
 
void setHeader (final Header header)
 Overwrites the first header with the same name. More...
 
void setHeader (final String name, final String value)
 Overwrites the first header with the same name. More...
 
void setHeaders (final Header[] headers)
 Overwrites all the headers in the message. More...
 
void removeHeader (final Header header)
 Removes a header from this message. More...
 
void removeHeaders (final 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...
 
HttpParams getParams ()
 Returns the parameters effective for this message as set by setParams(com.good.gd.apache.http.params.HttpParams).
 
void setParams (final HttpParams params)
 Provides parameters to be used for the processing of this message. More...
 
- Public Member Functions inherited from HttpMessage
ProtocolVersion getProtocolVersion ()
 Returns the protocol version this message is compatible with.
 

Member Function Documentation

◆ containsHeader()

boolean containsHeader ( String  name)

Header values are ignored.

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

Implements HttpMessage.

◆ getHeaders()

Header [] getHeaders ( final String  name)

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

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

Implements HttpMessage.

◆ getFirstHeader()

Header getFirstHeader ( final 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
namethe name of the header to return.
Returns
the first header whose name property equals name or null if no such header could be found.

Implements HttpMessage.

◆ getLastHeader()

Header getLastHeader ( final 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
namethe name of the header to return.
Returns
the last header whose name property equals name. or null if no such header could be found.

Implements HttpMessage.

◆ getAllHeaders()

Header [] getAllHeaders ( )

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

Returns
all the headers of this message

Implements HttpMessage.

◆ addHeader() [1/2]

void addHeader ( final Header  header)

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

Parameters
headerthe header to append.

Implements HttpMessage.

◆ addHeader() [2/2]

void addHeader ( final String  name,
final String  value 
)

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

Parameters
namethe name of the header.
valuethe value of the header.

Implements HttpMessage.

◆ setHeader() [1/2]

void setHeader ( final 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
headerthe header to set.

Implements HttpMessage.

◆ setHeader() [2/2]

void setHeader ( final String  name,
final 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
namethe name of the header.
valuethe value of the header.

Implements HttpMessage.

◆ setHeaders()

void setHeaders ( final Header[]  headers)
Parameters
headersthe array of headers to set.

Implements HttpMessage.

◆ removeHeader()

void removeHeader ( final Header  header)
Parameters
headerthe header to remove.

Implements HttpMessage.

◆ removeHeaders()

void removeHeaders ( final String  name)
Parameters
nameThe name of the headers to remove.

Implements HttpMessage.

◆ headerIterator() [1/2]

HeaderIterator headerIterator ( )
Returns
Iterator that returns Header objects in the sequence they are sent over a connection.

Implements HttpMessage.

◆ headerIterator() [2/2]

HeaderIterator headerIterator ( String  name)
Parameters
namethe 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.

Implements HttpMessage.

◆ setParams()

void setParams ( final HttpParams  params)
Parameters
paramsthe parameters

Implements HttpMessage.