com.mohiva.play.silhouette.impl.authenticators

CookieAuthenticatorService

class CookieAuthenticatorService extends AuthenticatorService[CookieAuthenticator] with Logger

The service that handles the cookie authenticator.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. CookieAuthenticatorService
  2. Logger
  3. AuthenticatorService
  4. ExecutionContextProvider
  5. AnyRef
  6. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CookieAuthenticatorService(settings: CookieAuthenticatorSettings, dao: Option[AuthenticatorDAO[CookieAuthenticator]], fingerprintGenerator: FingerprintGenerator, idGenerator: IDGenerator, clock: Clock)(implicit executionContext: ExecutionContext)

    settings

    The cookie settings.

    dao

    The DAO to store the authenticator. Set it to None to use a stateless approach.

    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

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. 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
    CookieAuthenticatorServiceAuthenticatorService
  9. 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
    CookieAuthenticatorServiceAuthenticatorService
  10. 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
    CookieAuthenticatorServiceAuthenticatorService
  11. 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
    CookieAuthenticatorServiceAuthenticatorService
  12. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  14. implicit val executionContext: ExecutionContext

    The execution context to handle the asynchronous operations.

    The execution context to handle the asynchronous operations.

    Definition Classes
    CookieAuthenticatorServiceExecutionContextProvider
  15. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any
  18. 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
    CookieAuthenticatorServiceAuthenticatorService
  19. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  20. val logger: Logger

    A named logger instance.

    A named logger instance.

    Definition Classes
    Logger
  21. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  22. final def notify(): Unit

    Definition Classes
    AnyRef
  23. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  24. 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
    CookieAuthenticatorServiceAuthenticatorService
  25. 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
    CookieAuthenticatorServiceAuthenticatorService
  26. def retrieve(implicit request: RequestHeader): Future[Option[CookieAuthenticator]]

    Retrieves the authenticator from request.

    Retrieves the authenticator from request.

    request

    The request header.

    returns

    Some authenticator or None if no authenticator could be found in request.

    Definition Classes
    CookieAuthenticatorServiceAuthenticatorService
  27. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  28. def toString(): String

    Definition Classes
    AnyRef → Any
  29. 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
    CookieAuthenticatorServiceAuthenticatorService
  30. 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
    CookieAuthenticatorServiceAuthenticatorService
  31. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Logger

Inherited from ExecutionContextProvider

Inherited from AnyRef

Inherited from Any

Ungrouped