Class OAuthTokenPolicy

Hierarchy

PolicyBase
- OAuthTokenPolicy
  - OAuthTokenExtPolicy
  - OpenIDPolicy

Implements

IPolicy

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new OAuthTokenPolicy(settings: IOAuthTokenPolicyCtorOptions): OAuthTokenPolicy

Overrides PolicyBase.constructor
- Defined in security/oauth-token-policy.ts:37
Parameters
- settings: IOAuthTokenPolicyCtorOptions
Returns OAuthTokenPolicy

Properties

Protected clientId

clientId: string

Protected clientSecret

clientSecret: string

Protected createdOn

createdOn: number

Protected expiresIn

expiresIn: number

grantType

grantType: "authorization_code" | "refresh_token" | "password" | "client_credentials"

Protected refreshToken

refreshToken: string

Protected scope

scope: string

Protected token

token: string

Protected url

url: string

Methods

applyTo

applyTo(options: any): void

Implementation of IPolicy.applyTo

Overrides PolicyBase.applyTo
- Defined in security/oauth-token-policy.ts:122
Applys the token to the given options.

Parameters
- options: any
Returns void

applyToV2

applyToV2(options: any): void

Implementation of IPolicy.applyToV2

Overrides PolicyBase.applyToV2
- Defined in security/oauth-token-policy.ts:131
Apply security policy to the given options.

Parameters
- options: any
Returns void

applyToV3

applyToV3(options: any): void

Implementation of IPolicy.applyToV3

Overrides PolicyBase.applyToV3
- Defined in security/oauth-token-policy.ts:141
App security policy the given options, used for our customized XHR.

Parameters
- options: any
Returns void

getParams

getParams(): any

- Defined in security/oauth-token-policy.ts:73
Returns any

getTokenInternal

getTokenInternal(): PromiseLike<string>

Implementation of IPolicy.getTokenInternal

Overrides PolicyBase.getTokenInternal
- Defined in security/oauth-token-policy.ts:83
Returns PromiseLike<string>

getTokenP

getTokenP(): PromiseLike<string>

Implementation of IPolicy.getTokenP

Inherited from PolicyBase.getTokenP
- Defined in security/policy-base.ts:44
The interface for retrieving the token from a remote server. This method internally dispatches the call to another method and cache the token.

Returns PromiseLike<string>

isExpired

isExpired(): boolean

Implementation of IPolicy.isExpired

Overrides PolicyBase.isExpired
- Defined in security/oauth-token-policy.ts:100
Returns if the token is expired or not.

Returns boolean

persistent

persistent(): IOAuthToken

Implementation of IPolicy.persistent

Overrides PolicyBase.persistent
- Defined in security/oauth-token-policy.ts:64
Returns the data that are persistentable.

Returns IOAuthToken

readFrom

readFrom(settings: IOAuthToken): void

Implementation of IPolicy.readFrom

Overrides PolicyBase.readFrom
- Defined in security/oauth-token-policy.ts:54
Feeds the policy with some settings from outside, usually from local storage

Parameters
- settings: IOAuthToken
Returns void

reset

reset(): void

Implementation of IPolicy.reset

Overrides PolicyBase.reset
- Defined in security/oauth-token-policy.ts:152
Resets the token and its assoicated information.

Returns void

Generated using TypeDoc