BearerTokenAuthenticator

An authenticator that uses a header based approach with the help of a bearer token. It works by transporting a token in a user defined header to track the authenticated user and a server side backing store that maps the token to an authenticator instance.

The authenticator can use sliding window expiration. This means that the authenticator times out after a certain time if it wasn't used. This can be controlled with the idleTimeout property.

Note: If deploying to multiple nodes the backing store will need to synchronize.

id: The authenticator ID.
loginInfo: The linked login info for an identity.
lastUsedDateTime: The last used date/time.
expirationDateTime: The expiration date/time.
idleTimeout: The duration an authenticator can be idle before it timed out.

Linear Supertypes

Serializable, Serializable, Product, Equals, ExpirableAuthenticator, StorableAuthenticator, Authenticator, AnyRef, Any

Instance Constructors

new BearerTokenAuthenticator(id: String, loginInfo: LoginInfo, lastUsedDateTime: DateTime, expirationDateTime: DateTime, idleTimeout: Option[FiniteDuration])

id
The authenticator ID.
loginInfo
The linked login info for an identity.
lastUsedDateTime
The last used date/time.
expirationDateTime
The expiration date/time.
idleTimeout
The duration an authenticator can be idle before it timed out.

Type Members

abstract type Settings

The type of the settings an authenticator can handle.
The type of the settings an authenticator can handle.

Definition Classes
Authenticator
type Value = String

The Type of the generated value an authenticator will be serialized to.
The Type of the generated value an authenticator will be serialized to.

Definition Classes
BearerTokenAuthenticator → Authenticator

Value Members

final def !=(arg0: AnyRef): Boolean

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

Definition Classes
Any
final def ##(): Int

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

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

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

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

Definition Classes
AnyRef
val expirationDateTime: DateTime

The expiration date/time.
The expiration date/time.

Definition Classes
BearerTokenAuthenticator → ExpirableAuthenticator
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
BearerTokenAuthenticator → StorableAuthenticator
val idleTimeout: Option[FiniteDuration]

The duration an authenticator can be idle before it timed out.
The duration an authenticator can be idle before it timed out.

Definition Classes
BearerTokenAuthenticator → ExpirableAuthenticator
def isExpired: Boolean

Checks if the authenticator is expired.
Checks if the authenticator is expired. This is an absolute timeout since the creation of the authenticator.
returns
True if the authenticator is expired, false otherwise.

Definition Classes
ExpirableAuthenticator
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isTimedOut: 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 sliding window expiration is activated and the authenticator is timed out, false otherwise.

Definition Classes
ExpirableAuthenticator
def isValid: Boolean

Checks if the authenticator isn't expired and isn't timed out.
Checks if the authenticator isn't expired and isn't timed out.
returns
True if the authenticator isn't expired and isn't timed out.

Definition Classes
ExpirableAuthenticator → Authenticator
val lastUsedDateTime: DateTime

The last used date/time.
The last used date/time.

Definition Classes
BearerTokenAuthenticator → ExpirableAuthenticator
val loginInfo: LoginInfo

The linked login info for an identity.
The linked login info for an identity.

Definition Classes
BearerTokenAuthenticator → Authenticator
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
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( ... )

case class BearerTokenAuthenticator(id: String, loginInfo: LoginInfo, lastUsedDateTime: DateTime, expirationDateTime: DateTime, idleTimeout: Option[FiniteDuration]) extends StorableAuthenticator with ExpirableAuthenticator with Product with Serializable

Instance Constructors

new BearerTokenAuthenticator(id: String, loginInfo: LoginInfo, lastUsedDateTime: DateTime, expirationDateTime: DateTime, idleTimeout: Option[FiniteDuration])

Type Members

abstract type Settings

type Value = String

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

val expirationDateTime: DateTime

def finalize(): Unit

final def getClass(): Class[_]

val id: String

val idleTimeout: Option[FiniteDuration]

def isExpired: Boolean

final def isInstanceOf[T0]: Boolean

def isTimedOut: Boolean

def isValid: Boolean

val lastUsedDateTime: DateTime

val loginInfo: LoginInfo

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from ExpirableAuthenticator

Inherited from StorableAuthenticator

Inherited from Authenticator

Inherited from AnyRef

Inherited from Any

Ungrouped