Class BaseClientCredentialsStore

A ClientCredentialsStore that uses a AccountLoginStorage for storing the tokens. Needs to be initialized before it can be used.

Hierarchy (view full)

Initializer
- BaseClientCredentialsStore

Implements

ClientCredentialsStore

Index

Constructors

Methods

canHandle create delete findByAccount findByLabel get handle handleSafe

Constructors

constructor

new BaseClientCredentialsStore(storage): BaseClientCredentialsStore
Parameters
- storage: AccountLoginStorage<Record<string, never>>
Returns BaseClientCredentialsStore
Overrides Initializer.constructor
- Defined in src/identity/interaction/client-credentials/util/BaseClientCredentialsStore.ts:31

Methods

canHandle

canHandle(input): Promise<void>
Checks whether the input can be handled by this class. If it cannot handle the input, rejects with an error explaining why.
Parameters
- input: void
  Input that could potentially be handled.
Returns Promise<void>
A promise resolving if the input can be handled, rejecting with an Error if not.
Inherited from Initializer.canHandle
- Defined in src/util/handlers/AsyncHandler.ts:18

create

create(label, webId, accountId): Promise<ClientCredentials>
Creates new token.
Parameters
- label: string
  Identifier to use for the new token.
- webId: string
  WebID to identify as when using this token.
- accountId: string
Returns Promise<ClientCredentials>
Implementation of ClientCredentialsStore.create
- Defined in src/identity/interaction/client-credentials/util/BaseClientCredentialsStore.ts:70

delete

delete(id): Promise<void>
Deletes the token with the given ID.
Parameters
- id: string
  ID of the token.
Returns Promise<void>
Implementation of ClientCredentialsStore.delete
- Defined in src/identity/interaction/client-credentials/util/BaseClientCredentialsStore.ts:80

findByAccount

findByAccount(accountId): Promise<ClientCredentials[]>
Find all tokens created by the given account.
Parameters
- accountId: string
  ID of the account.
Returns Promise<ClientCredentials[]>
Implementation of ClientCredentialsStore.findByAccount
- Defined in src/identity/interaction/client-credentials/util/BaseClientCredentialsStore.ts:66

findByLabel

findByLabel(label): Promise<undefined | ClientCredentials>
Find the ClientCredentials with the given label.
Parameters
- label: string
  Label of the token.
Returns Promise<undefined | ClientCredentials>
Implementation of ClientCredentialsStore.findByLabel
- Defined in src/identity/interaction/client-credentials/util/BaseClientCredentialsStore.ts:58

get

get(id): Promise<undefined | ClientCredentials>
Find the ClientCredentials with the given ID.
Parameters
- id: string
  ID of the token.
Returns Promise<undefined | ClientCredentials>
Implementation of ClientCredentialsStore.get
- Defined in src/identity/interaction/client-credentials/util/BaseClientCredentialsStore.ts:54

handle

handle(): Promise<void>
Handles the given input. This may only be called if canHandle did not reject. When unconditionally calling both in sequence, consider handleSafe instead.

Returns Promise<void>
A promise resolving when handling is finished.
Overrides Initializer.handle
- Defined in src/identity/interaction/client-credentials/util/BaseClientCredentialsStore.ts:37

handleSafe

handleSafe(input): Promise<void>
Helper function that first runs canHandle followed by handle. Throws the error of canHandle if the data cannot be handled, or returns the result of handle otherwise.
Parameters
- input: void
  Input data that will be handled if it can be handled.
Returns Promise<void>
A promise resolving if the input can be handled, rejecting with an Error if not.
Inherited from Initializer.handleSafe
- Defined in src/util/handlers/AsyncHandler.ts:41