Package org.forgerock.http.header

Class ReferrerHeader

java.lang.Object

org.forgerock.http.protocol.Header

org.forgerock.http.header.ReferrerHeader

public class ReferrerHeader
extends Header

A Header representation of the Referrer HTTP header.

See Also:

RFC7231

Field Summary

Fields

Modifier and Type	Field	Description
static String	NAME	The name of the header in the HTTP message.

Constructor Summary

Constructors

Constructor	Description
ReferrerHeader()

Method Summary

Modifier and Type	Method	Description
String	getName()	Returns the name of the header, as it would canonically appear within an HTTP message.
MutableUri	getUri()	Get the URI value of the Referrer header.
List<String>	getValues()	Returns the header as a list of strings.
ReferrerHeader	setUri(MutableUri uri)	Set the URI value of the Referrer header.
static ReferrerHeader	valueOf(String value)	Parse the provided value as a Referrer header.
static ReferrerHeader	valueOf(Message<?> message)	Constructs a new header, initialized from the specified message.

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 the header in the HTTP message.

See Also:

Constant Field Values

Constructor Detail

ReferrerHeader

public ReferrerHeader()

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

Description copied from class: Header

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:

The header as a non-null list of string values. Can be an empty list.

getUri

public MutableUri getUri()

Get the URI value of the Referrer header.

Returns:

The URI.

setUri

public ReferrerHeader setUri(MutableUri uri)

Set the URI value of the Referrer header.

Parameters:

uri - The URI.

Returns:

This header, for fluent API use.

valueOf

public static ReferrerHeader valueOf(Message<?> message)
                              throws MalformedHeaderException

Constructs a new header, initialized from the specified message.

Parameters:

message - The message to initialize the header from.

Returns:

The parsed header.

Throws:

MalformedHeaderException - If the Referrer URI has invalid syntax.

valueOf

public static ReferrerHeader valueOf(String value)
                              throws MalformedHeaderException

Parse the provided value as a Referrer header.

Parameters:

value - The Referrer URI.

Returns:

The ReferrerHeader instance.

Throws:

MalformedHeaderException - If the URI has invalid syntax.