Class SessionTokenManager

Token Manager of CouchDB session token.

The Token Manager performs basic auth with username and password to acquire session tokens.

Hierarchy

TokenManager
- SessionTokenManager

Index

Constructors

Properties

options requiredOptions tokenName

Methods

requestToken saveTokenInfo setHeaders

Constructors

constructor

new SessionTokenManager(options: SessionTokenManagerOptions): SessionTokenManager
Create a new SessionTokenManager instance. For internal use by CouchdbSessionAuthenticator only.
Parameters
- options: SessionTokenManagerOptions
  
  Configuration options.
Returns SessionTokenManager
Overrides TokenManager.constructor
- Defined in auth/sessionTokenManager.ts:67

Properties

`Private` options

options: SessionTokenManagerOptions

`Protected` requiredOptions

requiredOptions: string[] = ...

`Private` tokenName

tokenName: string

Methods

`Protected` requestToken

requestToken(): Promise<any>
Request a session token using basic credentials.

Returns

Returns Promise<any>
Overrides TokenManager.requestToken
- Defined in auth/sessionTokenManager.ts:94

`Private` saveTokenInfo

saveTokenInfo(tokenResponse: any): void
Private
From the response parse and save session token into field accessToken. Calculate expiration and refresh time from the received response and store them in fields expireTime and refreshTime.

Returns
Parameters
- tokenResponse: any
  
  Response object from session token request
Returns void
Overrides TokenManager.saveTokenInfo
- Defined in auth/sessionTokenManager.ts:122

setHeaders

setHeaders(headers: OutgoingHttpHeaders): void
Only base service specific headers are in use.

Returns
Parameters
- headers: OutgoingHttpHeaders
  
  the new set of headers as an object
Returns void
Overrides TokenManager.setHeaders
- Defined in auth/sessionTokenManager.ts:83

Generated using TypeDoc