Class BuildableAutomationServer

Simple automation server that offers building style configuration

Hierarchy

AbstractAutomationServer
- BuildableAutomationServer

Implements

AutomationServer

Constructors

constructor

new BuildableAutomationServer(opts: Configuration): BuildableAutomationServer

- Defined in lib/server/BuildableAutomationServer.ts:83
Parameters
- opts: Configuration
Returns BuildableAutomationServer

Properties

Private Readonly commandHandlers

commandHandlers: CommandHandlerRegistration[] = []

Private Readonly eventHandlers

eventHandlers: EventHandlerRegistration[] = []

Private Readonly ingesters

ingesters: string[] = []

Private Readonly metadataProcessor

metadataProcessor: AutomationMetadataProcessor = new PassThroughMetadataProcessor()

opts

opts: Configuration

Private Readonly secretResolver

secretResolver: SecretResolver = new NodeConfigSecretResolver()

Accessors

automations

get automations(): Automations

Overrides AbstractAutomationServer.automations
- Defined in lib/server/BuildableAutomationServer.ts:292
Returns Automations

Methods

Private enrichContext

enrichContext(ctx: HandlerContext): HandlerContext

- Defined in lib/server/BuildableAutomationServer.ts:224
Parameters
- ctx: HandlerContext
Returns HandlerContext

fromCommandHandler

fromCommandHandler<P>(hc: HandleCommand<P>): this

- Defined in lib/server/BuildableAutomationServer.ts:117
Type parameters
- P
Parameters
- hc: HandleCommand<P>
Returns this

invokeCommand

invokeCommand(payload: CommandInvocation, ctx: HandlerContext): Promise<HandlerResult>

Implementation of AutomationServer.invokeCommand

Inherited from AbstractAutomationServer.invokeCommand
- Defined in lib/server/AbstractAutomationServer.ts:28
Parameters
- payload: CommandInvocation
- ctx: HandlerContext
Returns Promise<HandlerResult>

Protected invokeCommandHandler

invokeCommandHandler(invocation: CommandInvocation, metadata: CommandHandlerMetadata, ctx: HandlerContext): Promise<HandlerResult>

Overrides AbstractAutomationServer.invokeCommandHandler
- Defined in lib/server/BuildableAutomationServer.ts:150
Parameters
- invocation: CommandInvocation
- metadata: CommandHandlerMetadata
- ctx: HandlerContext
Returns Promise<HandlerResult>

Private invokeCommandHandlerWithFreshParametersInstance

invokeCommandHandlerWithFreshParametersInstance<P>(h: HandleCommand<P>, md: CommandHandlerMetadata, params: P, invocation: CommandInvocation, ctx: HandlerContext): Promise<HandlerResult>

- Defined in lib/server/BuildableAutomationServer.ts:167
Populate handler parameters

Type parameters
- P
Parameters
- h: HandleCommand<P>
- md: CommandHandlerMetadata
- params: P
- invocation: CommandInvocation
- ctx: HandlerContext
Returns Promise<HandlerResult>

Protected invokeEventHandler

invokeEventHandler(e: EventFired<any>, metadata: EventHandlerMetadata, ctx: HandlerContext): Promise<HandlerResult>

Overrides AbstractAutomationServer.invokeEventHandler
- Defined in lib/server/BuildableAutomationServer.ts:157
Parameters
- e: EventFired<any>
- metadata: EventHandlerMetadata
- ctx: HandlerContext
Returns Promise<HandlerResult>

Private invokeFreshEventHandlerInstance

invokeFreshEventHandlerInstance(h: HandleEvent<any>, metadata: EventHandlerMetadata, e: EventFired<any>, ctx: HandlerContext): Promise<HandlerResult>

- Defined in lib/server/BuildableAutomationServer.ts:203
Parameters
- h: HandleEvent<any>
- metadata: EventHandlerMetadata
- e: EventFired<any>
- ctx: HandlerContext
Returns Promise<HandlerResult>

onEvent

onEvent(payload: EventFired<any>, ctx: HandlerContext): Promise<HandlerResult[]>

Implementation of AutomationServer.onEvent

Inherited from AbstractAutomationServer.onEvent
- Defined in lib/server/AbstractAutomationServer.ts:33
Parameters
- payload: EventFired<any>
- ctx: HandlerContext
Returns Promise<HandlerResult[]>

Private populateMappedParameters

populateMappedParameters(h: {}, metadata: CommandHandlerMetadata, invocation: Invocation): void

- Defined in lib/server/BuildableAutomationServer.ts:230
Parameters
- h: {}
- metadata: CommandHandlerMetadata
- invocation: Invocation
Returns void

Private populateSecrets

populateSecrets(h: {}, metadata: SecretsMetadata, invocationSecrets: Secret[] | undefined): void

- Defined in lib/server/BuildableAutomationServer.ts:263
Parameters
- h: {}
- metadata: SecretsMetadata
- invocationSecrets: Secret[] | undefined
Returns void

registerCommandHandler

registerCommandHandler(chm: Maker<HandleCommand>): this

- Defined in lib/server/BuildableAutomationServer.ts:97
Parameters
- chm: Maker<HandleCommand>
Returns this

registerEventHandler

registerEventHandler(maker: Maker<HandleEvent<any>>): this

- Defined in lib/server/BuildableAutomationServer.ts:129
Parameters
- maker: Maker<HandleEvent<any>>
Returns this

registerIngester

registerIngester(ingester: any): this

- Defined in lib/server/BuildableAutomationServer.ts:145
Parameters
- ingester: any
Returns this

validateCommandInvocation

validateCommandInvocation(payload: CommandInvocation): CommandHandlerMetadata

Implementation of AutomationServer.validateCommandInvocation

Inherited from AbstractAutomationServer.validateCommandInvocation
- Defined in lib/server/AbstractAutomationServer.ts:43
Parameters
- payload: CommandInvocation
Returns CommandHandlerMetadata

Generated using TypeDoc