DefaultWebSocketRequestProcessor | @atomist/automation-client

Hierarchy

AbstractRequestProcessor
- DefaultWebSocketRequestProcessor

Implements

Index

Constructors

constructor

new DefaultWebSocketRequestProcessor(automations: AutomationServer, configuration: Configuration, listeners?: AutomationEventListener[]): DefaultWebSocketRequestProcessor

Overrides AbstractRequestProcessor.constructor
- Defined in lib/internal/transport/websocket/DefaultWebSocketRequestProcessor.ts:47
Parameters
- automations: AutomationServer
- configuration: Configuration
- Default value listeners: AutomationEventListener[] = []
Returns DefaultWebSocketRequestProcessor

Properties

Protected automations

automations: AutomationServer

Protected configuration

configuration: Configuration

Private Readonly webSocketLifecycle

webSocketLifecycle: WebSocketLifecycle

Methods

Protected clearNamespace

clearNamespace(): void

Inherited from AbstractRequestProcessor.clearNamespace
- Defined in lib/internal/transport/AbstractRequestProcessor.ts:327
Returns void

Protected createAndWrapMessageClient

createAndWrapMessageClient(event: EventIncoming | CommandIncoming, context: HandlerContext & AutomationContextAware): MessageClient & SlackMessageClient

Inherited from AbstractRequestProcessor.createAndWrapMessageClient
- Defined in lib/internal/transport/AbstractRequestProcessor.ts:305
Parameters
- event: EventIncoming | CommandIncoming
- context: HandlerContext & AutomationContextAware
Returns MessageClient & SlackMessageClient

Protected createGraphClient

createGraphClient(event: CommandIncoming | EventIncoming): GraphClient

Overrides AbstractRequestProcessor.createGraphClient
- Defined in lib/internal/transport/websocket/DefaultWebSocketRequestProcessor.ts:97
Parameters
- event: CommandIncoming | EventIncoming
Returns GraphClient

Protected createMessageClient

createMessageClient(event: CommandIncoming | EventIncoming): MessageClient

Overrides AbstractRequestProcessor.createMessageClient
- Defined in lib/internal/transport/websocket/DefaultWebSocketRequestProcessor.ts:103
Parameters
- event: CommandIncoming | EventIncoming
Returns MessageClient

Protected invokeCommand

invokeCommand(ci: CommandInvocation, ctx: HandlerContext & AutomationContextAware, command: CommandIncoming, callback: (result: Promise<HandlerResult>) => void): void

Inherited from AbstractRequestProcessor.invokeCommand
- Defined in lib/internal/transport/AbstractRequestProcessor.ts:189
Parameters
- ci: CommandInvocation
- ctx: HandlerContext & AutomationContextAware
- command: CommandIncoming
- callback: (result: Promise<HandlerResult>) => void
  - - (result: Promise<HandlerResult>): void
    - Parameters
      - result: Promise<HandlerResult>
      Returns void
Returns void

Protected invokeEvent

invokeEvent(ef: EventFired<any>, ctx: HandlerContext & AutomationContextAware, event: EventIncoming, callback: (results: Promise<HandlerResult[]>) => void): void

Inherited from AbstractRequestProcessor.invokeEvent
- Defined in lib/internal/transport/AbstractRequestProcessor.ts:247
Parameters
- ef: EventFired<any>
- ctx: HandlerContext & AutomationContextAware
- event: EventIncoming
- callback: (results: Promise<HandlerResult[]>) => void
  - - (results: Promise<HandlerResult[]>): void
    - Parameters
      - results: Promise<HandlerResult[]>
      Returns void
Returns void

onConnect

onConnect(ws: WebSocket): void

Implementation of WebSocketRequestProcessor.onConnect
- Defined in lib/internal/transport/websocket/DefaultWebSocketRequestProcessor.ts:80
Parameters
- ws: WebSocket
Returns void

onDisconnect

onDisconnect(): void

Implementation of WebSocketRequestProcessor.onDisconnect
- Defined in lib/internal/transport/websocket/DefaultWebSocketRequestProcessor.ts:86
Returns void

onRegistration

onRegistration(registration: RegistrationConfirmation): void

Implementation of WebSocketRequestProcessor.onRegistration
- Defined in lib/internal/transport/websocket/DefaultWebSocketRequestProcessor.ts:73
Parameters
- registration: RegistrationConfirmation
Returns void

processCommand

processCommand(command: CommandIncoming, callback?: (result: Promise<HandlerResult>) => void): void

