com.ibm.security.access.httpclient
Class Headers

java.lang.Object
  com.ibm.security.access.httpclient.Headers

public class Headers
extends java.lang.Object

This class stores the headers for a HTTP request.

Field Summary

static java.lang.String	Headers_java_copyright
static java.lang.String	Headers_java_sourceCodeID

Constructor Summary

Headers()

Method Summary

boolean	addHeader(java.lang.String name, java.util.List values) Add a header
boolean	addHeader(java.lang.String name, java.lang.String value) Add a header
java.lang.String[]	getHeader(java.lang.String name) Get the header values with the specified name.
java.lang.String[]	getHeaderNames() Get all the header names.
java.util.Map	getHeaders() Get all the headers
protected java.lang.String	getHeaderString(java.lang.String name) Get a String representation of the header values associated with the header name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

Headers_java_sourceCodeID

public static final java.lang.String Headers_java_sourceCodeID

See Also:

Constant Field Values

Headers_java_copyright

public static final java.lang.String Headers_java_copyright

See Also:

Constant Field Values

Constructor Detail

Headers

public Headers()

Method Detail

addHeader

public boolean addHeader(java.lang.String name,
                         java.util.List values)

Add a header

Parameters:

name - Header name

values - A List(String) of header values

Returns:

True if successful. False otherwise.

addHeader

public boolean addHeader(java.lang.String name,
                         java.lang.String value)

Add a header

Parameters:

name - Header name

value - Header value

Returns:

True if successful. False otherwise.

getHeaderNames

public java.lang.String[] getHeaderNames()

Get all the header names. Returns null if there are no headers.

Returns:

Header names. Null if no headers.

getHeaders

public java.util.Map getHeaders()

Get all the headers

Returns:

A Map(String,List(String)) of all headers

getHeader

public java.lang.String[] getHeader(java.lang.String name)

Get the header values with the specified name. Returns null if no such header name or name was null/empty string.

Parameters:

name - The header name

Returns:

A List(String) of values associated with that header name. Null if no such header name exists or name was null/empty string.

getHeaderString

protected java.lang.String getHeaderString(java.lang.String name)

Get a String representation of the header values associated with the header name. This is in the form of a comma-separated value. e.g. value1,value2,value3

Parameters:

name - Header name

Returns:

String presentation of header value. Null if header name does not exist or header name is invalid (null or empty string).