Package org.forgerock.http.header

Class GenericHeader

java.lang.Object

org.forgerock.http.protocol.Header

org.forgerock.http.header.GenericHeader

public class GenericHeader
extends Header

An undecoded HTTP message header. Values are always immutable.

Constructor Summary

Constructors

Constructor	Description
GenericHeader(String name, String value)	Constructs a new header with the provided name and value.
GenericHeader(String name, List<String> values)	Constructs a new header with the provided name and values.

Method Summary

Modifier and Type	Method	Description
String	getName()	Returns the name of the header, as it would canonically appear within an HTTP message.
List<String>	getValues()	Returns the header as a list of strings.

Methods inherited from class org.forgerock.http.protocol.Header

equals, getFirstValue, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GenericHeader

public GenericHeader(String name,
                     String value)

Constructs a new header with the provided name and value.

Parameters:

name - The header name.

value - The header value.

GenericHeader

public GenericHeader(String name,
                     List<String> values)

Constructs a new header with the provided name and values.

Parameters:

name - The header name.

values - The header values.

Method Detail

getName

public String getName()

Description copied from class: Header

Returns the name of the header, as it would canonically appear within an HTTP message.

Specified by:

getName in class Header

Returns:

The name of the header, as it would canonically appear within an HTTP message.

getValues

public List<String> getValues()

Returns the header as a list of strings. If the header has no values then it must return an empty list, never null. Each String should represent the value component of the key-value pair that makes up the HTTP header - as such, for some Header implementations each String in this List may contain multiple token-separated values.

The List returned from this method should not be expected to be mutable. However, some subclasses of Header may choose to implement it as such.

Specified by:

getValues in class Header

Returns:

An immutable list of values for this header name.