org.forgerock.http.header

Class AcceptApiVersionHeader

java.lang.Object

org.forgerock.http.protocol.Header

org.forgerock.http.header.AcceptApiVersionHeader

public final class AcceptApiVersionHeader
extends Header

Processes the Accept-API-Version message header. Represents the accepted protocol and resource versions.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME The name of this header.
static String	PROTOCOL The name of the protocol value component.
static String	RESOURCE The name of the resource value component.

Constructor Summary

Constructors

Constructor and Description
AcceptApiVersionHeader(Version protocol, Version resource) Constructs a new header, initialized with the specified protocol and resource versions.

Method Summary

Modifier and Type	Method and Description
String	getName() Returns the name of the header, as it would canonically appear within an HTTP message.
Version	getProtocolVersion() Gets the acceptable protocol version.
Version	getResourceVersion() Gets the acceptable resource version.
List<String>	getValues() Returns the header as a list of strings.
static AcceptApiVersionHeader	valueOf(Message message) Constructs a new header, initialized from the specified message.
static AcceptApiVersionHeader	valueOf(String string) Constructs a new header, initialized from the specified string value.
AcceptApiVersionHeader	withDefaultProtocolVersion(Version version) Will set the accepted protocol version, if not provided in the Accept-API-Version header.
AcceptApiVersionHeader	withDefaultResourceVersion(Version version) Will set the accepted resource version, if not provided in the Accept-API-Version header.

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

PROTOCOL

public static final String PROTOCOL

The name of the protocol value component.

See Also:

Constant Field Values

RESOURCE

public static final String RESOURCE

The name of the resource value component.

See Also:

Constant Field Values

Constructor Detail

AcceptApiVersionHeader

public AcceptApiVersionHeader(Version protocol,
                              Version resource)

Constructs a new header, initialized with the specified protocol and resource versions.

Parameters:

protocol - The accepted protocol version.

resource - The accepted resource version.

Method Detail

valueOf

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

Throws:

IllegalArgumentException - If the version header is in an invalid format.

valueOf

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

Throws:

IllegalArgumentException - If the version header is in an invalid format.

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.

getProtocolVersion

public Version getProtocolVersion()

Gets the acceptable protocol version.

Returns:

The acceptable protocol version.

getResourceVersion

public Version getResourceVersion()

Gets the acceptable resource version.

Returns:

The acceptable resource version.

withDefaultProtocolVersion

public AcceptApiVersionHeader withDefaultProtocolVersion(Version version)

Will set the accepted protocol version, if not provided in the Accept-API-Version header.

Parameters:

version - The default protocol version.

Returns:

The accept api version header.

withDefaultResourceVersion

public AcceptApiVersionHeader withDefaultResourceVersion(Version version)

Will set the accepted resource version, if not provided in the Accept-API-Version header.

Parameters:

version - The default resource version.

Returns:

The accept api version header.

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.