Packages

object Cookies extends CookieHeaderEncoding

Helper utilities to encode Cookies.

Annotations
@deprecated
Deprecated

(Since version 2.8.0) Inject play.api.mvc.CookieHeaderEncoding instead

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

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. 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.

    Definition Classes
    CookieHeaderEncoding
  5. val SetCookieHeaderSeparatorRegex: Regex
    Definition Classes
    CookieHeaderEncoding
  6. def apply(cookies: Seq[Cookie]): Cookies
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  9. 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

    Definition Classes
    CookieHeaderEncoding
  10. 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

    Definition Classes
    CookieHeaderEncoding
  11. 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

    Definition Classes
    CookieHeaderEncoding
  12. 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

    Definition Classes
    CookieHeaderEncoding
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  15. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. def fromCookieHeader(header: Option[String]): Cookies
    Definition Classes
    CookieHeaderEncoding
  17. def fromSetCookieHeader(header: Option[String]): Cookies
    Definition Classes
    CookieHeaderEncoding
  18. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. 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

    Definition Classes
    CookieHeaderEncoding
  22. 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

    Definition Classes
    CookieHeaderEncoding
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  27. def toString(): String
    Definition Classes
    AnyRef → Any
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Deprecated Value Members

  1. def config: CookiesConfiguration
    Attributes
    protected
    Definition Classes
    CookiesCookieHeaderEncoding
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Inject play.api.mvc.CookieHeaderEncoding instead

Inherited from CookieHeaderEncoding

Inherited from AnyRef

Inherited from Any

Ungrouped