Class SessionStore

Hierarchy (View Summary)

StoringActor<Session, SessionStoreMessage, SessionStoreResult>
- SessionStore

Index

Constructors

Properties

Methods

afterEntityRemovedFromCache afterEntityWasCached afterStart beforeShutdown cleanup deleteEntity determineRole getEntity receive storeEntity updateIndices

Constructors

constructor

new SessionStore(name: string, system: ActorSystem): SessionStore
Parameters
- name: string
- system: ActorSystem
Returns SessionStore
Overrides StoringActor.constructor
- Defined in backend/src/actors/SessionStore.ts:20

Properties

`Protected` `Readonly`collectionName

collectionName: string

`Protected` `Readonly`connector

connector: DbClient = ...

`Protected`state

state: SessionStoreState = ...

Methods

`Protected`afterEntityRemovedFromCache

afterEntityRemovedFromCache(_uid: string & BRAND<"UID">): Promise<void>
Parameters
- _uid: string & BRAND<"UID">
Returns Promise<void>
Inherited from StoringActor.afterEntityRemovedFromCache
- Defined in backend/src/actors/StoringActor.ts:63

`Protected`afterEntityWasCached

afterEntityWasCached(_uid: string & BRAND<"UID">): Promise<void>
Parameters
- _uid: string & BRAND<"UID">
Returns Promise<void>
Inherited from StoringActor.afterEntityWasCached
- Defined in backend/src/actors/StoringActor.ts:86

afterStart

afterStart(): Promise<void>
Runs after the actor was started and is ready to receive messages.

Returns Promise<void>
Inherited from StoringActor.afterStart
- Defined in backend/src/actors/StoringActor.ts:33

beforeShutdown

beforeShutdown(): Promise<void>
Runs before the actor gets shut down by the actor system

Returns Promise<void>
Inherited from StoringActor.beforeShutdown
- Defined in backend/src/actors/StoringActor.ts:37

`Protected`cleanup

cleanup(): void
Returns void
Inherited from StoringActor.cleanup
- Defined in backend/src/actors/StoringActor.ts:67

`Protected`deleteEntity

deleteEntity(uid: string & BRAND<"UID">): Promise<Unit>
Parameters
- uid: string & BRAND<"UID">
Returns Promise<Unit>
Inherited from StoringActor.deleteEntity
- Defined in backend/src/actors/StoringActor.ts:135

`Protected`determineRole

determineRole(
    from: ActorRef,
): Promise<
    [
        UserRole: AccessRole,
        UserID: string & BRAND<"UID">,
        IsTemporaryAccount: boolean,
    ],
>
Parameters
- from: ActorRef
Returns Promise<
    [
        UserRole: AccessRole,
        UserID: string & BRAND<"UID">,
        IsTemporaryAccount: boolean,
    ],
>
Inherited from StoringActor.determineRole
- Defined in backend/src/actors/StoringActor.ts:42

`Protected`getEntity

getEntity(
    uid: string & BRAND<"UID">,
): Promise<
    MaybeBase<
        {
            accessToken: string;
            actorSystem: string;
            created: Timestamp;
            fingerprint?: string;
            idExpires: Timestamp;
            idToken: string;
            persistentCookie?: boolean;
            refreshExpires: Timestamp;
            refreshToken: string;
            role: "STUDENT"
            | "TEACHER"
            | "ADMIN";
            uid: string & BRAND<"UID">;
            updated: Timestamp;
        },
    >,
>
Parameters
- uid: string & BRAND<"UID">
Returns Promise<
    MaybeBase<
        {
            accessToken: string;
            actorSystem: string;
            created: Timestamp;
            fingerprint?: string;
            idExpires: Timestamp;
            idToken: string;
            persistentCookie?: boolean;
            refreshExpires: Timestamp;
            refreshToken: string;
            role: "STUDENT"
            | "TEACHER"
            | "ADMIN";
            uid: string & BRAND<"UID">;
            updated: Timestamp;
        },
    >,
>
Inherited from StoringActor.getEntity
- Defined in backend/src/actors/StoringActor.ts:90

receive

receive(
    from: ActorRef,
    message:
        | { SessionStoreMessages: "Ping" } & { value: {} }
        | { SessionStoreMessages: "StoreSession" } & {
            value: Partial<
                {
                    accessToken: string;
                    actorSystem: string;
                    created: Timestamp;
                    fingerprint?: string;
                    idExpires: Timestamp;
                    idToken: string;
                    persistentCookie?: boolean;
                    refreshExpires: Timestamp;
                    refreshToken: string;
                    role: "STUDENT"
                    | "TEACHER"
                    | "ADMIN";
                    uid: string & BRAND<"UID">;
                    updated: Timestamp;
                },
            > & { uid: string & BRAND<"UID"> };
        }
        | { SessionStoreMessages: "CheckSession" } & {
            value: string & BRAND<"UID">;
        }
        | { SessionStoreMessages: "GetSessionForUserId" } & {
            value: string & BRAND<"UID">;
        }
        | { SessionStoreMessages: "GetSessionForClient" } & {
            value: string & BRAND<"UID">;
        }
        | { SessionStoreMessages: "RemoveSession" } & {
            value: string & BRAND<"UID">;
        },
): Promise<SessionStoreResult>
Abstract method that handles all incoming messages
Parameters
- from: ActorRef
  actor that has send the message
