org.forgerock.http.header

Class ContentTypeHeader

java.lang.Object

org.forgerock.http.protocol.Header

org.forgerock.http.header.ContentTypeHeader

public class ContentTypeHeader
extends Header

Processes the Content-Type message header. For more information, see RFC 2616 §14.17.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
ContentTypeHeader() Constructs a new empty header whose type, charset, and boundary are all null.
ContentTypeHeader(String type, String charset, String boundary) Constructs a new header based on message type, charset and boundary.
ContentTypeHeader(String type, String charset, String boundary, Map<String,String> additionalParameters) Constructs a new header based on message type, charset, boundary and any additional message parameters.

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getAdditionalParameters() Returns any additional parameters in the message or an empty map if none specified.
String	getBoundary() Returns the encapsulation boundary or null if none specified.
Charset	getCharset() Returns the character set encoding used to encode the message, or null if no character set was specified.
String	getName() Returns the name of the header, as it would canonically appear within an HTTP message.
String	getType() Returns the media type of the underlying data or null if none specified.
List<String>	getValues() Returns the header as a list of strings.
static ContentTypeHeader	valueOf(Message message) Constructs a new header, initialized from the specified message.
static ContentTypeHeader	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

ContentTypeHeader

public ContentTypeHeader()

Constructs a new empty header whose type, charset, and boundary are all null.

ContentTypeHeader

public ContentTypeHeader(String type,
                         String charset,
                         String boundary)

Constructs a new header based on message type, charset and boundary.

Parameters:

type - The type/sub-type of the message.

charset - The character set used in encoding the message.

boundary - The boundary value provided in multipart messages.

ContentTypeHeader

public ContentTypeHeader(String type,
                         String charset,
                         String boundary,
                         Map<String,String> additionalParameters)

Constructs a new header based on message type, charset, boundary and any additional message parameters.

Parameters:

type - The type/sub-type of the message.

charset - The character set used in encoding the message.

boundary - The boundary value provided in multipart messages.

additionalParameters - Any additional parameters provided in the message or an empty map if there are none.

Method Detail

valueOf

public static ContentTypeHeader 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 ContentTypeHeader 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.

getType

public String getType()

Returns the media type of the underlying data or null if none specified.

Returns:

The media type of the underlying data or null if none specified.

getCharset

public Charset getCharset()

Returns the character set encoding used to encode the message, or null if no character set was specified.

Returns:

The character set encoding used to encode the message or null if empty.

Throws:

IllegalCharsetNameException - if the given charset name is illegal.

UnsupportedCharsetException - if no support for the named charset is available.

getBoundary

public String getBoundary()

Returns the encapsulation boundary or null if none specified.

Returns:

The encapsulation boundary or null if none specified.

getAdditionalParameters

public Map<String,String> getAdditionalParameters()

Returns any additional parameters in the message or an empty map if none specified.

Returns:

Any additional parameters in the message or an empty map if none specified.

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.