Package io.axoniq.framework.messaging.multitenancy.deadletter

Class TenantRoutingSequencedDeadLetterQueueRegistry

java.lang.Object
io.axoniq.framework.messaging.multitenancy.deadletter.TenantRoutingSequencedDeadLetterQueueRegistry
All Implemented Interfaces:
MultiTenantAwareComponent, DescribableComponent
@Internal public class TenantRoutingSequencedDeadLetterQueueRegistry extends Object implements MultiTenantAwareComponent
Owns the tenant lifecycle and tenant-specific dead-letter queues created by routing queue factories.
Since:
5.4.0
Author:
Jan Galinski

  • Constructor Details

    • TenantRoutingSequencedDeadLetterQueueRegistry

      public TenantRoutingSequencedDeadLetterQueueRegistry()

  • Method Details

    • queueFor

      public SequencedDeadLetterQueue<EventMessage> queueFor(String processorName, Configuration configuration, TenantAwareSequencedDeadLetterQueueFactory factory, TenantDescriptor tenant)
      Returns the queue of the given tenant for the dead-letter queue identified by the supplied processing group, configuration, and delegate factory.

      The queue cache is created lazily and registered with every tenant known to this registry before it is used. Cache creation is synchronized with tenant registration and removal, so a new cache cannot escape a concurrent tenant removal. The tenant-specific lookup itself remains concurrent.

      Parameters:
      processorName - the processor owning the queue
      configuration - the configuration passed to the delegate factory
      factory - the factory creating a tenant's underlying queue
      tenant - the registered tenant whose queue to return
      Returns:
      the tenant's queue

    • registerTenant

      public Registration registerTenant(TenantDescriptor tenantDescriptor)
      Description copied from interface: MultiTenantAwareComponent
      Registers the given tenantDescriptor as a known tenant with this multi-tenant aware component.

      The caller must retain the returned Registration and cancel it when the tenant is removed, since releasing the component's per-tenant resources rides on that cancellation.

      Specified by:
      registerTenant in interface MultiTenantAwareComponent
      Parameters:
      tenantDescriptor - The TenantDescriptor to register with this component.
      Returns:
      A Registration used to deregister the given tenantDescriptor.

    • registerAndStartTenant

      public Registration registerAndStartTenant(TenantDescriptor tenantDescriptor)
      Description copied from interface: MultiTenantAwareComponent
      Registers the given tenantDescriptor as a known tenant with this multi-tenant aware component. If applicable, this task will construct a tenant segment and start it.
      Specified by:
      registerAndStartTenant in interface MultiTenantAwareComponent
      Parameters:
      tenantDescriptor - The TenantDescriptor to register with this component.
      Returns:
      A Registration used to deregister the given tenantDescriptor.

    • describeTo

      public void describeTo(ComponentDescriptor descriptor)
      Description copied from interface: DescribableComponent
      Describe the properties of this DescribableComponent with the given descriptor.

      Components should call the appropriate describeProperty methods on the descriptor to register their properties. The descriptor is responsible for determining how these properties are formatted and structured in the final output.

      Best Practices: As a general rule, all relevant fields of a DescribableComponent implementation should be described in this method. However, developers have discretion to include only the fields that make sense in the context. Not every field may be meaningful for description purposes, especially internal implementation details. Furthermore, components might want to expose different information based on their current state. The final decision on what properties to include lies with the person implementing the describeTo method, who should focus on providing information that is useful for understanding the component's configuration and state.

      Example implementation: 

       public void describeTo(ComponentDescriptor descriptor) {
     descriptor.describeProperty("name", this.name);
     descriptor.describeProperty("enabled", this.enabled);
     descriptor.describeProperty("configuration", this.configuration); // A nested component
     descriptor.describeProperty("handlers", this.eventHandlers);      // A collection
 }
      Specified by:
      describeTo in interface DescribableComponent
      Parameters:
      descriptor - The component descriptor to describe this DescribableComponentn its properties in.