Package io.axoniq.framework.messaging.multitenancy.api

Interface TenantResolver

All Known Implementing Classes:

MetadataBasedTenantResolver

public interface TenantResolver

Resolves the target tenant of a given Message, and attaches a tenant to a Message in the inverse direction.

A message dispatched from within a handler generally does not name its own tenant: the tenant is only known through the ProcessingContext of the message being handled. attachTenant(Message, TenantDescriptor) is what makes that tenant survive the message being dispatched elsewhere, for example across a distributed command or query bus that carries the message to another process and back. A resolver that only resolves, and never attaches, silently drops the tenant on every such dispatch, with no signal that anything is missing until a receiving component fails to resolve a tenant it should have had.

Since:

4.6.0

Author:

Stefan Dragisic, Jan Galinski, Jakob Hatzl

Method Summary

Modifier and Type	Method	Description
Message	attachTenant(Message message, TenantDescriptor tenant)	Returns a copy of the given message carrying the given tenant, the inverse of resolveTenant(Message, Collection): where that method determines the tenant a message belongs to, this one makes that determination survive the message being dispatched elsewhere.
default TenantDescriptor	resolveTenant(Message message)	Returns TenantDescriptor for the given message.
TenantDescriptor	resolveTenant(Message message, Collection<TenantDescriptor> tenants)	Returns TenantDescriptor for the given message.

Method Details

resolveTenant

TenantDescriptor resolveTenant(Message message,
 Collection<TenantDescriptor> tenants)
                        throws TenantNotResolvedException

Returns TenantDescriptor for the given message.

Parameters:

message - the Message implementation to resolve the target tenant for

tenants - the collection of tenants to resolve the target tenant from

Returns:

the resolved TenantDescriptor based on the given message

Throws:

TenantNotResolvedException - if no tenant could be resolved

resolveTenant

default TenantDescriptor resolveTenant(Message message)

Returns TenantDescriptor for the given message. This method is a convenience method that calls resolveTenant(Message, Collection) with an empty collection of tenants.

Parameters:

message - the Message implementation to resolve the target tenant for

Returns:

the resolved TenantDescriptor based on the given message

Throws:

TenantNotResolvedException - if no tenant could be resolved

See Also:

• resolveTenant(Message, Collection)

attachTenant

Message attachTenant(Message message,
 TenantDescriptor tenant)

Returns a copy of the given message carrying the given tenant, the inverse of resolveTenant(Message, Collection): where that method determines the tenant a message belongs to, this one makes that determination survive the message being dispatched elsewhere.

Parameters:

message - the message to attach the given tenant to

tenant - the tenant to attach to the given message

Returns:

a copy of the given message carrying the given tenant