Packages

c

play.api.mvc

DefaultSessionCookieBaker

class DefaultSessionCookieBaker extends SessionCookieBaker with FallbackCookieDataCodec

A session cookie that reads in both signed and JWT cookies, and writes out JWT cookies.

Source
Session.scala
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DefaultSessionCookieBaker
  2. FallbackCookieDataCodec
  3. SessionCookieBaker
  4. CookieDataCodec
  5. CookieBaker
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new DefaultSessionCookieBaker()
  2. new DefaultSessionCookieBaker(config: SessionConfiguration, secretConfiguration: SecretConfiguration, cookieSigner: CookieSigner)
    Annotations
    @Inject()

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. def COOKIE_NAME: String

    The cookie name.

    The cookie name.

    Definition Classes
    SessionCookieBakerCookieBaker
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  7. val config: SessionConfiguration
  8. def decode(encodedData: String): Map[String, String]

    Decodes from an encoded String.

    Decodes from an encoded String.

    Definition Classes
    FallbackCookieDataCodecCookieDataCodec
  9. def decodeCookieToMap(cookie: Option[Cookie]): Map[String, String]

    Decodes the data from a Cookie.

    Decodes the data from a Cookie.

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

    Decodes the data from a Cookie.

    Decodes the data from a Cookie.

    Definition Classes
    CookieBaker
  11. 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
    SessionCookieBakerCookieBaker
  12. def discard: DiscardingCookie
    Definition Classes
    CookieBaker
  13. def domain: Option[String]

    The cookie domain.

    The cookie domain. Defaults to None.

    Definition Classes
    SessionCookieBakerCookieBaker
  14. 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
    SessionCookieBakerCookieBaker
  15. def encode(data: Map[String, String]): String

    Encodes the data as a String.

    Encodes the data as a String.

    Definition Classes
    FallbackCookieDataCodecCookieDataCodec
  16. def encodeAsCookie(data: Session): Cookie

    Encodes the data as a Cookie.

    Encodes the data as a Cookie.

    Definition Classes
    CookieBaker
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  19. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  21. 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
    SessionCookieBakerCookieBaker
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. val isSigned: Boolean

    true if the Cookie is signed.

    true if the Cookie is signed. Defaults to false.

    Definition Classes
    SessionCookieBakerCookieBaker
  24. val jwtCodec: JWTCookieDataCodec
  25. 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
    SessionCookieBakerCookieBaker
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  29. def path: String

    The cookie path.

    The cookie path.

    Definition Classes
    SessionCookieBakerCookieBaker
  30. 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
    SessionCookieBakerCookieBaker
  31. val secretConfiguration: SecretConfiguration
  32. 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
    SessionCookieBakerCookieBaker
  33. 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
    SessionCookieBakerCookieBaker
  34. val signedCodec: UrlEncodedCookieDataCodec
  35. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  36. def toString(): String
    Definition Classes
    AnyRef → Any
  37. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  38. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  39. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from SessionCookieBaker

Inherited from CookieDataCodec

Inherited from CookieBaker[Session]

Inherited from AnyRef

Inherited from Any

Ungrouped