Interface ICredentialStore

Interface for credential stores which are used to store and lookup credentials to authenticate against external services.

see: CredentialParams
see: ConnectionParams

Hierarchy

ICredentialStore

Implemented by

MemoryCredentialStore

Index

Methods

lookup
store

Methods

lookup

lookup(correlationId: string, key: string, callback: function): void

- Defined in auth/ICredentialStore.ts:29
Lookups credential parameters by its key.

Parameters
- correlationId: string
  
  (optional) transaction id to trace execution through call chain.
- key: string
  
  a key to uniquely identify the credential.
- callback: function
  
  callback function that receives found credential or error.
  - - (err: any, result: CredentialParams): void
    - Parameters
      - err: any
      - result: CredentialParams
      Returns void
Returns void

store

store(correlationId: string, key: String, credential: CredentialParams, callback: function): void

- Defined in auth/ICredentialStore.ts:20
Stores credential parameters into the store.

Parameters
- correlationId: string
  
  (optional) transaction id to trace execution through call chain.
- key: String
  
  a key to uniquely identify the credential.
- credential: CredentialParams
  
  a credential to be stored.
- callback: function
  
  callback function that receives an error or null for success.
  - - (err: any): void
    - Parameters
      - err: any
      Returns void
Returns void

Generated using TypeDoc