Inherited from AbstractRequestProcessor.processCommand
- Defined in lib/internal/transport/AbstractRequestProcessor.ts:51
Parameters
- command: CommandIncoming
- Default value callback: (result: Promise<HandlerResult>) => void = () => {}
  - - (result: Promise<HandlerResult>): void
    - Parameters
      - result: Promise<HandlerResult>
      Returns void
Returns void

processEvent

processEvent(event: EventIncoming, callback?: (results: Promise<HandlerResult[]>) => void): void

Inherited from AbstractRequestProcessor.processEvent
- Defined in lib/internal/transport/AbstractRequestProcessor.ts:95
Parameters
- event: EventIncoming
- Default value callback: (results: Promise<HandlerResult[]>) => void = () => {}
  - - (results: Promise<HandlerResult[]>): void
    - Parameters
      - results: Promise<HandlerResult[]>
      Returns void
Returns void

sendCommandStatus

sendCommandStatus(success: boolean, code: number, request: CommandIncoming, ctx: HandlerContext & AutomationContextAware): Promise<any>

Inherited from AbstractRequestProcessor.sendCommandStatus
- Defined in lib/internal/transport/AbstractRequestProcessor.ts:139
Parameters
- success: boolean
- code: number
- request: CommandIncoming
- ctx: HandlerContext & AutomationContextAware
Returns Promise<any>

sendEventStatus

sendEventStatus(success: boolean, request: EventFired<any>, event: EventIncoming, ctx: HandlerContext & AutomationContextAware): Promise<any>

Inherited from AbstractRequestProcessor.sendEventStatus
- Defined in lib/internal/transport/AbstractRequestProcessor.ts:168
Parameters
- success: boolean
- request: EventFired<any>
- event: EventIncoming
- ctx: HandlerContext & AutomationContextAware
Returns Promise<any>

Protected sendStatusMessage

sendStatusMessage(payload: any, ctx: HandlerContext & AutomationContextAware): Promise<any>

Overrides AbstractRequestProcessor.sendStatusMessage
- Defined in lib/internal/transport/websocket/DefaultWebSocketRequestProcessor.ts:91
Parameters
- payload: any
- ctx: HandlerContext & AutomationContextAware
Returns Promise<any>

Protected setupNamespace

setupNamespace(request: any, automations: AutomationServer, invocationId?: string, ts?: number): { correlationId: any; invocationId: string; name: string; operation: any; ts: number; version: string; workspaceId: any; workspaceName: any }

Inherited from AbstractRequestProcessor.setupNamespace
- Defined in lib/internal/transport/AbstractRequestProcessor.ts:311
Parameters
- request: any
- automations: AutomationServer
- Default value invocationId: string = guid()
- Default value ts: number = Date.now()
Returns { correlationId: any; invocationId: string; name: string; operation: any; ts: number; version: string; workspaceId: any; workspaceName: any }
- correlationId: any
- invocationId: string
- name: string
- operation: any
- ts: number
- version: string
- workspaceId: any
- workspaceName: any

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

automations: AutomationServer

configuration: Configuration

Default value listeners: AutomationEventListener[] = []

Returns DefaultWebSocketRequestProcessor

Properties

Protected automations

Protected configuration

Private graphClients

Protected listeners

Private Optional registration

Private Readonly webSocketLifecycle

Methods

Protected clearNamespace

Returns void

Protected createAndWrapMessageClient

Parameters

event: EventIncoming | CommandIncoming

context: HandlerContext & AutomationContextAware

Returns MessageClient & SlackMessageClient

Protected createGraphClient

Parameters

event: CommandIncoming | EventIncoming

Returns GraphClient

Protected createMessageClient

Parameters

event: CommandIncoming | EventIncoming

Returns MessageClient

Protected invokeCommand

Parameters

ci: CommandInvocation

ctx: HandlerContext & AutomationContextAware

command: CommandIncoming

callback: (result: Promise<HandlerResult>) => void

Parameters

result: Promise<HandlerResult>

Returns void

Returns void

Protected invokeEvent

Parameters

ef: EventFired<any>

ctx: HandlerContext & AutomationContextAware

event: EventIncoming

callback: (results: Promise<HandlerResult[]>) => void

Parameters

results: Promise<HandlerResult[]>

Returns void

Returns void

onConnect

Parameters

ws: WebSocket

Returns void

onDisconnect

Returns void

onRegistration

Parameters

registration: RegistrationConfirmation

Returns void

processCommand

Parameters

command: CommandIncoming

Default value callback: (result: Promise<HandlerResult>) => void = () => {}

Parameters

result: Promise<HandlerResult>

Returns void

Returns void

processEvent

Parameters

event: EventIncoming

Default value callback: (results: Promise<HandlerResult[]>) => void = () => {}

Parameters

results: Promise<HandlerResult[]>