object Session extends CookieBaker[Session] with FallbackCookieDataCodec with Serializable
- Source
- Session.scala
- Alphabetic
- By Inheritance
- Session
- Serializable
- FallbackCookieDataCodec
- CookieDataCodec
- CookieBaker
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
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[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def decode(encodedData: String): Map[String, String]
Decodes from an encoded
String
.Decodes from an encoded
String
.- Definition Classes
- FallbackCookieDataCodec → 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]): Session
Decodes the data from a
Cookie
.Decodes the data from a
Cookie
.- Definition Classes
- CookieBaker
- def discard: DiscardingCookie
- Definition Classes
- CookieBaker
- lazy val emptyCookie: Session
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
- Session → CookieBaker
- def encode(data: Map[String, String]): String
Encodes the data as a
String
.Encodes the data as a
String
.- Definition Classes
- FallbackCookieDataCodec → CookieDataCodec
- def encodeAsCookie(data: Session): Cookie
Encodes the data as a
Cookie
.Encodes the data as a
Cookie
.- Definition Classes
- CookieBaker
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def fromJavaSession(javaSession: mvc.Http.Session): Session
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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()
- 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()
Deprecated Value Members
- def COOKIE_NAME: String
The cookie name.
The cookie name.
- Definition Classes
- Session → CookieBaker
- Annotations
- @deprecated
- Deprecated
(Since version 2.6.0) Inject play.api.mvc.SessionCookieBaker instead
- def config: SessionConfiguration
- Annotations
- @deprecated
- Deprecated
(Since version 2.6.0) Inject play.api.mvc.SessionCookieBaker instead
- def deserialize(data: Map[String, String]): Session
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
- Session → CookieBaker
- Annotations
- @deprecated
- Deprecated
(Since version 2.6.0) Inject play.api.mvc.SessionCookieBaker instead
- def domain: Option[String]
The cookie domain.
The cookie domain. Defaults to None.
- Definition Classes
- Session → CookieBaker
- Annotations
- @deprecated
- Deprecated
(Since version 2.6.0) Inject play.api.mvc.SessionCookieBaker instead
- 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.- Definition Classes
- Session → CookieBaker
- Annotations
- @deprecated
- Deprecated
(Since version 2.6.0) Inject play.api.mvc.SessionCookieBaker instead
- val isSigned: Boolean
true
if the Cookie is signed.true
if the Cookie is signed. Defaults to false.- Definition Classes
- Session → CookieBaker
- Annotations
- @deprecated
- Deprecated
(Since version 2.6.0) Inject play.api.mvc.SessionCookieBaker instead
- lazy val jwtCodec: DefaultJWTCookieDataCodec
- Definition Classes
- Session → FallbackCookieDataCodec
- Annotations
- @deprecated
- Deprecated
(Since version 2.6.0) Inject play.api.mvc.SessionCookieBaker instead
- def maxAge: Option[Int]
The cookie expiration date in seconds,
None
for a transient cookieThe cookie expiration date in seconds,
None
for a transient cookie- Definition Classes
- Session → CookieBaker
- Annotations
- @deprecated
- Deprecated
(Since version 2.6.0) Inject play.api.mvc.SessionCookieBaker instead
- def path: String
The cookie path.
The cookie path.
- Definition Classes
- Session → CookieBaker
- Annotations
- @deprecated
- Deprecated
(Since version 2.6.0) Inject play.api.mvc.SessionCookieBaker instead
- 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
- Session → CookieBaker
- Annotations
- @deprecated
- Deprecated
(Since version 2.6.0) Inject play.api.mvc.SessionCookieBaker instead
- 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.- Definition Classes
- Session → CookieBaker
- Annotations
- @deprecated
- Deprecated
(Since version 2.6.0) Inject play.api.mvc.SessionCookieBaker instead
- def serialize(session: Session): Map[String, String]
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
- Session → CookieBaker
- Annotations
- @deprecated
- Deprecated
(Since version 2.6.0) Inject play.api.mvc.SessionCookieBaker instead
- lazy val signedCodec: DefaultUrlEncodedCookieDataCodec
- Definition Classes
- Session → FallbackCookieDataCodec
- Annotations
- @deprecated
- Deprecated
(Since version 2.6.0) Inject play.api.mvc.SessionCookieBaker instead