play.silhouette.impl.authenticators
CookieAuthenticatorService
Companion object CookieAuthenticatorService
class CookieAuthenticatorService extends AuthenticatorService[CookieAuthenticator] with api.Logger
The service that handles the cookie authenticator.
- Annotations
- @SuppressWarnings()
- Alphabetic
- By Inheritance
- CookieAuthenticatorService
- Logger
- AuthenticatorService
- ExecutionContextProvider
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new CookieAuthenticatorService(settings: CookieAuthenticatorSettings, repository: Option[AuthenticatorRepository[CookieAuthenticator]], signer: Signer, cookieHeaderEncoding: CookieHeaderEncoding, authenticatorEncoder: AuthenticatorEncoder, fingerprintGenerator: FingerprintGenerator, idGenerator: IDGenerator, clock: Clock)(implicit executionContext: ExecutionContext)
- settings
The cookie settings.
- repository
The repository to persist the authenticator. Set it to None to use a stateless approach.
- signer
The signer implementation.
- cookieHeaderEncoding
Logic for encoding and decoding
CookieandSet-Cookieheaders.- authenticatorEncoder
The authenticator encoder.
- fingerprintGenerator
The fingerprint generator implementation.
- idGenerator
The ID generator used to create the authenticator ID.
- clock
The clock implementation.
- executionContext
The execution context to handle the asynchronous operations.
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]) @HotSpotIntrinsicCandidate() @native()
- def create(loginInfo: LoginInfo)(implicit request: RequestHeader): Future[CookieAuthenticator]
Creates a new authenticator for the specified login info.
Creates a new authenticator for the specified login info.
- loginInfo
The login info for which the authenticator should be created.
- request
The request header.
- returns
An authenticator.
- Definition Classes
- CookieAuthenticatorService → AuthenticatorService
- def discard(authenticator: CookieAuthenticator, result: Result)(implicit request: RequestHeader): Future[AuthenticatorResult]
Discards the cookie.
Discards the cookie.
If the stateful approach will be used then the authenticator will also be removed from backing store.
- authenticator
The authenticator instance.
- result
The result to manipulate.
- request
The request header.
- returns
The manipulated result.
- Definition Classes
- CookieAuthenticatorService → AuthenticatorService
- def embed(cookie: Cookie, request: RequestHeader): RequestHeader
Embeds the cookie into the request.
Embeds the cookie into the request.
- cookie
The cookie to embed.
- request
The request header.
- returns
The manipulated request header.
- Definition Classes
- CookieAuthenticatorService → AuthenticatorService
- def embed(cookie: Cookie, result: Result)(implicit request: RequestHeader): Future[AuthenticatorResult]
Embeds the cookie into the result.
Embeds the cookie into the result.
- cookie
The cookie to embed.
- result
The result to manipulate.
- request
The request header.
- returns
The manipulated result.
- Definition Classes
- CookieAuthenticatorService → AuthenticatorService
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- implicit val executionContext: ExecutionContext
The execution context to handle the asynchronous operations.
The execution context to handle the asynchronous operations.
- Definition Classes
- CookieAuthenticatorService → ExecutionContextProvider
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def init(authenticator: CookieAuthenticator)(implicit request: RequestHeader): Future[Cookie]
Creates a new cookie for the given authenticator and return it.
Creates a new cookie for the given authenticator and return it.
If the stateful approach will be used the the authenticator will also be stored in the backing store.
- authenticator
The authenticator instance.
- request
The request header.
- returns
The serialized authenticator value.
- Definition Classes
- CookieAuthenticatorService → AuthenticatorService
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val logger: api.Logger
A named logger instance.
A named logger instance.
- Definition Classes
- Logger
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def renew(authenticator: CookieAuthenticator, result: Result)(implicit request: RequestHeader): Future[AuthenticatorResult]
Renews an authenticator and replaces the authenticator cookie with a new one.
Renews an authenticator and replaces the authenticator cookie with a new one.
If the stateful approach will be used then the old authenticator will be revoked in the backing store. After that it isn't possible to use a cookie which was bound to this authenticator.
- authenticator
The authenticator to update.
- result
The result to manipulate.
- request
The request header.
- returns
The original or a manipulated result.
- Definition Classes
- CookieAuthenticatorService → AuthenticatorService
- def renew(authenticator: CookieAuthenticator)(implicit request: RequestHeader): Future[Cookie]
Renews an authenticator.
Renews an authenticator.
After that it isn't possible to use a cookie which was bound to this authenticator. This method doesn't embed the the authenticator into the result. This must be done manually if needed or use the other renew method otherwise.
- authenticator
The authenticator to renew.
- request
The request header.
- returns
The serialized expression of the authenticator.
- Definition Classes
- CookieAuthenticatorService → AuthenticatorService
- def retrieve[B](implicit request: ExtractableRequest[B]): Future[Option[CookieAuthenticator]]
Retrieves the authenticator from request.
Retrieves the authenticator from request.
- B
The type of the request body.
- request
The request to retrieve the authenticator from.
- returns
Some authenticator or None if no authenticator could be found in request.
- Definition Classes
- CookieAuthenticatorService → AuthenticatorService
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- def touch(authenticator: CookieAuthenticator): Either[CookieAuthenticator, CookieAuthenticator]
Touches an authenticator.
Touches an authenticator.
An authenticator can use sliding window expiration. This means that the authenticator times out after a certain time if it wasn't used. So to mark an authenticator as used it will be touched on every request to a Silhouette action. If an authenticator should not be touched because of the fact that sliding window expiration is disabled, then it should be returned on the right, otherwise it should be returned on the left. An untouched authenticator needn't be updated later by the update method.
- authenticator
The authenticator to touch.
- returns
The touched authenticator on the left or the untouched authenticator on the right.
- Definition Classes
- CookieAuthenticatorService → AuthenticatorService
- def update(authenticator: CookieAuthenticator, result: Result)(implicit request: RequestHeader): Future[AuthenticatorResult]
Updates the authenticator with the new last used date.
Updates the authenticator with the new last used date.
If the stateless approach will be used then we update the cookie on the client. With the stateful approach we needn't embed the cookie in the response here because the cookie itself will not be changed. Only the authenticator in the backing store will be changed.
- authenticator
The authenticator to update.
- result
The result to manipulate.
- request
The request header.
- returns
The original or a manipulated result.
- Definition Classes
- CookieAuthenticatorService → AuthenticatorService
- 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()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)