Packages

t

play.api.mvc

SessionCookieBaker

trait SessionCookieBaker extends CookieBaker[Session] with CookieDataCodec

Helper utilities to manage the Session cookie.

Source
Session.scala
Linear Supertypes
CookieDataCodec, CookieBaker[Session], AnyRef, Any
Known Subclasses
DefaultSessionCookieBaker, LegacySessionCookieBaker
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SessionCookieBaker
  2. CookieDataCodec
  3. CookieBaker
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def config: SessionConfiguration
  2. abstract def decode(data: String): Map[String, String]

    Decodes from an encoded String.

    Decodes from an encoded String.

    Definition Classes
    CookieDataCodec
  3. abstract def encode(data: Map[String, String]): String

    Encodes the data as a String.

    Encodes the data as a String.

    Definition Classes
    CookieDataCodec

Concrete Value Members

  1. def COOKIE_NAME: String

    The cookie name.

    The cookie name.

    Definition Classes
    SessionCookieBaker → CookieBaker
  2. def decodeCookieToMap(cookie: Option[Cookie]): Map[String, String]

    Decodes the data from a Cookie.

    Decodes the data from a Cookie.

    Definition Classes
    CookieBaker
  3. def decodeFromCookie(cookie: Option[Cookie]): Session

    Decodes the data from a Cookie.

    Decodes the data from a Cookie.

    Definition Classes
    CookieBaker
  4. def deserialize(data: Map[String, String]): Session

    Builds the cookie object from the given data map.

    Builds the cookie object from the given data map.

    data

    the data map to build the cookie object

    returns

    a new cookie object

    Definition Classes
    SessionCookieBaker → CookieBaker
  5. def discard: DiscardingCookie
    Definition Classes
    CookieBaker
  6. def domain: Option[String]

    The cookie domain.

    The cookie domain. Defaults to None.

    Definition Classes
    SessionCookieBaker → CookieBaker
  7. lazy val emptyCookie: Session

    Default cookie, returned in case of error or if missing in the HTTP headers.

    Default cookie, returned in case of error or if missing in the HTTP headers.

    Definition Classes
    SessionCookieBaker → CookieBaker
  8. def encodeAsCookie(data: Session): Cookie

    Encodes the data as a Cookie.

    Encodes the data as a Cookie.

    Definition Classes
    CookieBaker
  9. def httpOnly: Boolean

    true if the Cookie should have the httpOnly flag, disabling access from Javascript.

    true if the Cookie should have the httpOnly flag, disabling access from Javascript. Defaults to true.

    Definition Classes
    SessionCookieBaker → CookieBaker
  10. val isSigned: Boolean

    true if the Cookie is signed.

    true if the Cookie is signed. Defaults to false.

    Definition Classes
    SessionCookieBaker → CookieBaker
  11. def maxAge: Option[Int]

    The cookie expiration date in seconds, None for a transient cookie

    The cookie expiration date in seconds, None for a transient cookie

    Definition Classes
    SessionCookieBaker → CookieBaker
  12. def path: String

    The cookie path.

    The cookie path.

    Definition Classes
    SessionCookieBaker → CookieBaker
  13. def sameSite: Option[SameSite]

    The value of the SameSite attribute of the cookie.

    The value of the SameSite attribute of the cookie. Defaults to no SameSite.

    Definition Classes
    SessionCookieBaker → CookieBaker
  14. def secure: Boolean

    true if the Cookie should have the secure flag, restricting usage to https.

    true if the Cookie should have the secure flag, restricting usage to https. Defaults to false.

    Definition Classes
    SessionCookieBaker → CookieBaker
  15. def serialize(session: Session): Map[String, String]

    Converts the given cookie object into a data map.

    Converts the given cookie object into a data map.

    returns

    a new Map storing the key-value pairs for the given cookie

    Definition Classes
    SessionCookieBaker → CookieBaker