class LegacyFlashCookieBaker extends FlashCookieBaker with UrlEncodedCookieDataCodec
- Source
- Flash.scala
- Alphabetic
- By Inheritance
- LegacyFlashCookieBaker
- UrlEncodedCookieDataCodec
- FlashCookieBaker
- CookieDataCodec
- CookieBaker
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new LegacyFlashCookieBaker()
- new LegacyFlashCookieBaker(config: FlashConfiguration, secretConfiguration: SecretConfiguration, cookieSigner: CookieSigner)
- Annotations
- @Inject()
Value Members
- def COOKIE_NAME: String
The cookie name.
The cookie name.
- Definition Classes
- → CookieBaker
- val config: FlashConfiguration
- Definition Classes
- → FlashCookieBaker
- val cookieSigner: CookieSigner
The cookie signer.
The cookie signer.
- Definition Classes
- → UrlEncodedCookieDataCodec
- def decode(data: String): Map[String, String]
Decodes from an encoded
String.Decodes from an encoded
String.- Definition Classes
- → CookieDataCodec
- def decodeCookieToMap(cookie: Option[Cookie]): Map[String, String]
Decodes the data from a
Cookie.Decodes the data from a
Cookie.- Definition Classes
- CookieBaker
- def decodeFromCookie(cookie: Option[Cookie]): Flash
Decodes the data from a
Cookie.Decodes the data from a
Cookie.- Definition Classes
- CookieBaker
- def deserialize(data: Map[String, String]): Flash
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
- → CookieBaker
- def discard: DiscardingCookie
- Definition Classes
- CookieBaker
- def domain: Option[String]
The cookie domain.
The cookie domain. Defaults to None.
- Definition Classes
- → CookieBaker
- lazy val emptyCookie: Flash
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
- → CookieBaker
- def encode(data: Map[String, String]): String
Encodes the data as a
String.Encodes the data as a
String.- Definition Classes
- → CookieDataCodec
- def encodeAsCookie(data: Flash): Cookie
Encodes the data as a
Cookie.Encodes the data as a
Cookie.- Definition Classes
- CookieBaker
- def httpOnly: Boolean
trueif the Cookie should have the httpOnly flag, disabling access from Javascript.trueif the Cookie should have the httpOnly flag, disabling access from Javascript. Defaults to true.- Definition Classes
- → CookieBaker
- def isSigned: Boolean
trueif the Cookie is signed.trueif the Cookie is signed. Defaults to false.- Definition Classes
- CookieBaker
- def maxAge: Option[Int]
The cookie expiration date in seconds,
Nonefor a transient cookieThe cookie expiration date in seconds,
Nonefor a transient cookie- Definition Classes
- CookieBaker
- def path: String
The cookie path.
The cookie path.
- Definition Classes
- → CookieBaker
- 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
- → CookieBaker
- val secretConfiguration: SecretConfiguration
- def secure: Boolean
trueif the Cookie should have the secure flag, restricting usage to https.trueif the Cookie should have the secure flag, restricting usage to https. Defaults to false.- Definition Classes
- → CookieBaker
- def serialize(flash: Flash): Map[String, String]
Converts the given cookie object into a data map.
Converts the given cookie object into a data map.
- returns
a new
Mapstoring the key-value pairs for the given cookie
- Definition Classes
- → CookieBaker