Trait

play.api.mvc

CookieBaker

Related Doc: package mvc

Permalink

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

    Permalink

    The cookie name.

  2. abstract def deserialize(data: Map[String, String]): T

    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

    Attributes
    protected
  3. abstract def emptyCookie: T

    Permalink

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

  4. abstract def path: String

    Permalink

    The cookie path.

  5. abstract def serialize(cookie: T): Map[String, String]

    Permalink

    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

    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. final def asInstanceOf[T0]: T0

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. def decodeCookieToMap(cookie: Option[Cookie]): Map[String, String]

    Permalink

    Decodes the data from a Cookie.

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

    Permalink

    Decodes the data from a Cookie.

  8. def discard: DiscardingCookie

    Permalink
  9. def domain: Option[String]

    Permalink

    The cookie domain.

    The cookie domain. Defaults to None.

  10. def encodeAsCookie(data: T): Cookie

    Permalink

    Encodes the data as a Cookie.

  11. final def eq(arg0: AnyRef): Boolean

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  16. 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.

  17. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  18. def isSigned: Boolean

    Permalink

    true if the Cookie is signed.

    true if the Cookie is signed. Defaults to false.

  19. def maxAge: Option[Int]

    Permalink

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

  20. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  23. 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.

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

  25. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped