AutomationClient | @atomist/automation-client

Hierarchy

AutomationClient

Implements

RequestProcessor

Index

Constructors

constructor

Properties

Accessors

automationServer

Methods

Constructors

constructor

new AutomationClient(configuration: Configuration): AutomationClient

- Defined in lib/automationClient.ts:49
Parameters
- configuration: Configuration
Returns AutomationClient

Properties

automations

automations: BuildableAutomationServer

configuration

configuration: Configuration

Private Readonly defaultListeners

defaultListeners: AutomationEventListener[] = [new MetricEnabledAutomationEventListener(),new EventStoringAutomationEventListener(),new StartupMessageAutomationEventListener(),new StartupTimeMessageUatomationEventListener(),]

httpHandler

httpHandler: RequestProcessor

httpServer

httpServer: any

requestProcessor

requestProcessor: RequestProcessor

webSocketClient

webSocketClient: any

webSocketHandler

webSocketHandler: RequestProcessor

Accessors

automationServer

get automationServer(): AutomationServer

- Defined in lib/automationClient.ts:56
Returns AutomationServer

Methods

Private configureRedactions

configureRedactions(): void

- Defined in lib/automationClient.ts:158
Returns void

Private configureShutdown

configureShutdown(): void

- Defined in lib/automationClient.ts:178
Returns void

Private configureStatsd

configureStatsd(): void

- Defined in lib/automationClient.ts:183
Returns void

processCommand

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

- Defined in lib/automationClient.ts:75
Parameters
- command: CommandIncoming
- Optional 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

- Defined in lib/automationClient.ts:87
Parameters
- event: EventIncoming
- Optional callback: (results: Promise<HandlerResult[]>) => void
  - - (results: Promise<HandlerResult[]>): void
    - Parameters
      - results: Promise<HandlerResult[]>
      Returns void
Returns void

Private raiseStartupEvent

raiseStartupEvent(): Promise<void>

- Defined in lib/automationClient.ts:172
Returns Promise<void>

run

run(): Promise<void>

- Defined in lib/automationClient.ts:99
Returns Promise<void>

Private runHttp

runHttp(handlerMaker: () => RequestProcessor): Promise<any>

- Defined in lib/automationClient.ts:233
Parameters
- handlerMaker: () => RequestProcessor
  - - (): RequestProcessor
    - Returns RequestProcessor
Returns Promise<any>

Private runWs

runWs(handlerMaker: () => RequestProcessor): Promise<void>

- Defined in lib/automationClient.ts:215
Parameters
- handlerMaker: () => RequestProcessor
  - - (): RequestProcessor
    - Returns RequestProcessor
Returns Promise<void>

Private setupExpressRequestHandler

setupExpressRequestHandler(): RequestProcessor

- Defined in lib/automationClient.ts:209
Returns RequestProcessor

Private setupWebSocketClusterRequestHandler

setupWebSocketClusterRequestHandler(): RequestProcessor

- Defined in lib/automationClient.ts:190
Returns RequestProcessor

Private setupWebSocketClusterWorkerRequestHandler

setupWebSocketClusterWorkerRequestHandler(): RequestProcessor

- Defined in lib/automationClient.ts:197
Returns RequestProcessor

Private setupWebSocketRequestHandler

setupWebSocketRequestHandler(): RequestProcessor

- Defined in lib/automationClient.ts:203
Returns RequestProcessor

withCommandHandler

withCommandHandler(chm: Maker<HandleCommand>): AutomationClient

- Defined in lib/automationClient.ts:60
Parameters
- chm: Maker<HandleCommand>
Returns AutomationClient

withEventHandler

withEventHandler(event: Maker<HandleEvent<any>>): AutomationClient

- Defined in lib/automationClient.ts:65
Parameters
- event: Maker<HandleEvent<any>>
Returns AutomationClient

withIngester

withIngester(ingester: string): AutomationClient

- Defined in lib/automationClient.ts:70
Parameters
- ingester: string
Returns AutomationClient

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

configuration: Configuration

Returns AutomationClient

Properties

automations

configuration

Private Readonly defaultListeners

httpHandler

httpServer

requestProcessor

webSocketClient

webSocketHandler

Accessors

automationServer

Returns AutomationServer

Methods

Private configureRedactions

Returns void

Private configureShutdown

Returns void

Private configureStatsd

Returns void

processCommand

Parameters

command: CommandIncoming

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

Parameters

result: Promise<HandlerResult>

Returns void

Returns void

processEvent

Parameters

event: EventIncoming

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

Parameters

results: Promise<HandlerResult[]>

Returns void

Returns void

Private raiseStartupEvent

Returns Promise<void>

run

Returns Promise<void>

Private runHttp

Parameters

handlerMaker: () => RequestProcessor

Returns RequestProcessor

Returns Promise<any>

Private runWs

Parameters

handlerMaker: () => RequestProcessor

Returns RequestProcessor

Returns Promise<void>

Private setupExpressRequestHandler

Returns RequestProcessor

Private setupWebSocketClusterRequestHandler

Returns RequestProcessor

Private setupWebSocketClusterWorkerRequestHandler

Returns RequestProcessor

Private setupWebSocketRequestHandler

Returns RequestProcessor

withCommandHandler

Parameters

chm: Maker<HandleCommand>

Returns AutomationClient

withEventHandler

Parameters

event: Maker<HandleEvent<any>>

Returns AutomationClient

withIngester

Parameters

ingester: string