Axinom Mosaic Libraries
    Preparing search index...

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

    Index

    Properties

    action aggregateType messageType queue routingKey serviceId DeleteServiceAccount DeleteUser DeleteUserRole ServiceAccountDeleteFailed ServiceAccountDeleteFinished ServiceAccountPermissionChanged SynchronizePermissions SynchronizePermissionsFailed SynchronizePermissionsFinished UserDeleteFailed UserDeleteFinished UserRoleAssignmentChanged UserRoleDeleteFailed UserRoleDeleteFinished

    Methods

    getEnvironmentRoutingKey toString

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

    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.

    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.

    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.

    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.

    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.

    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.

    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.

    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.

    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.

    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.

    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.

    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.

    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.

    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

    • Returns a tenant and environment scoped routing key which can be used when publishing a multi-tenant message.

      Parameters

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

      Returns string

    • Returns string

    Settings

    Member Visibility

    On This Page

    Properties
    Methods