Class RascalTransactionalConfigBuilder

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 (View Summary)

RascalConfigBuilder
- RascalTransactionalConfigBuilder

Index

Constructors

constructor

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

Properties

`Optional`buildMessageHandler

buildMessageHandler?: (broker: BrokerProxy) => 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.

`Protected` `Readonly`config

config: MessagingConfig

`Protected`currentServiceId

currentServiceId: string

`Protected`destinationServiceId

destinationServiceId: string

`Readonly`info

info: MessagingSettings

subscribedEventServiceId

subscribedEventServiceId: string | undefined

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.

Methods

buildConfig

buildConfig(cfg: BrokerConfig): 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
Inherited from RascalConfigBuilder.buildConfig

`Protected`getSendCommandQueueName

getSendCommandQueueName(): string
Returns string
Overrides RascalConfigBuilder.getSendCommandQueueName

`Protected`getSubscribeQueueName

getSubscribeQueueName(): string
Returns string
Overrides RascalConfigBuilder.getSubscribeQueueName

`Protected`getSubscriptionKey

getSubscriptionKey(): string
Returns string
Overrides RascalConfigBuilder.getSubscriptionKey

publishEvent

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

Returns RascalConfigBuilder
Inherited from RascalConfigBuilder.publishEvent

sendCommand

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

Returns RascalConfigBuilder
Inherited from RascalConfigBuilder.sendCommand

subscribeForCommand

subscribeForCommand<TContent>(
buildMessageHandler: (broker: BrokerProxy) => MessageHandler<TContent>,
): RascalConfigBuilder
Builder extension method to build rascal configuration part to enable receiving commands for a specific messageType.
Type Parameters
- TContent
Parameters
- buildMessageHandler: (broker: BrokerProxy) => 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.
Returns RascalConfigBuilder
Inherited from RascalConfigBuilder.subscribeForCommand

subscribeForEvent

subscribeForEvent<TContent>(
buildMessageHandler: (broker: BrokerProxy) => MessageHandler<TContent>,
): RascalConfigBuilder
Builder extension method to build rascal configuration part to enable receiving events for a specific messageType.
Type Parameters
- TContent
Parameters
- buildMessageHandler: (broker: BrokerProxy) => 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.
Returns RascalConfigBuilder
Inherited from RascalConfigBuilder.subscribeForEvent

`Static`getDefaultQueueArgs

getDefaultQueueArgs(serviceId: string): 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>
Inherited from RascalConfigBuilder.getDefaultQueueArgs

Class RascalTransactionalConfigBuilder

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns RascalTransactionalConfigBuilder

Properties

OptionalbuildMessageHandler

Protected Readonlyconfig

ProtectedcurrentServiceId

ProtecteddestinationServiceId

Readonlyinfo

subscribedEventServiceId

Methods

buildConfig

Parameters

Returns BrokerConfig

ProtectedgetSendCommandQueueName

Returns string

ProtectedgetSubscribeQueueName

Returns string

ProtectedgetSubscriptionKey

Returns string

publishEvent

Returns RascalConfigBuilder

sendCommand

Returns RascalConfigBuilder

subscribeForCommand

Type Parameters

Parameters

Returns RascalConfigBuilder

subscribeForEvent

Type Parameters

Parameters

Returns RascalConfigBuilder

StaticgetDefaultQueueArgs

Parameters

Returns Record<string, string>

Settings

On This Page

`Optional`buildMessageHandler

`Protected` `Readonly`config

`Protected`currentServiceId

`Protected`destinationServiceId

`Readonly`info

`Protected`getSendCommandQueueName

`Protected`getSubscribeQueueName

`Protected`getSubscriptionKey

`Static`getDefaultQueueArgs