CookieAuthenticator

Instance Constructors

new CookieAuthenticator(id: String, user: U, expirationDate: DateTime, lastUsed: DateTime, creationDate: DateTime, config: CookieConfig, store: AuthenticatorStore[CookieAuthenticator[U]])

id
the authenticator id
user
the user this authenticator is associated with
expirationDate
the expiration date
lastUsed
the last time the authenticator was used
creationDate
the authenticator creation time
store
the authenticator store where instances of this authenticator are persisted

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
val absoluteTimeoutInSeconds: Int

The time an authenticator is allowed to live in the store
The time an authenticator is allowed to live in the store

Definition Classes
CookieAuthenticator → StoreBackedAuthenticator
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val config: CookieConfig
val creationDate: DateTime

the authenticator creation time
the authenticator creation time

Definition Classes
CookieAuthenticator → Authenticator
def discarding(javaContext: Context): Future[Unit]

Removes the authenticator from the store and discards the cookie associated with it.
Removes the authenticator from the store and discards the cookie associated with it.
javaContext
the current invocation context
returns
the current http context modified to signal the authenticator is no longer valid

Definition Classes
CookieAuthenticator → 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
CookieAuthenticator → StoreBackedAuthenticator → Authenticator
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
implicit val executionContext: ExecutionContext

Definition Classes
StoreBackedAuthenticator
val expirationDate: DateTime

the expiration date
the expiration date

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

Definition Classes
StoreBackedAuthenticator
def finalize(): Unit

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

Definition Classes
AnyRef → Any
val id: String

the authenticator id
the authenticator id

Definition Classes
CookieAuthenticator → Authenticator
val idleTimeoutInMinutes: Int

The inactivity period after which an authenticator is considered invalid
The inactivity period after which an authenticator is considered invalid

Definition Classes
CookieAuthenticator → StoreBackedAuthenticator
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 lastUsed: DateTime

the last time the authenticator was used
the last time the authenticator was used

Definition Classes
CookieAuthenticator → Authenticator
val logger: Logger

Attributes
protected
Definition Classes
StoreBackedAuthenticator
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def starting(result: Result): Future[Result]

Starts an authenticated session by placing a cookie in the result
Starts an authenticated session by placing a cookie in the result
result
the result that is about to be sent to the client
returns
the result with the authenticator cookie set

Definition Classes
CookieAuthenticator → Authenticator
val store: AuthenticatorStore[CookieAuthenticator[U]]

the authenticator store where instances of this authenticator are persisted
the authenticator store where instances of this authenticator are persisted

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

Definition Classes
StoreBackedAuthenticator
def touch: Future[CookieAuthenticator[U]]

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[CookieAuthenticator[U]]

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
val user: U

the user this authenticator is associated with
the user this authenticator is associated with

Definition Classes
CookieAuthenticator → 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( ... )
def withLastUsedTime(time: DateTime): CookieAuthenticator[U]

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

Definition Classes
CookieAuthenticator → StoreBackedAuthenticator
def withUser(user: U): CookieAuthenticator[U]

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

Definition Classes
CookieAuthenticator → StoreBackedAuthenticator

Related Docs: object CookieAuthenticator | package authenticator

case class CookieAuthenticator[U](id: String, user: U, expirationDate: DateTime, lastUsed: DateTime, creationDate: DateTime, config: CookieConfig, store: AuthenticatorStore[CookieAuthenticator[U]]) extends StoreBackedAuthenticator[U, CookieAuthenticator[U]] with Product with Serializable

Instance Constructors

new CookieAuthenticator(id: String, user: U, expirationDate: DateTime, lastUsed: DateTime, creationDate: DateTime, config: CookieConfig, store: AuthenticatorStore[CookieAuthenticator[U]])

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val absoluteTimeoutInSeconds: Int

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val config: CookieConfig

val creationDate: DateTime

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

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

final def eq(arg0: AnyRef): Boolean

implicit val executionContext: ExecutionContext

val expirationDate: DateTime

def expired: Boolean

def finalize(): Unit

final def getClass(): Class[_]

val id: String

val idleTimeoutInMinutes: Int

final def isInstanceOf[T0]: Boolean

def isValid: Boolean

val lastUsed: DateTime

val logger: Logger

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

val store: AuthenticatorStore[CookieAuthenticator[U]]

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

def timedOut: Boolean

def touch: Future[CookieAuthenticator[U]]

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

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

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

val user: U

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def withLastUsedTime(time: DateTime): CookieAuthenticator[U]

def withUser(user: U): CookieAuthenticator[U]

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from StoreBackedAuthenticator[U, CookieAuthenticator[U]]

Inherited from Authenticator[U]

Inherited from AnyRef

Inherited from Any

Ungrouped