Class

play.api.mvc

LegacySessionCookieBaker

Related Doc: package mvc

Permalink

class LegacySessionCookieBaker extends SessionCookieBaker with UrlEncodedCookieDataCodec

A session cookie baker that signs the session cookie in the Play 2.5.x style.

Source
Session.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LegacySessionCookieBaker
  2. UrlEncodedCookieDataCodec
  3. SessionCookieBaker
  4. CookieDataCodec
  5. CookieBaker
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new LegacySessionCookieBaker()

    Permalink
  2. new LegacySessionCookieBaker(config: SessionConfiguration, cookieSigner: CookieSigner)

    Permalink

    config

    session configuration

    cookieSigner

    the cookie signer, typically HMAC-SHA1

    Annotations
    @Inject()

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def COOKIE_NAME: String

    Permalink

    The cookie name.

    The cookie name.

    Definition Classes
    SessionCookieBakerCookieBaker
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. val config: SessionConfiguration

    Permalink

    session configuration

    session configuration

    Definition Classes
    LegacySessionCookieBakerSessionCookieBaker
  8. val cookieSigner: CookieSigner

    Permalink

    the cookie signer, typically HMAC-SHA1

    the cookie signer, typically HMAC-SHA1

    Definition Classes
    LegacySessionCookieBakerUrlEncodedCookieDataCodec
  9. def decode(data: String): Map[String, String]

    Permalink

    Decodes from an encoded String.

    Decodes from an encoded String.

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

    Permalink

    Decodes the data from a Cookie.

    Decodes the data from a Cookie.

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

    Permalink

    Decodes the data from a Cookie.

    Decodes the data from a Cookie.

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

    Permalink

    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
  13. def discard: DiscardingCookie

    Permalink
    Definition Classes
    CookieBaker
  14. def domain: Option[String]

    Permalink

    The cookie domain.

    The cookie domain. Defaults to None.

    Definition Classes
    SessionCookieBakerCookieBaker
  15. lazy val emptyCookie: Session

    Permalink

    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
  16. def encode(data: Map[String, String]): String

    Permalink

    Encodes the data as a String.

    Encodes the data as a String.

    Definition Classes
    UrlEncodedCookieDataCodecCookieDataCodec
  17. def encodeAsCookie(data: Session): Cookie

    Permalink

    Encodes the data as a Cookie.

    Encodes the data as a Cookie.

    Definition Classes
    CookieBaker
  18. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  19. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  20. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  21. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  22. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  23. def httpOnly: Boolean

    Permalink

    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
  24. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  25. val isSigned: Boolean

    Permalink

    true if the Cookie is signed.

    true if the Cookie is signed. Defaults to false.

    Definition Classes
    SessionCookieBakerCookieBaker
  26. def maxAge: Option[Int]

    Permalink

    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
  27. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  28. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  29. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  30. def path: String

    Permalink

    The cookie path.

    The cookie path.

    Definition Classes
    SessionCookieBakerCookieBaker
  31. def sameSite: Option[SameSite]

    Permalink

    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
  32. def secure: Boolean

    Permalink

    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]

    Permalink

    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. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  35. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  36. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from UrlEncodedCookieDataCodec

Inherited from SessionCookieBaker

Inherited from CookieDataCodec

Inherited from CookieBaker[Session]

Inherited from AnyRef

Inherited from Any

Ungrouped