Custom Messaging Provider

Learn about using the custom messaging provider for a tenant.

Custom Messaging Provider Overview

Custom messaging destination provider functionality for a tenant is now in DTSS. This is a dedicated API that provides the ability to overwrite the tenant messaging provider for DTSS queues as well as verification (as for Data Tenant/Customer Tenant/Subscription). If you do not set up the custom provider, then legacy behavior is preserved.

Setting Up the Custom Message Provider

Procedure One: Add the endpoints given in steps 1 through 6 to set up the messaging provider configuration in DTSS.

  1. GET /dtss/tenants/messaging (get for all tenants)
    [
     {
       "tenantId": "dataTenant1",
       "provider": "google"
     },
     {
       "tenantId": "customerTenant1",
       "provider": "activemq"
     },
     {
       "tenantId": "dataTenant13",
       "provider": "sqs"
     }
    ]
  2. POST /dtss/tenants/messaging (add/overwrite for tenants present in the JSON)
    [
     {
       "tenantId": "dataTenant1",
       "provider": "google"
     },
     {
       "tenantId": "customerTenant1",
       "provider": "activemq"
     },
     {
       "tenantId": "dataTenant13",
       "provider": "sqs"
     }
    ]
    
  3. DELETE /dtss/tenants/messaging (delete for tenants present in the JSON)
    [
     "dataTenant1",
     "dataTenant2",
     "customerTenant1"
    ]
  4. GET /dtss/tenants/messaging/dataTenant1 (get for a specific tenant)
    {
     "tenantId": "dataTenant1",
     "provider": "google"
    }
  5. POST /dtss/tenants/messaging/dataTenant1 (add/overwrite for a specific tenant)
    sqs (Text body. Only provider name)
  6. DELETE /dtss/tenants/messaging/dataTenant1 (delete for a specific tenant)
Procedure Two: If there is no appropriate/expected messaging destination available for the tenant, and while adding a new destination for the tenant, the system should check for the messaging provider configuration for the tenant using the below Rest API.
GET /dtss/tenants/messaging/dataTenant1
  • If there is a messaging provider configuration available for the tenant, then the system should use the provider given in the configuration to add the messaging destination.
  • If there is no messaging provider configuration available for the tenant, then the system uses the default provider as it is currently working.
  • If any error message is given in the response.