Package org.forgerock.http.header

Class SetCookieHeader

java.lang.Object

org.forgerock.http.protocol.Header

org.forgerock.http.header.AbstractSetCookieHeader

org.forgerock.http.header.SetCookieHeader

public class SetCookieHeader
extends AbstractSetCookieHeader

Processes the Set-Cookie request message header. For more information, see the Http State Management Mechanism specification RFC 6265.

Note: This implementation is designed to be forgiving when parsing malformed cookies.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
SetCookieHeader(List<Cookie> cookies)	Constructs a new header with the provided cookies.

Method Summary

Modifier and Type	Method	Description
List<Cookie>	getCookies()	Returns the cookies.
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 SetCookieHeader	valueOf(String value)	Constructs a new header, initialized from the specified string value.
static SetCookieHeader	valueOf(List<String> values)	Constructs a new header, initialized from the specified list of Set-Cookie values.
static SetCookieHeader	valueOf(Response response)	Constructs a new header, initialized from the specified response 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 Details

NAME

public static final String NAME

The name of this header.

See Also:

• Constant Field Values

Constructor Details

SetCookieHeader

public SetCookieHeader(List<Cookie> cookies)

Constructs a new header with the provided cookies.

Parameters:

cookies - The cookies.

Method Details

valueOf

public static SetCookieHeader valueOf(String value)

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

Parameters:

value - The value to initialize the header from.

Returns:

The parsed header.

valueOf

public static SetCookieHeader valueOf(Response response)

Constructs a new header, initialized from the specified response message.

Parameters:

response - The response message to initialize the header from.

Returns:

The parsed header.

valueOf

public static SetCookieHeader valueOf(List<String> values)

Constructs a new header, initialized from the specified list of Set-Cookie values.

Parameters:

values - The values to initialize the header from.

Returns:

The parsed header.

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.

getCookies

public List<Cookie> getCookies()

Returns the cookies.

Specified by:

getCookies in class AbstractSetCookieHeader

Returns:

The cookies.