CookieBaker

trait CookieBaker[T <: AnyRef] extends AnyRef

Trait that should be extended by the Cookie helpers.

Self Type: CookieBaker[T] with CookieDataCodec
Source: Cookie.scala

Linear Supertypes

AnyRef, Any

Known Subclasses

DefaultFlashCookieBaker, DefaultSessionCookieBaker, FlashCookieBaker, LegacyFlashCookieBaker, LegacySessionCookieBaker, SessionCookieBaker

Ordering

Alphabetic
By Inheritance

Inherited

CookieBaker
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Abstract Value Members

abstract def COOKIE_NAME: String
The cookie name.
abstract def deserialize(data: Map[String, String]): T
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
Attributes
protected
abstract def emptyCookie: T
Default cookie, returned in case of error or if missing in the HTTP headers.
abstract def serialize(cookie: T): Map[String, String]
Converts the given cookie object into a data map.
Converts the given cookie object into a data map.
cookie
the cookie object to serialize into a map
returns
a new Map storing the key-value pairs for the given cookie
Attributes
protected

Concrete Value Members

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##(): Int
Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0
Definition Classes
Any
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
def decodeCookieToMap(cookie: Option[Cookie]): Map[String, String]
Decodes the data from a Cookie.
def decodeFromCookie(cookie: Option[Cookie]): T
Decodes the data from a Cookie.
def discard: DiscardingCookie
def domain: Option[String]
The cookie domain.
The cookie domain. Defaults to None.
def encodeAsCookie(data: T): Cookie
Encodes the data as a Cookie.
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable])
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native()
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.
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
def isSigned: Boolean
true if the Cookie is signed.
true if the Cookie is signed. Defaults to false.
def maxAge: Option[Int]
The cookie expiration date in seconds, None for a transient cookie
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@native()
def path: String
The cookie path.
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.
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.
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
AnyRef → Any
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()

Ungrouped

abstract def COOKIE_NAME: String
The cookie name.
abstract def deserialize(data: Map[String, String]): T
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
Attributes
protected
abstract def emptyCookie: T
Default cookie, returned in case of error or if missing in the HTTP headers.
abstract def serialize(cookie: T): Map[String, String]
Converts the given cookie object into a data map.
Converts the given cookie object into a data map.
cookie
the cookie object to serialize into a map
returns
a new Map storing the key-value pairs for the given cookie
Attributes
protected
final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##(): Int
Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0
Definition Classes
Any
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
def decodeCookieToMap(cookie: Option[Cookie]): Map[String, String]
Decodes the data from a Cookie.
def decodeFromCookie(cookie: Option[Cookie]): T
Decodes the data from a Cookie.
def discard: DiscardingCookie
def domain: Option[String]
The cookie domain.
The cookie domain. Defaults to None.
def encodeAsCookie(data: T): Cookie
Encodes the data as a Cookie.
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable])
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native()
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.
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
def isSigned: Boolean
true if the Cookie is signed.
true if the Cookie is signed. Defaults to false.
def maxAge: Option[Int]
The cookie expiration date in seconds, None for a transient cookie
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@native()
def path: String
The cookie path.
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.
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.
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
AnyRef → Any
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()

Packages

Play

Read configuration

Use the logger

Define a Plugin

Create adhoc applications (for testing)

CookieBaker

trait CookieBaker[T <: AnyRef] extends AnyRef

Abstract Value Members

Concrete Value Members

Inherited from AnyRef

Value Members

Inherited from Any

Value Members

Ungrouped

Packages

Play

Read configuration

Use the logger

Define a Plugin

Create adhoc applications (for testing)

CookieBaker

trait CookieBaker[T <: AnyRef] extends AnyRef

Abstract Value Members

Concrete Value Members

Inherited from AnyRef

Value Members

Inherited from Any

Value Members

Ungrouped

CookieBaker