- message:
      | { SessionStoreMessages: "Ping" } & { value: {} }
      | { SessionStoreMessages: "StoreSession" } & {
          value: Partial<
              {
                  accessToken: string;
                  actorSystem: string;
                  created: Timestamp;
                  fingerprint?: string;
                  idExpires: Timestamp;
                  idToken: string;
                  persistentCookie?: boolean;
                  refreshExpires: Timestamp;
                  refreshToken: string;
                  role: "STUDENT"
                  | "TEACHER"
                  | "ADMIN";
                  uid: string & BRAND<"UID">;
                  updated: Timestamp;
              },
          > & { uid: string & BRAND<"UID"> };
      }
      | { SessionStoreMessages: "CheckSession" } & {
          value: string & BRAND<"UID">;
      }
      | { SessionStoreMessages: "GetSessionForUserId" } & {
          value: string & BRAND<"UID">;
      }
      | { SessionStoreMessages: "GetSessionForClient" } & {
          value: string & BRAND<"UID">;
      }
      | { SessionStoreMessages: "RemoveSession" } & {
          value: string & BRAND<"UID">;
      }
  message type
Returns Promise<SessionStoreResult>
promised return value. If the caller used ask, this value will be returned to the calling actor
Overrides StoringActor.receive
- Defined in backend/src/actors/SessionStore.ts:47

`Protected`storeEntity

storeEntity(
    entity: {
        accessToken: string;
        actorSystem: string;
        created: Timestamp;
        fingerprint?: string;
        idExpires: Timestamp;
        idToken: string;
        persistentCookie?: boolean;
        refreshExpires: Timestamp;
        refreshToken: string;
        role: "STUDENT" | "TEACHER" | "ADMIN";
        uid: string & BRAND<"UID">;
        updated: Timestamp;
    },
): Promise<
    {
        accessToken: string;
        actorSystem: string;
        created: Timestamp;
        fingerprint?: string;
        idExpires: Timestamp;
        idToken: string;
        persistentCookie?: boolean;
        refreshExpires: Timestamp;
        refreshToken: string;
        role: "STUDENT"
        | "TEACHER"
        | "ADMIN";
        uid: string & BRAND<"UID">;
        updated: Timestamp;
    },
>
Parameters
- entity: {
      accessToken: string;
      actorSystem: string;
      created: Timestamp;
      fingerprint?: string;
      idExpires: Timestamp;
      idToken: string;
      persistentCookie?: boolean;
      refreshExpires: Timestamp;
      refreshToken: string;
      role: "STUDENT" | "TEACHER" | "ADMIN";
      uid: string & BRAND<"UID">;
      updated: Timestamp;
  }
Returns Promise<
    {
        accessToken: string;
        actorSystem: string;
        created: Timestamp;
        fingerprint?: string;
        idExpires: Timestamp;
        idToken: string;
        persistentCookie?: boolean;
        refreshExpires: Timestamp;
        refreshToken: string;
        role: "STUDENT"
        | "TEACHER"
        | "ADMIN";
        uid: string & BRAND<"UID">;
        updated: Timestamp;
    },
>
Inherited from StoringActor.storeEntity
- Defined in backend/src/actors/StoringActor.ts:115

`Protected`updateIndices

updateIndices(
    draft: SessionStoreState,
    entity: {
        accessToken: string;
        actorSystem: string;
        created: Timestamp;
        fingerprint?: string;
        idExpires: Timestamp;
        idToken: string;
        persistentCookie?: boolean;
        refreshExpires: Timestamp;
        refreshToken: string;
        role: "STUDENT" | "TEACHER" | "ADMIN";
        uid: string & BRAND<"UID">;
        updated: Timestamp;
    },
): void
Parameters
- draft: SessionStoreState
- entity: {
      accessToken: string;
      actorSystem: string;
      created: Timestamp;
      fingerprint?: string;
      idExpires: Timestamp;
      idToken: string;
      persistentCookie?: boolean;
      refreshExpires: Timestamp;
      refreshToken: string;
      role: "STUDENT" | "TEACHER" | "ADMIN";
      uid: string & BRAND<"UID">;
      updated: Timestamp;
  }
Returns void
Overrides StoringActor.updateIndices
- Defined in backend/src/actors/SessionStore.ts:24

Class SessionStore

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SessionStore

Properties

Protected ReadonlycollectionName

Protected Readonlyconnector

Protectedstate

Methods

ProtectedafterEntityRemovedFromCache

Parameters

Returns Promise<void>

ProtectedafterEntityWasCached

Parameters

Returns Promise<void>

afterStart

Returns Promise<void>

beforeShutdown

Returns Promise<void>

Protectedcleanup

Returns void

ProtecteddeleteEntity

Parameters

Returns Promise<Unit>

ProtecteddetermineRole

Parameters

Returns Promise< [ UserRole: AccessRole, UserID: string & BRAND<"UID">, IsTemporaryAccount: boolean, ],>

ProtectedgetEntity

Parameters

receive

Parameters

Returns Promise<SessionStoreResult>

ProtectedstoreEntity

Parameters

ProtectedupdateIndices

Parameters

Returns void

Settings

On This Page

`Protected` `Readonly`collectionName

`Protected` `Readonly`connector

`Protected`state

`Protected`afterEntityRemovedFromCache

`Protected`afterEntityWasCached

`Protected`cleanup

`Protected`deleteEntity

`Protected`determineRole

Returns Promise<
[
UserRole: AccessRole,
UserID: string & BRAND<"UID">,
IsTemporaryAccount: boolean,
],
>

`Protected`getEntity

`Protected`storeEntity

`Protected`updateIndices