IdContainer

An IdContainer's job is to manage user sessions server-side. It is responsible for creating, destroying, validating, and prolonging existing sessions.

The basic workflow is:

1.) A user ID is passed to start a new session, and the IdContainer gives the user an AuthenticityToken in return. 2.) The user presents the AuthenticityToken as evidence that they are authenticated, and the IdContainer confirms the validity of the token. 3.) When presenting a valid AuthenticityToken, that token's session can be prolonged. 4.) When the user logs out, the IdContainer will no longer recognize their token as valid.

Id: The type of the user's ID, which is a primary identifier of a session.

Linear Supertypes

AnyRef, Any

Known Subclasses

CacheIdContainer, TransparentIdContainer

Abstract Value Members

abstract def get(token: AuthenticityToken)(implicit ec: ExecutionContext): Future[Option[Id]]

Finds the user ID that is associated with an AuthenticityToken.
Finds the user ID that is associated with an AuthenticityToken. If Some[Id] is returned, that is sufficient to show that a user's session is valid.
token
The AuthenticityToken to verify.
returns
The user ID associated with the AuthenticityToken within the IdContainer, if there is one. Otherwise, None.
abstract def prolongTimeout(token: AuthenticityToken, timeout: Duration)(implicit ec: ExecutionContext): Future[Unit]

Delays the expiration of a session by a given duration.
Delays the expiration of a session by a given duration.
token
The AuthenticityToken of the session to prolong.
timeout
The new duration of the session. e.g. if there is 30 minutes left in a session, and a timeout of one hour is passed, the session will expire in one hour.
returns
A successful Future if the session was prolonged, or a failed Future if the session isn't valid, or some other error occurred.
abstract def remove(token: AuthenticityToken)(implicit ec: ExecutionContext): Future[Unit]

Destroys the session identified by a given token.
Destroys the session identified by a given token.
token
The AuthenticityToken that is paired with the session to be destroyed.
returns
A successful Future if the session was destroyed, or a failed Future if an error occurred.
abstract def startNewSession(userId: Id, timeout: Duration)(implicit ec: ExecutionContext): Future[AuthenticityToken]

Opens a new session for a user, and generates an AuthenticityToken that is paired with that user's ID.
Opens a new session for a user, and generates an AuthenticityToken that is paired with that user's ID.
userId
The ID of the session the session will be created for.
timeout
How long the session will be valid before expiring in a stateful IdContainer.
returns
An AuthenticityToken to be given to the user to later verify their session is valid.

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( ... )
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
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
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 toString(): String

Definition Classes
AnyRef → Any
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 sentry

trait IdContainer[Id] extends AnyRef

Abstract Value Members

abstract def get(token: AuthenticityToken)(implicit ec: ExecutionContext): Future[Option[Id]]

abstract def prolongTimeout(token: AuthenticityToken, timeout: Duration)(implicit ec: ExecutionContext): Future[Unit]

abstract def remove(token: AuthenticityToken)(implicit ec: ExecutionContext): Future[Unit]

abstract def startNewSession(userId: Id, timeout: Duration)(implicit ec: ExecutionContext): Future[AuthenticityToken]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped