Class LocalizationServiceMultiTenantMessagingSettings

An interface that represents a messaging settings object for multitenant Managed services. Used to build Rascal config using RascalConfigBuilder to be used by a messaging broker.

Hierarchy

MultiTenantMessagingSettings
- LocalizationServiceMultiTenantMessagingSettings

Constructors

`Private` constructor

new LocalizationServiceMultiTenantMessagingSettings(messageType, queue, routingKey, action, aggregateType): LocalizationServiceMultiTenantMessagingSettings
Parameters
- messageType: string
- queue: string
- routingKey: string
- action: "event" | "command"
- aggregateType: string
Returns LocalizationServiceMultiTenantMessagingSettings

Overrides MultiTenantMessagingSettings.constructor

Properties

`Readonly` action

action: "event" | "command"

If the message is a command or an event

`Readonly` aggregateType

aggregateType: string

Aggregated root type of the message

`Readonly` messageType

messageType: string

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

`Readonly` queue

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

`Readonly` routingKey

routingKey: string

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

`Readonly` serviceId

serviceId: string

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

`Static` DeclareEntityDefinition

DeclareEntityDefinition: LocalizationServiceMultiTenantMessagingSettings = ...

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

`Static` DeleteEntityDefinition

DeleteEntityDefinition: LocalizationServiceMultiTenantMessagingSettings = ...

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

`Static` DeleteLocalizationSourceEntity

DeleteLocalizationSourceEntity: LocalizationServiceMultiTenantMessagingSettings = ...

Defines the messaging settings for the command with message type "DeleteLocalizationSourceEntity" and aggregate type "localization-source-entity". The aggregate ID field must contain the value of the "entity ID" field.

`Static` DeleteLocalizationSourceEntityFailed

DeleteLocalizationSourceEntityFailed: LocalizationServiceMultiTenantMessagingSettings = ...

Defines the messaging settings for the event with message type "DeleteLocalizationSourceEntityFailed" and aggregate type "localization-source-entity". The aggregate ID field contains the value of the "entity ID" field.

`Static` DeleteLocalizationSourceEntityFinished

DeleteLocalizationSourceEntityFinished: LocalizationServiceMultiTenantMessagingSettings = ...

Defines the messaging settings for the event with message type "DeleteLocalizationSourceEntityFinished" and aggregate type "localization-source-entity". The aggregate ID field contains the value of the "entity ID" field.

`Static` EntityDefinitionDeclareFailed

EntityDefinitionDeclareFailed: LocalizationServiceMultiTenantMessagingSettings = ...

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

`Static` EntityDefinitionDeclareFinished

EntityDefinitionDeclareFinished: LocalizationServiceMultiTenantMessagingSettings = ...

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

`Static` EntityDefinitionDeleteFailed

EntityDefinitionDeleteFailed: LocalizationServiceMultiTenantMessagingSettings = ...

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

`Static` EntityDefinitionDeleteFinished

EntityDefinitionDeleteFinished: LocalizationServiceMultiTenantMessagingSettings = ...

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

`Static` LocalizeEntity

LocalizeEntity: LocalizationServiceMultiTenantMessagingSettings = ...

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

`Static` LocalizeEntityFailed

LocalizeEntityFailed: LocalizationServiceMultiTenantMessagingSettings = ...

Defines the messaging settings for the event with message type "LocalizeEntityFailed" and aggregate type "localization". The aggregate ID field contains the value of the "entity ID" field.

`Static` LocalizeEntityFinished

LocalizeEntityFinished: LocalizationServiceMultiTenantMessagingSettings = ...

Defines the messaging settings for the event with message type "LocalizeEntityFinished" and aggregate type "localization". The aggregate ID field contains the value of the "entity ID" field.

`Static` UpsertLocalizationSourceEntity

UpsertLocalizationSourceEntity: LocalizationServiceMultiTenantMessagingSettings = ...

Defines the messaging settings for the command with message type "UpsertLocalizationSourceEntity" and aggregate type "localization-source-entity". The aggregate ID field must contain the value of the "entity ID" field.

`Static` UpsertLocalizationSourceEntityFailed

UpsertLocalizationSourceEntityFailed: LocalizationServiceMultiTenantMessagingSettings = ...

Defines the messaging settings for the event with message type "UpsertLocalizationSourceEntityFailed" and aggregate type "localization-source-entity". The aggregate ID field contains the value of the "entity ID" field.

`Static` UpsertLocalizationSourceEntityFinished

UpsertLocalizationSourceEntityFinished: LocalizationServiceMultiTenantMessagingSettings = ...

Defines the messaging settings for the event with message type "UpsertLocalizationSourceEntityFinished" and aggregate type "localization-source-entity". The aggregate ID field contains the value of the "entity ID" field.

Methods

getEnvironmentRoutingKey

getEnvironmentRoutingKey(environmentInfo): string
Returns a tenant and environment scoped routing key which can be used when publishing a multi-tenant message.
Parameters
- environmentInfo: {
  environmentId: string;
  tenantId: string;
  }
  - environmentId: string
  - tenantId: string
Returns string

Inherited from MultiTenantMessagingSettings.getEnvironmentRoutingKey

toString

toString(): string
Returns string

Class LocalizationServiceMultiTenantMessagingSettings

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Private constructor

Parameters

messageType: string

queue: string

routingKey: string

action: "event" | "command"

aggregateType: string

Returns LocalizationServiceMultiTenantMessagingSettings

Properties

Readonly action

Readonly aggregateType

Readonly messageType

Readonly queue

Readonly routingKey

Readonly serviceId

Static DeclareEntityDefinition

Static DeleteEntityDefinition

Static DeleteLocalizationSourceEntity

Static DeleteLocalizationSourceEntityFailed

Static DeleteLocalizationSourceEntityFinished

Static EntityDefinitionDeclareFailed

Static EntityDefinitionDeclareFinished

Static EntityDefinitionDeleteFailed

Static EntityDefinitionDeleteFinished

Static LocalizeEntity

Static LocalizeEntityFailed

Static LocalizeEntityFinished

Static UpsertLocalizationSourceEntity

Static UpsertLocalizationSourceEntityFailed

Static UpsertLocalizationSourceEntityFinished

Methods

getEnvironmentRoutingKey

Parameters

environmentInfo: { environmentId: string; tenantId: string; }

environmentId: string

tenantId: string

Returns string

toString

Returns string

Settings

Member Visibility

Theme

On This Page

`Private` constructor

`Readonly` action

`Readonly` aggregateType

`Readonly` messageType

`Readonly` queue

`Readonly` routingKey

`Readonly` serviceId

`Static` DeclareEntityDefinition

`Static` DeleteEntityDefinition

`Static` DeleteLocalizationSourceEntity

`Static` DeleteLocalizationSourceEntityFailed

`Static` DeleteLocalizationSourceEntityFinished

`Static` EntityDefinitionDeclareFailed

`Static` EntityDefinitionDeclareFinished

`Static` EntityDefinitionDeleteFailed

`Static` EntityDefinitionDeleteFinished

`Static` LocalizeEntity

`Static` LocalizeEntityFailed

`Static` LocalizeEntityFinished

`Static` UpsertLocalizationSourceEntity

`Static` UpsertLocalizationSourceEntityFailed

`Static` UpsertLocalizationSourceEntityFinished

environmentInfo: {
environmentId: string;
tenantId: string;
}