StoreBackedAuthenticator

Abstract Value Members

abstract val absoluteTimeoutInSeconds: Int

The time an authenticator is allowed to live in the store
abstract val creationDate: DateTime

The creation time
The creation time

Definition Classes
Authenticator
abstract val expirationDate: DateTime

The expiration date
The expiration date

Definition Classes
Authenticator
abstract val id: String

An id for this authenticator
An id for this authenticator

Definition Classes
Authenticator
abstract val idleTimeoutInMinutes: Int

The inactivity period after which an authenticator is considered invalid
abstract val lastUsed: DateTime

The last used time
The last used time

Definition Classes
Authenticator
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.

Definition Classes
Authenticator
abstract val store: AuthenticatorStore[T]

Annotations
@transient()
abstract val user: U

The user this authenticator represents
The user this authenticator represents

Definition Classes
Authenticator
abstract def withLastUsedTime(time: DateTime): T

Returns a copy of this authenticator with the given last used time
Returns a copy of this authenticator with the given last used time
time
the new time
returns
the modified authenticator
abstract def withUser(user: U): T

Returns a copy of this Authenticator with the given user
Returns a copy of this Authenticator with the given user
user
the new user
returns
the modified authenticator

Concrete 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( ... )
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

Definition Classes
StoreBackedAuthenticator → Authenticator
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

Definition Classes
StoreBackedAuthenticator → Authenticator
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
implicit val executionContext: ExecutionContext
def expired: Boolean

Checks if the authenticator has expired.
Checks if the authenticator has expired. This is an absolute timeout since the creation of the authenticator
returns
true if the authenticator has expired, false otherwise.
def finalize(): Unit

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

Definition Classes
AnyRef → Any
def hashCode(): Int

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

Definition Classes
Any
def isValid: Boolean

Checks if the authenticator is valid.
Checks if the authenticator is valid. For this implementation it means that the authenticator has not expired or timed out.
returns
true if the authenticator is valid, false otherwise.

Definition Classes
StoreBackedAuthenticator → Authenticator
val logger: Logger

Attributes
protected
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

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

Definition Classes
AnyRef
def timedOut: Boolean

Checks if the time elapsed since the last time the authenticator was used is longer than the maximum idle timeout specified in the properties.
Checks if the time elapsed since the last time the authenticator was used is longer than the maximum idle timeout specified in the properties.
returns
true if the authenticator timed out, false otherwise.
def toString(): String

Definition Classes
AnyRef → Any
def touch: Future[T]

Updated the last used timestamp
Updated the last used timestamp
returns
a future with the updated authenticator

Definition Classes
StoreBackedAuthenticator → Authenticator
def touching(javaContext: Context): Future[Unit]

Adds a touched authenticator to the result(for Java).
Adds a touched authenticator to the result(for Java). In this implementation there's no need to do anything with the result
javaContext
the current invocation context
returns
the http context modified with the updated authenticator

Definition Classes
StoreBackedAuthenticator → Authenticator
def touching(result: Result): Future[Result]

Adds a touched authenticator to the result (for Scala).
Adds a touched authenticator to the result (for Scala). In this implementation there's no need to do anything with the result

Definition Classes
StoreBackedAuthenticator → Authenticator
def updateUser(user: U): Future[T]

Updates the user information associated with this authenticator
Updates the user information associated with this authenticator
user
the user object
returns
a future with the updated authenticator

Definition Classes
StoreBackedAuthenticator → Authenticator
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package authenticator

trait StoreBackedAuthenticator[U, T <: Authenticator[U]] extends Authenticator[U]

Abstract Value Members

abstract val absoluteTimeoutInSeconds: Int

abstract val creationDate: DateTime

abstract val expirationDate: DateTime

abstract val id: String

abstract val idleTimeoutInMinutes: Int

abstract val lastUsed: DateTime

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

abstract val store: AuthenticatorStore[T]

abstract val user: U

abstract def withLastUsedTime(time: DateTime): T

abstract def withUser(user: U): T

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def discarding(javaContext: Context): Future[Unit]

def discarding(result: Result): Future[Result]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

implicit val executionContext: ExecutionContext

def expired: Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def isValid: Boolean

val logger: Logger

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def timedOut: Boolean

def toString(): String

def touch: Future[T]

def touching(javaContext: Context): Future[Unit]

def touching(result: Result): Future[Result]

def updateUser(user: U): Future[T]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Authenticator[U]

Inherited from AnyRef

Inherited from Any

Ungrouped