An interface that represents a messaging settings object. The RascalConfigBuilder uses those settings to create a Rascal configuration that is used by a message broker.

Hierarchy

  • AxAuthMessagingSettings

Implements

Constructors

  • Parameters

    • messageType: string
    • queue: string
    • routingKey: string
    • action: "event" | "command"
    • aggregateType: string

    Returns AxAuthMessagingSettings

Properties

action: "event" | "command"

If the message is a command or an event

aggregateType: string

Aggregated root type of the message

messageType: string

Unique key that is used by rascal. For convenience it usually resembles the name of the message.

queue: string

Name of the queue which will receive messages of defined message type. RabbitMQ queue will be named using serviceId value and this value, e.g. service-id:queue

routingKey: string

Routing key that is used to redirect messages from exchanges to queues

serviceId: "ax-auth-service" = 'ax-auth-service'

Optional service id value to be used during configuration. Represents destination service id, and not the origin one. If not specified, origin service id will be used (taken from MessagingConfig object).

AxAuthCreateUser: AxAuthMessagingSettings = ...

Defines the messaging settings for the command with message type "AxAuthCreateUser" and aggregate type "user". The aggregate ID field must contain the value of the "user ID" field.

AxAuthCreateUserFailed: AxAuthMessagingSettings = ...

Defines the messaging settings for the event with message type "AxAuthCreateUserFailed" and aggregate type "user". The aggregate ID is not known (yet) so the field contains the value "UNDEFINED_ID".

AxAuthCreateUserFinished: AxAuthMessagingSettings = ...

Defines the messaging settings for the event with message type "AxAuthCreateUserFinished" and aggregate type "user". The aggregate ID field contains the value of the "user ID" field.

AxAuthServiceDisable: AxAuthMessagingSettings = ...

Defines the messaging settings for the command with message type "AxAuthServiceDisable" and aggregate type "environment". The aggregate ID field must contain the value of the "environment ID" field.

AxAuthServiceDisableFailed: AxAuthMessagingSettings = ...

Defines the messaging settings for the event with message type "AxAuthServiceDisableFailed" and aggregate type "environment". The aggregate ID field contains the value of the "environment ID" field.

AxAuthServiceDisableFinished: AxAuthMessagingSettings = ...

Defines the messaging settings for the event with message type "AxAuthServiceDisableFinished" and aggregate type "environment". The aggregate ID field contains the value of the "environment ID" field.

AxAuthServiceEnable: AxAuthMessagingSettings = ...

Defines the messaging settings for the command with message type "AxAuthServiceEnable" and aggregate type "environment". The aggregate ID field must contain the value of the "environment ID" field.

AxAuthServiceEnableFailed: AxAuthMessagingSettings = ...

Defines the messaging settings for the event with message type "AxAuthServiceEnableFailed" and aggregate type "environment". The aggregate ID field contains the value of the "environment ID" field.

AxAuthServiceEnableFinished: AxAuthMessagingSettings = ...

Defines the messaging settings for the event with message type "AxAuthServiceEnableFinished" and aggregate type "environment". The aggregate ID field contains the value of the "environment ID" field.

UpdateOAuthRegistration: AxAuthMessagingSettings = ...

Defines the messaging settings for the command with message type "UpdateOAuthRegistration" and aggregate type "oauth-client". The aggregate ID field must contain the value of the "client ID" field.

UpdateOAuthRegistrationFailed: AxAuthMessagingSettings = ...

Defines the messaging settings for the event with message type "UpdateOAuthRegistrationFailed" and aggregate type "oauth-client". The aggregate ID field contains the value of the "environment ID" field.

UpdateOAuthRegistrationFinished: AxAuthMessagingSettings = ...

Defines the messaging settings for the event with message type "UpdateOAuthRegistrationFinished" and aggregate type "oauth-client". The aggregate ID field contains the value of the "environment ID" field.

Methods

  • Returns string

Generated using TypeDoc