Packages

t

play.api.mvc

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, Flash, FlashCookieBaker, LegacyFlashCookieBaker, LegacySessionCookieBaker, Session, SessionCookieBaker
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CookieBaker
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def COOKIE_NAME: String

    The cookie name.

  2. 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
  3. abstract def emptyCookie: T

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

  4. abstract def path: String

    The cookie path.

  5. 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

  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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. def decodeCookieToMap(cookie: Option[Cookie]): Map[String, String]

    Decodes the data from a Cookie.

  7. def decodeFromCookie(cookie: Option[Cookie]): T

    Decodes the data from a Cookie.

  8. def discard: DiscardingCookie
  9. def domain: Option[String]

    The cookie domain.

    The cookie domain. Defaults to None.

  10. def encodeAsCookie(data: T): Cookie

    Encodes the data as a Cookie.

  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  13. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. 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.

  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. def isSigned: Boolean

    true if the Cookie is signed.

    true if the Cookie is signed. Defaults to false.

  19. def maxAge: Option[Int]

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

  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. 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.

  24. 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.

  25. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  26. def toString(): String
    Definition Classes
    AnyRef → Any
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped