Packages

c

play.silhouette.impl.authenticators

CookieAuthenticatorSettings

case class CookieAuthenticatorSettings(cookieName: String = "id", cookiePath: String = "/", cookieDomain: Option[String] = None, secureCookie: Boolean = true, httpOnlyCookie: Boolean = true, sameSite: Option[SameSite] = Some(Cookie.SameSite.Lax), useFingerprinting: Boolean = true, cookieMaxAge: Option[FiniteDuration] = None, authenticatorIdleTimeout: Option[FiniteDuration] = None, authenticatorExpiry: FiniteDuration = 12.hours) extends Product with Serializable

The settings for the cookie authenticator.

cookieName

The cookie name.

cookiePath

The cookie path.

cookieDomain

The cookie domain.

secureCookie

Whether this cookie is secured, sent only for HTTPS requests.

httpOnlyCookie

Whether this cookie is HTTP only, i.e. not accessible from client-side JavaScript code.

sameSite

The SameSite attribute for this cookie (for CSRF protection).

useFingerprinting

Indicates if a fingerprint of the user should be stored in the authenticator.

cookieMaxAge

The duration a cookie expires. None for a transient cookie.

authenticatorIdleTimeout

The duration an authenticator can be idle before it timed out.

authenticatorExpiry

The duration an authenticator expires after it was created.

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CookieAuthenticatorSettings
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new CookieAuthenticatorSettings(cookieName: String = "id", cookiePath: String = "/", cookieDomain: Option[String] = None, secureCookie: Boolean = true, httpOnlyCookie: Boolean = true, sameSite: Option[SameSite] = Some(Cookie.SameSite.Lax), useFingerprinting: Boolean = true, cookieMaxAge: Option[FiniteDuration] = None, authenticatorIdleTimeout: Option[FiniteDuration] = None, authenticatorExpiry: FiniteDuration = 12.hours)

    cookieName

    The cookie name.

    cookiePath

    The cookie path.

    cookieDomain

    The cookie domain.

    secureCookie

    Whether this cookie is secured, sent only for HTTPS requests.

    httpOnlyCookie

    Whether this cookie is HTTP only, i.e. not accessible from client-side JavaScript code.

    sameSite

    The SameSite attribute for this cookie (for CSRF protection).

    useFingerprinting

    Indicates if a fingerprint of the user should be stored in the authenticator.

    cookieMaxAge

    The duration a cookie expires. None for a transient cookie.

    authenticatorIdleTimeout

    The duration an authenticator can be idle before it timed out.

    authenticatorExpiry

    The duration an authenticator expires after it was created.

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. val authenticatorExpiry: FiniteDuration
  6. val authenticatorIdleTimeout: Option[FiniteDuration]
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  8. val cookieDomain: Option[String]
  9. val cookieMaxAge: Option[FiniteDuration]
  10. val cookieName: String
  11. val cookiePath: String
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  14. val httpOnlyCookie: Boolean
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  19. def productElementNames: Iterator[String]
    Definition Classes
    Product
  20. val sameSite: Option[SameSite]
  21. val secureCookie: Boolean
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. val useFingerprinting: Boolean
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped