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

Constructors

constructor

Properties

addMessagePublication addQueue addRedirectBinding addRetryBinding addSubscription buildMessageHandler? config currentServiceId destinationServiceId getVhostReference info setBuildMessageHandler subscribeForMessage subscribedEventServiceId transformers

Methods

buildConfig getSendCommandQueueName getSubscribeQueueName getSubscriptionKey publishEvent sendCommand subscribeForCommand subscribeForEvent getDefaultQueueArgs

Constructors

constructor

Properties

Private addMessagePublication

addMessagePublication: any

Private addQueue

addQueue: any

Private addRedirectBinding

addRedirectBinding: any

Private addRetryBinding

addRetryBinding: any

Private addSubscription

addSubscription: any

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

      Returns MessageHandler<unknown>

Protected Readonly config

config: MessagingConfig

Protected currentServiceId

currentServiceId: string

Protected destinationServiceId

destinationServiceId: string

Private getVhostReference

getVhostReference: any

Readonly info

info: MessagingSettings

Private setBuildMessageHandler

setBuildMessageHandler: any

Private subscribeForMessage

subscribeForMessage: any

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: any

Methods

buildConfig

  • 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

  • Returns string

Protected getSubscribeQueueName

  • Returns string

Protected getSubscriptionKey

  • Returns string

publishEvent

sendCommand

subscribeForCommand

  • 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.

    Returns RascalConfigBuilder

subscribeForEvent

  • 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.

    Returns RascalConfigBuilder

Static getDefaultQueueArgs

  • 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>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc