Class OAuthService<T>

OAuth service implementing the default OAuth workflow It is abstract as it does not manage any provider as is

todo: add some basic doc on OAuth workflow

Type parameters

T: OAuthServiceParameters

Hierarchy

Service<T>
- OAuthService

Implements

RequestFilter<Context>

Constructors

Properties

_authenticationService

_createException

_initTime

_name

_webda

logger

defaultMaxListeners

Methods

__clean

_callback

_redirect

_scope

_token

addRoute

computeParameters

emit

emitSync

generateAuthUrl

getCallbackReferer

getMaxListeners

getName

getWebda

hasToken

init

listeners

log

off

on

onAsync

once

prependListener

prependOnceListener

reinit

removeAllListeners

resolve

setMaxListeners

getModda

Constructors

new OAuthService(webda: Core, name: string, params?: any): OAuthService

Inherited from CloudWatchLogger.constructor

Parameters
- webda: Core
  
  The main instance of Webda
- name: string
  
  The name of the service
- Default value params: any = {}
  
  The parameters block define in the configuration file
Returns OAuthService
- Defined in packages/core/src/services/service.ts:59

Properties

_authenticationService: Authentication

_createException: string

_initException: any = undefined

_initTime: number

_name: string

Service name

_webda: Core

Webda Core object

logger: Logger

Logger with class context

parameters: T

Hold the parameters for your service

It will be bring from the webda.config.json

defaultMaxListeners: number

Methods

__clean(): Promise<any>

Inherited from CloudWatchLogger.__clean

Clean the service data, can only be used in test mode

abstract

Returns Promise<any>
- Defined in packages/core/src/services/service.ts:229

_callback(ctx: Context): Promise<void>

Parameters
- ctx: Context
Returns Promise<void>
- Defined in packages/core/src/services/oauth.ts:180

_redirect(ctx: Context): void

Parameters
- ctx: Context
Returns void
- Defined in packages/core/src/services/oauth.ts:155

_scope(ctx: Context): void

Parameters
- ctx: Context
Returns void
- Defined in packages/core/src/services/oauth.ts:147

_token(context: Context): Promise<void>

Parameters
- context: Context
Returns Promise<void>
- Defined in packages/core/src/services/oauth.ts:176

addListener(event: string | symbol, listener: function): this

Inherited from CloudWatchLogger.addListener

Overrides EventEmitter.addListener

Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
      Defined in node_modules/@types/node/events.d.ts:32
Returns this
- Defined in node_modules/@types/node/events.d.ts:32

addRoute(url: string, methods: HttpMethodType[], executer: Function, openapi?: object, allowPath?: boolean): void

Inherited from CloudWatchLogger.addRoute

Add a route dynamicaly

Parameters
- url: string
  
  of the route can contains dynamic part like {uuid}
- methods: HttpMethodType[]
- executer: Function
  
  Method to execute for this route
- Default value openapi: object = {}
- Default value allowPath: boolean = false
Returns void
- Defined in packages/core/src/services/service.ts:121

checkRequest(context: Context): Promise<boolean>

Parameters
- context: Context
Returns Promise<boolean>
- Defined in packages/core/src/services/oauth.ts:71

computeParameters(): void

Inherited from CloudWatchLogger.computeParameters

Used to compute or derivate input parameter to attribute

Returns void
- Defined in packages/core/src/services/service.ts:87

emit(event: string | symbol, ...args: any[]): boolean

Inherited from CloudWatchLogger.emit

Overrides EventEmitter.emit

Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean
- Defined in node_modules/@types/node/events.d.ts:44

emitSync(event: any, data: any): Promise<any[]>

Inherited from CloudWatchLogger.emitSync

Emit the event with data and wait for Promise to finish if listener returned a Promise

Parameters
- event: any
- data: any
Returns Promise<any[]>
- Defined in packages/core/src/services/service.ts:180

eventNames(): Array<string | symbol>

Inherited from CloudWatchLogger.eventNames

Overrides EventEmitter.eventNames

Returns Array<string | symbol>
- Defined in node_modules/@types/node/events.d.ts:45

generateAuthUrl(redirect_uri: string, state: string): string

Parameters
- redirect_uri: string
- state: string
Returns string
- Defined in packages/core/src/services/oauth.ts:172

getCallbackReferer(): RegExp[]

Returns RegExp[]
- Defined in packages/core/src/services/oauth.ts:196

getDefaultUrl(): string

Returns string
- Defined in packages/core/src/services/oauth.ts:194

getMaxListeners(): number

Inherited from CloudWatchLogger.getMaxListeners

Overrides EventEmitter.getMaxListeners

Returns number
- Defined in node_modules/@types/node/events.d.ts:41

getName(): string

Overrides CloudWatchLogger.getName

Returns string
- Defined in packages/core/src/services/oauth.ts:198

getParameters(): T

Inherited from CloudWatchLogger.getParameters

Get the service parameters

Returns T
- Defined in packages/core/src/services/service.ts:92

getService<T>(service: string): T

Inherited from CloudWatchLogger.getService

Return a webda service

Type parameters
- T: Service<ServiceParameters>
Parameters
- service: string
  
  name to retrieve
Returns T
- Defined in packages/core/src/services/service.ts:207

getWebda(): Core

Inherited from CloudWatchLogger.getWebda

Return WebdaCore

Returns Core
- Defined in packages/core/src/services/service.ts:99

handleReturn(ctx: Context, identId: string, profile: any): Promise<void>

Parameters
- ctx: Context
- identId: string
- profile: any
Returns Promise<void>
- Defined in packages/core/src/services/oauth.ts:182

hasToken(): boolean

Returns boolean
- Defined in packages/core/src/services/oauth.ts:151

init(): Promise<void>

Inherited from AWSSecretsManager.init

Will be called after all the Services are created

abstract

Returns Promise<void>
- Defined in packages/core/src/services/service.ts:165

initRoutes(): void

Overrides CloudWatchLogger.initRoutes

Returns void
- Defined in packages/core/src/services/oauth.ts:84

listenerCount(type: string | symbol): number

Inherited from CloudWatchLogger.listenerCount

Overrides EventEmitter.listenerCount

Parameters
- type: string | symbol
Returns number
- Defined in node_modules/@types/node/events.d.ts:46

listeners(event: string | symbol): Function[]

Inherited from CloudWatchLogger.listeners

Overrides EventEmitter.listeners

Parameters
- event: string | symbol
Returns Function[]
- Defined in node_modules/@types/node/events.d.ts:42

loadParameters(params: any): ServiceParameters

Overrides Queue.loadParameters

Load parameters

Parameters
- params: any
Returns ServiceParameters
- Defined in packages/core/src/services/oauth.ts:67

log(level: WorkerLogLevel, ...args: any[]): void

Inherited from CloudWatchLogger.log

Parameters
- level: WorkerLogLevel
  
  to log
- Rest ...args: any[]
Returns void
- Defined in packages/core/src/services/service.ts:249

off(event: string | symbol, listener: function): this

Inherited from CloudWatchLogger.off

Overrides EventEmitter.off

Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
      Defined in node_modules/@types/node/events.d.ts:38
Returns this
- Defined in node_modules/@types/node/events.d.ts:38

on(event: string | symbol, listener: function): this

Inherited from CloudWatchLogger.on

Overrides EventEmitter.on

Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
      Defined in node_modules/@types/node/events.d.ts:33
Returns this
- Defined in node_modules/@types/node/events.d.ts:33

onAsync(event: any, callback: any, queue?: string): void

Inherited from CloudWatchLogger.onAsync

Listen to an event as on(...) would do except that it will be asynchronous

Parameters
- event: any
- callback: any
- Default value queue: string = undefined
  
  Name of queue to use, can be undefined, queue name are used to define differents priorities
Returns void
- Defined in packages/core/src/services/service.ts:199

once(event: string | symbol, listener: function): this

Inherited from CloudWatchLogger.once

Overrides EventEmitter.once

Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
      Defined in node_modules/@types/node/events.d.ts:34
Returns this
- Defined in node_modules/@types/node/events.d.ts:34

prependListener(event: string | symbol, listener: function): this

Inherited from CloudWatchLogger.prependListener

Overrides EventEmitter.prependListener

Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
      Defined in node_modules/@types/node/events.d.ts:35
Returns this
- Defined in node_modules/@types/node/events.d.ts:35

prependOnceListener(event: string | symbol, listener: function): this

Inherited from CloudWatchLogger.prependOnceListener

Overrides EventEmitter.prependOnceListener

Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
      Defined in node_modules/@types/node/events.d.ts:36
Returns this
- Defined in node_modules/@types/node/events.d.ts:36

rawListeners(event: string | symbol): Function[]

Inherited from CloudWatchLogger.rawListeners

Overrides EventEmitter.rawListeners

Parameters
- event: string | symbol
Returns Function[]
- Defined in node_modules/@types/node/events.d.ts:43

reinit(config: any): Promise<void>

Inherited from CloudWatchLogger.reinit

Parameters
- config: any
  
  new parameters for the service
Returns Promise<void>
- Defined in packages/core/src/services/service.ts:171

removeAllListeners(event?: string | symbol): this

Inherited from CloudWatchLogger.removeAllListeners

Overrides EventEmitter.removeAllListeners

Parameters
- Optional event: string | symbol
Returns this
- Defined in node_modules/@types/node/events.d.ts:39

removeListener(event: string | symbol, listener: function): this

Inherited from CloudWatchLogger.removeListener

Overrides EventEmitter.removeListener

Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
      Defined in node_modules/@types/node/events.d.ts:37
Returns this
- Defined in node_modules/@types/node/events.d.ts:37

resolve(): void

Inherited from CloudWatchLogger.resolve

Resolve parameters Call initRoutes and initBeanRoutes

Returns void
- Defined in packages/core/src/services/service.ts:107

setMaxListeners(n: number): this

Inherited from CloudWatchLogger.setMaxListeners

Overrides EventEmitter.setMaxListeners

Parameters
- n: number
Returns this
- Defined in node_modules/@types/node/events.d.ts:40

toPublicJSON(object: any): string

Inherited from CloudWatchLogger.toPublicJSON

Convert an object to JSON using the Webda json filter

Parameters
- object: any
  
  The object to export
Returns string

The export of the strip object ( removed all attribute with _ )
- Defined in packages/core/src/services/service.ts:155

getModda(): ModdaDefinition | void

Inherited from Queue.getModda

Return the Modda definition if any

Returns ModdaDefinition | void
- Defined in packages/core/src/services/service.ts:215

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from CloudWatchLogger.listenerCount

deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number
- Defined in node_modules/@types/node/events.d.ts:29

Generated using TypeDoc