Package org.forgerock.http.header

Class CookieHeader

java.lang.Object
org.forgerock.http.protocol.Header
org.forgerock.http.header.CookieHeader
public class CookieHeader extends Header
Processes the Cookie request message header. For more information, see the original Netscape specification, RFC 2109 and RFC 2965.

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

  • Field Details

  • Constructor Details

    • CookieHeader

      public CookieHeader()
      Constructs a new empty header.

    • CookieHeader

      public CookieHeader(List<Cookie> cookies)
      Constructs a new header with the provided cookies.
      Parameters:
      cookies - The cookies.

  • Method Details

    • valueOf

      public static CookieHeader valueOf(Request message)
      Constructs a new header, initialized from the specified request message.
      Parameters:
      message - The request message to initialize the header from.
      Returns:
      The parsed header.

    • valueOf

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

    • getCookies

      public List<Cookie> getCookies()
      Returns the cookies' request list.
      Returns:
      The cookies' request list.

    • 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.