SessionManager

Abstract Value Members

abstract def create(id: String)(implicit executor: ExecutionContext): Future[Session]

Create a new empty session.
Create a new empty session. The id is a hint to the session manager and implementations can ignore if needed. This is useful for distributed implementations where id coordination may be time consuming or unfeasible. Because of that, you should check the id from the session after it is created as the id may differ.
id
a hint to the id, which may or may not be honoured.
abstract def create(implicit executor: ExecutionContext): Future[Session]

Create a new empty session.
Create a new empty session. The newly created session will be assigned an id by the underlying implementation.
returns
a Future which when completed contains the created Session.
abstract def expire(id: String)(implicit executor: ExecutionContext): Future[Unit]

Mark the session identified by the given id as expired and remove it from the underlying implementation.
Mark the session identified by the given id as expired and remove it from the underlying implementation.
id
the id of the session to expire/remove
returns
a Future which is completed once the session has been removed from the backing store.
abstract def get(id: String)(implicit executor: ExecutionContext): Future[Option[Session]]

Returns a Session for the given id.
Returns a Session for the given id. If no session exists, then the result from the Future will contain a None.
abstract def update(session: Session)(implicit executor: ExecutionContext): Future[Session]

Save the given session to the backing store.
Save the given session to the backing store.
session
the session to persist
returns
a Future which is completed once the session has been persisted.

Concrete 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
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def exists(id: String)(implicit executor: ExecutionContext): Future[Boolean]

Returns true if the session identified by the given id exists in this session manager.
def expire(session: Session)(implicit executor: ExecutionContext): Future[Unit]

Mark the given session as expired and remove it from the underlying implementation.
Mark the given session as expired and remove it from the underlying implementation. If the session does not exist or has already expired, then this is a no-op.
def finalize(): Unit

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

Definition Classes
AnyRef → Any
def getOrCreate(id: String)(implicit executor: ExecutionContext): Future[Session]

Returns a session for the given id or creates a new session if none is available.
Returns a session for the given id or creates a new session if none is available.
Implementations are free to ignore the given id when creating an new session and can assign a different id. This is useful for distributed implementations where id coordination may be time consuming or unfeasible.
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( ... )

trait SessionManager extends AnyRef

Abstract Value Members

abstract def create(id: String)(implicit executor: ExecutionContext): Future[Session]

abstract def create(implicit executor: ExecutionContext): Future[Session]

abstract def expire(id: String)(implicit executor: ExecutionContext): Future[Unit]

abstract def get(id: String)(implicit executor: ExecutionContext): Future[Option[Session]]

abstract def update(session: Session)(implicit executor: ExecutionContext): Future[Session]

Concrete 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

def equals(arg0: Any): Boolean

def exists(id: String)(implicit executor: ExecutionContext): Future[Boolean]

def expire(session: Session)(implicit executor: ExecutionContext): Future[Unit]

def finalize(): Unit

def generateId: String

final def getClass(): Class[_]

def getOrCreate(id: String)(implicit executor: ExecutionContext): Future[Session]

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