Class RascalConfigBuilder

A builder class that builds various rascal config parts for a specific messageType. Multiple builders are used by setupMessagingBroker middleware to generate a complete rascal messaging configuration object.

Hierarchy

RascalConfigBuilder

Constructors

constructor

new RascalConfigBuilder(info, config): RascalConfigBuilder
Parameters
- info: MessagingSettings
  
  an info object that contains general information about message type
- config: MessagingConfig
  
  general RabbitMQ configuration object
Returns RascalConfigBuilder

Properties

`Optional` buildMessageHandler

buildMessageHandler?: ((broker) => MessageHandler<unknown>)

Type declaration

- (broker): MessageHandler<unknown>
- There should not be any need to explicitly call this. This should only be used by setupMessagingBroker or any custom logic that is meant to setup broker and rascal subscriptions, if setupMessagingBroker is not used for some reason.
  Parameters
  - broker: Broker
  Returns MessageHandler<unknown>

`Protected` `Readonly` config

config: MessagingConfig

general RabbitMQ configuration object

`Protected` currentServiceId

currentServiceId: string

`Protected` destinationServiceId

destinationServiceId: string

`Readonly` info

info: MessagingSettings

an info object that contains general information about message type

subscribedEventServiceId

subscribedEventServiceId: undefined | string

Service ID of an event to which the service subscripbes to. Used by the cachePublicSigningKeys to request only relevant public keys from the Key Service.

Only set if subscribeForEvent is called on the builder.

`Private` transformers

transformers: ConfigTransformer = {}

Methods

`Private` addMessagePublication

addMessagePublication(type): void
Parameters
- type: MessageType
Returns void

`Private` addQueue

addQueue(serviceId, queueName): void
Parameters
- serviceId: string
- queueName: string
Returns void

`Private` addRedirectBinding

addRedirectBinding(type, queueName, routingKey): void
Parameters
- type: MessageType
- queueName: string
- routingKey: string
Returns void

`Private` addRetryBinding

addRetryBinding(queueName): void
Parameters
- queueName: string
Returns void

`Private` addSubscription

addSubscription(queueName): void
Parameters
- queueName: string
Returns void

buildConfig

buildConfig(cfg): BrokerConfig
There should not be any need to explicitly call this. This should only be used by setupMessagingBroker or any custom logic that is meant to generate broker config out of builders, if setupMessagingBroker is not used for some reason.
Parameters
- cfg: BrokerConfig
Returns BrokerConfig

`Protected` getSendCommandQueueName

getSendCommandQueueName(): string
Returns string

`Protected` getSubscribeQueueName

getSubscribeQueueName(): string
Returns string

`Protected` getSubscriptionKey

getSubscriptionKey(): string
Returns string

`Private` getVhostReference

getVhostReference(cfg): AssertedVhostConfig
Parameters
- cfg: BrokerConfig
Returns AssertedVhostConfig

publishEvent

publishEvent(): RascalConfigBuilder
Builder extension method to build rascal configuration part to enable publishing events for a specific messageType.

Returns RascalConfigBuilder

sendCommand

sendCommand(): RascalConfigBuilder
Builder extension method to build rascal configuration part, which enables sending commands for a specific messageType.

Returns RascalConfigBuilder

`Private` setBuildMessageHandler

setBuildMessageHandler<TContent>(buildMessageHandler): void
Type Parameters
- TContent
Parameters
- buildMessageHandler: ((broker) => MessageHandler<TContent>)
  - - (broker): MessageHandler<TContent>
    - Parameters
      
      broker: Broker
      
      Returns MessageHandler<TContent>
Returns void

subscribeForCommand

subscribeForCommand<TContent>(buildMessageHandler): RascalConfigBuilder
Builder extension method to build rascal configuration part to enable receiving commands for a specific messageType.
Type Parameters
- TContent
Parameters
- buildMessageHandler: ((broker) => MessageHandler<TContent>)
  
  Function that creates a MessageHandler instance using an instantiated broker. MessageHandler instance is used to create a rascal subscription, which will be calling the handlers onMessage method when receiving a message.
  - - (broker): MessageHandler<TContent>
    - Parameters
      
      broker: Broker
      
      Returns MessageHandler<TContent>
Returns RascalConfigBuilder

subscribeForEvent

subscribeForEvent<TContent>(buildMessageHandler): RascalConfigBuilder
Builder extension method to build rascal configuration part to enable receiving events for a specific messageType.
Type Parameters
- TContent
Parameters
- buildMessageHandler: ((broker) => MessageHandler<TContent>)
  
  Function that creates a MessageHandler instance using an instantiated broker. MessageHandler instance is used to create a rascal subscription, which will be calling the handlers onMessage method when receiving a message.
  - - (broker): MessageHandler<TContent>
    - Parameters
      
      broker: Broker
      
      Returns MessageHandler<TContent>
Returns RascalConfigBuilder

`Private` subscribeForMessage

subscribeForMessage<TContent>(type, buildMessageHandler): RascalConfigBuilder
Type Parameters
- TContent
Parameters
- type: MessageType
- buildMessageHandler: ((broker) => MessageHandler<TContent>)
  - - (broker): MessageHandler<TContent>
    - Parameters
      
      broker: Broker
      
      Returns MessageHandler<TContent>
Returns RascalConfigBuilder

`Static` getDefaultQueueArgs

getDefaultQueueArgs(serviceId): Record<string, string>
Returns an object with default arguments which queues are created with.
Parameters
- serviceId: string
  
  id of the service to which queue will belong to. Used to define dead letter routing key.
Returns Record<string, string>

Class RascalConfigBuilder

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

info: MessagingSettings

config: MessagingConfig

Returns RascalConfigBuilder

Properties

Optional buildMessageHandler

Type declaration

Parameters

broker: Broker

Returns MessageHandler<unknown>

Protected Readonly config

Protected currentServiceId

Protected destinationServiceId

Readonly info

subscribedEventServiceId

Private transformers

Methods

Private addMessagePublication

Parameters

type: MessageType

Returns void

Private addQueue

Parameters

serviceId: string

queueName: string

Returns void

Private addRedirectBinding

Parameters

type: MessageType

queueName: string

routingKey: string

Returns void

Private addRetryBinding

Parameters

queueName: string

Returns void

Private addSubscription

Parameters

queueName: string

Returns void

buildConfig

Parameters

cfg: BrokerConfig

Returns BrokerConfig

Protected getSendCommandQueueName

Returns string

Protected getSubscribeQueueName

Returns string

Protected getSubscriptionKey

Returns string

Private getVhostReference

Parameters

cfg: BrokerConfig

Returns AssertedVhostConfig

publishEvent

Returns RascalConfigBuilder

sendCommand

Returns RascalConfigBuilder

Private setBuildMessageHandler

Type Parameters

TContent

Parameters

buildMessageHandler: ((broker) => MessageHandler<TContent>)

Parameters

broker: Broker

Returns MessageHandler<TContent>

Returns void

subscribeForCommand

Type Parameters

TContent

Parameters

buildMessageHandler: ((broker) => MessageHandler<TContent>)

`Optional` buildMessageHandler

`Protected` `Readonly` config

`Protected` currentServiceId

`Protected` destinationServiceId

`Readonly` info

`Private` transformers

`Private` addMessagePublication

`Private` addQueue

`Private` addRedirectBinding

`Private` addRetryBinding

`Private` addSubscription

`Protected` getSendCommandQueueName

`Protected` getSubscribeQueueName

`Protected` getSubscriptionKey

`Private` getVhostReference

`Private` setBuildMessageHandler

`Private` subscribeForMessage

`Static` getDefaultQueueArgs