Class IdServiceMultiTenantMessagingSettings

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

Constructors

`Private` constructor

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

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` DeleteServiceAccount

DeleteServiceAccount: IdServiceMultiTenantMessagingSettings = ...

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

`Static` DeleteUser

DeleteUser: IdServiceMultiTenantMessagingSettings = ...

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

`Static` DeleteUserRole

DeleteUserRole: IdServiceMultiTenantMessagingSettings = ...

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

`Static` ServiceAccountDeleteFailed

ServiceAccountDeleteFailed: IdServiceMultiTenantMessagingSettings = ...

Defines the messaging settings for the event with message type "ServiceAccountDeleteFailed" and aggregate type "service-account". The aggregate ID field contains the value of the "client ID" field.

`Static` ServiceAccountDeleteFinished

ServiceAccountDeleteFinished: IdServiceMultiTenantMessagingSettings = ...

Defines the messaging settings for the event with message type "ServiceAccountDeleteFinished" and aggregate type "service-account". The aggregate ID field contains the value of the "client ID" field.

`Static` ServiceAccountPermissionChanged

ServiceAccountPermissionChanged: IdServiceMultiTenantMessagingSettings = ...

Defines the messaging settings for the event with message type "ServiceAccountPermissionChanged" and aggregate type "service-account". The aggregate ID field contains the value of the "client ID" field.

`Static` SynchronizePermissions

SynchronizePermissions: IdServiceMultiTenantMessagingSettings = ...

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

`Static` SynchronizePermissionsFailed

SynchronizePermissionsFailed: IdServiceMultiTenantMessagingSettings = ...

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

`Static` SynchronizePermissionsFinished

SynchronizePermissionsFinished: IdServiceMultiTenantMessagingSettings = ...

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

`Static` UserDeleteFailed

UserDeleteFailed: IdServiceMultiTenantMessagingSettings = ...

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

`Static` UserDeleteFinished

UserDeleteFinished: IdServiceMultiTenantMessagingSettings = ...

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

`Static` UserRoleAssignmentChanged

UserRoleAssignmentChanged: IdServiceMultiTenantMessagingSettings = ...

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

`Static` UserRoleDeleteFailed

UserRoleDeleteFailed: IdServiceMultiTenantMessagingSettings = ...

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

`Static` UserRoleDeleteFinished

UserRoleDeleteFinished: IdServiceMultiTenantMessagingSettings = ...

Defines the messaging settings for the event with message type "UserRoleDeleteFinished" and aggregate type "user-role". The aggregate ID field contains the value of the "user role 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 IdServiceMultiTenantMessagingSettings

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Private constructor

Parameters

messageType: string

queue: string

routingKey: string

action: "event" | "command"

aggregateType: string

Returns IdServiceMultiTenantMessagingSettings

Properties

Readonly action

Readonly aggregateType

Readonly messageType

Readonly queue

Readonly routingKey

Readonly serviceId

Static DeleteServiceAccount

Static DeleteUser

Static DeleteUserRole

Static ServiceAccountDeleteFailed

Static ServiceAccountDeleteFinished

Static ServiceAccountPermissionChanged

Static SynchronizePermissions

Static SynchronizePermissionsFailed

Static SynchronizePermissionsFinished

Static UserDeleteFailed

Static UserDeleteFinished

Static UserRoleAssignmentChanged

Static UserRoleDeleteFailed

Static UserRoleDeleteFinished

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` DeleteServiceAccount

`Static` DeleteUser

`Static` DeleteUserRole

`Static` ServiceAccountDeleteFailed

`Static` ServiceAccountDeleteFinished

`Static` ServiceAccountPermissionChanged

`Static` SynchronizePermissions

`Static` SynchronizePermissionsFailed

`Static` SynchronizePermissionsFinished

`Static` UserDeleteFailed

`Static` UserDeleteFinished

`Static` UserRoleAssignmentChanged

`Static` UserRoleDeleteFailed

`Static` UserRoleDeleteFinished

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