org.forgerock.http.header

Class ContentLengthHeader

java.lang.Object

org.forgerock.http.protocol.Header

org.forgerock.http.header.ContentLengthHeader

public class ContentLengthHeader
extends Header

Processes the Content-Length message header. For more information, see RFC 2616 §14.13.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME The name of this header.

Constructor Summary

Constructors

Constructor and Description
ContentLengthHeader() Constructs a new empty header whose length is set to -1.
ContentLengthHeader(long length) Constructs a new header with the provided content length.

Method Summary

Modifier and Type	Method and Description
long	getLength() Returns the content length, or -1 if no content length has been set.
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.
static ContentLengthHeader	valueOf(Message message) Constructs a new header, initialized from the specified message.
static ContentLengthHeader	valueOf(String string) Constructs a new header, initialized from the specified string value.

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

Field Detail

NAME

public static final String NAME

The name of this header.

See Also:

Constant Field Values

Constructor Detail

ContentLengthHeader

public ContentLengthHeader()

Constructs a new empty header whose length is set to -1.

ContentLengthHeader

public ContentLengthHeader(long length)

Constructs a new header with the provided content length.

Parameters:

length - The content length, or -1 if no content length has been set.

Method Detail

valueOf

public static ContentLengthHeader valueOf(Message message)

Constructs a new header, initialized from the specified message.

Parameters:

message - The message to initialize the header from.

Returns:

The parsed header.

valueOf

public static ContentLengthHeader valueOf(String string)

Constructs a new header, initialized from the specified string value.

Parameters:

string - The value to initialize the header from.

Returns:

The parsed header.

getLength

public long getLength()

Returns the content length, or -1 if no content length has been set.

Returns:

The content length, or -1 if no content length has been set.

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()

Description copied from class: Header

Returns the header as a list of strings. 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:

The header as a list of string values.