securesocial.core.authenticator

Authenticator

trait Authenticator[U] extends AnyRef

An Authenticator. Instances of this trait are used to track authenticated users

U

the user object type

Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Authenticator
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract val creationDate: DateTime

    The creation time

  2. abstract def discarding(javaContext: Context): Future[Unit]

    Ends an authenticator session.

    Ends an authenticator session. This is invoked when the authenticator becomes invalid (for Java actions)

    javaContext

    the current http context

    returns

    the current http context modified to signal the authenticator is no longer valid

  3. abstract def discarding(result: Result): Future[Result]

    Ends an authenticator session.

    Ends an authenticator session. This is invoked when the user logs out or if the authenticator becomes invalid (maybe due to a timeout)

    result

    the result that is about to be sent to the client.

    returns

    the result modified to signal the authenticator is no longer valid

  4. abstract val expirationDate: DateTime

    The expiration date

  5. abstract val id: String

    An id for this authenticator

  6. abstract def isValid: Boolean

    Checks if this authenticator is valid.

    Checks if this authenticator is valid.

    returns

    true if the authenticator is valid, false otherwise

  7. abstract val lastUsed: DateTime

    The last used time

  8. abstract def starting(result: Result): Future[Result]

    Starts an authenticator session.

    Starts an authenticator session. This is invoked when the user logs in.

    result

    the result that is about to be sent to the client

    returns

    the result modified to signal a new session has been created.

  9. abstract def touch: Future[Authenticator[U]]

    Touches the authenticator.

    Touches the authenticator. This is invoked every time a protected action is executed. Depending on the implementation this can be used to update the last time used timestamp

    returns

    an updated instance

  10. abstract def touching(javaContext: Context): Future[Unit]

    Invoked after a protected Java action is executed.

    Invoked after a protected Java action is executed. This can be used to alter the result in implementations that need to update the information sent to the client after the authenticator is used.

    javaContext

    the current http context

    returns

    the http context modified with the updated authenticator

  11. abstract def touching(result: Result): Future[Result]

    Invoked after a protected action is executed.

    Invoked after a protected action is executed. This can be used to alter the result in implementations that need to update the information sent to the client after the authenticator is used.

    result

    the result that is about to be sent to the client.

    returns

    the result modified with the updated authenticator

  12. abstract def updateUser(user: U): Future[Authenticator[U]]

    Updated the user associated with this authenticator.

    Updated the user associated with this authenticator. This method can be used by authenticators that store user information on the client side.

    user

    the user object

    returns

    an updated instance

  13. abstract val user: U

    The user this authenticator represents

Concrete 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. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

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

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

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

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

    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  15. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  16. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped