Packages

t

play.api.mvc

CookieHeaderEncoding

trait CookieHeaderEncoding extends AnyRef

Logic for encoding and decoding Cookie and Set-Cookie headers.

Source
Cookie.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CookieHeaderEncoding
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Concrete Value Members

  1. val SetCookieHeaderSeparator: String

    Play doesn't support multiple values per header, so has to compress cookies into one header.

    Play doesn't support multiple values per header, so has to compress cookies into one header. The problem is, Set-Cookie doesn't support being compressed into one header, the reason being that the separator character for header values, comma, is used in the dates in the Expires attribute of a cookie value. So we synthesise our own separator, that we use here, and before we send the cookie back to the client.

  2. val SetCookieHeaderSeparatorRegex: Regex
  3. def decodeCookieHeader(cookieHeader: String): Seq[Cookie]

    Decodes a Cookie header value as a proper cookie set.

    Decodes a Cookie header value as a proper cookie set.

    cookieHeader

    the Cookie header value

    returns

    decoded cookies

  4. def decodeSetCookieHeader(cookieHeader: String): Seq[Cookie]

    Decodes a Set-Cookie header value as a proper cookie set.

    Decodes a Set-Cookie header value as a proper cookie set.

    cookieHeader

    the Set-Cookie header value

    returns

    decoded cookies

  5. def encodeCookieHeader(cookies: Seq[Cookie]): String

    Encodes cookies as a Set-Cookie HTTP header.

    Encodes cookies as a Set-Cookie HTTP header.

    cookies

    the Cookies to encode

    returns

    a valid Set-Cookie header value

  6. def encodeSetCookieHeader(cookies: Seq[Cookie]): String

    Encodes cookies as a Set-Cookie HTTP header.

    Encodes cookies as a Set-Cookie HTTP header.

    cookies

    the Cookies to encode

    returns

    a valid Set-Cookie header value

  7. def fromCookieHeader(header: Option[String]): Cookies
  8. def fromSetCookieHeader(header: Option[String]): Cookies
  9. def mergeCookieHeader(cookieHeader: String, cookies: Seq[Cookie]): String

    Merges an existing Cookie header with new cookie values

    Merges an existing Cookie header with new cookie values

    cookieHeader

    the existing Cookie header value

    cookies

    the new cookies to encode

    returns

    a valid Cookie header value

  10. def mergeSetCookieHeader(cookieHeader: String, cookies: Seq[Cookie]): String

    Merges an existing Set-Cookie header with new cookie values

    Merges an existing Set-Cookie header with new cookie values

    cookieHeader

    the existing Set-Cookie header value

    cookies

    the new cookies to encode

    returns

    a valid Set-Cookie header value