Class SecurityContext

Base-class for a context that authenticates users and manages security.

Hierarchy

SecurityContext
- SessionSecurityContext

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new SecurityContext(repository: AuthenticatableRepository, name: string): SecurityContext

- Defined in src/auth/context/SecurityContext.ts:21
Parameters
- repository: AuthenticatableRepository
- name: string
Returns SecurityContext

Properties

Protected Optional authenticatedUser

authenticatedUser: Authenticatable

The currently authenticated user, if one exists.

Protected Readonly bus

Protected Readonly logging

logging: Logging

Readonly name

name: string

Readonly repository

repository: AuthenticatableRepository

Methods

authenticate

authenticate(user: Authenticatable): Promise<void>

- Defined in src/auth/context/SecurityContext.ts:50
Authenticate the given user and persist the authentication.

Parameters
- user: Authenticatable
Returns Promise<void>

authenticateOnce

authenticateOnce(user: Authenticatable): Promise<void>

- Defined in src/auth/context/SecurityContext.ts:41
Authenticate the given user, without persisting the authentication. That is, when the lifecycle ends, the user will be unauthenticated implicitly.

Parameters
- user: Authenticatable
Returns Promise<void>

flush

flush(): Promise<void>

- Defined in src/auth/context/SecurityContext.ts:70
Unauthenticate the current user, if one exists, and persist the change.

Returns Promise<void>

flushOnce

flushOnce(): Promise<void>

- Defined in src/auth/context/SecurityContext.ts:59
Unauthenticate the current user, if one exists, but do not persist the change.

Returns Promise<void>

getUser

getUser(): Maybe<Authenticatable>

- Defined in src/auth/context/SecurityContext.ts:94
Get the currently authenticated user, if one exists.

Returns Maybe<Authenticatable>

hasUser

hasUser(): boolean

- Defined in src/auth/context/SecurityContext.ts:101
Returns true if there is a currently authenticated user.

Returns boolean

initialize

initialize(): Awaitable<void>

- Defined in src/auth/context/SecurityContext.ts:34
Called when the context is created. Can be used by child-classes to do setup work.

Returns Awaitable<void>

Abstract persist

persist(): Awaitable<void>

- Defined in src/auth/context/SecurityContext.ts:89
Write the current state of the security context to whatever storage medium the context's host provides.

Returns Awaitable<void>

Abstract resume

resume(): Awaitable<void>

- Defined in src/auth/context/SecurityContext.ts:83
Assuming a user is still authenticated in the context, try to look up and fill in the user.

Returns Awaitable<void>

extollo (v. latin) - to lift up, to elevate

Extollo is a free & libre application framework in TypeScript.