Package io.axoniq.framework.messaging.multitenancy.axonserver.configuration

Class AxonServerMultiTenancyConfigurationDefaults

java.lang.Object

io.axoniq.framework.messaging.multitenancy.axonserver.configuration.AxonServerMultiTenancyConfigurationDefaults

All Implemented Interfaces:

ConfigurationEnhancer

@Internal
@RegistrationScope(scope=CURRENT)
public class AxonServerMultiTenancyConfigurationDefaults
extends Object
implements ConfigurationEnhancer

ConfigurationEnhancer registering the default Axon Server-backed multi-tenancy components:

• the TenantProvider which is responsible for managing tenants and lifecycle, backed by AxonServerTenantProvider
• the MultiTenantAxonServerCommandBusConnector which fans out commands to a connector per tenant
• the MultiTenantEventStorageEngine as the EventStorageEngine, routing appends and sourcing to each tenant's own engine, and the MultiTenantSnapshotStore as the SnapshotStore, routing snapshot writes the same way
• the TenantEventStorageEngineFactory and TenantSnapshotStoreFactory building those per-tenant components against the tenant's Axon Server context
• the MultiTenantAxonServerQueryBusConnector which fans out queries to a connector per tenant

It also disables the SnapshotSourcingConfigurationEnhancer, since snapshot sourcing is composed per tenant by the routing engine rather than once for the application.

Contributed through the ServiceLoader, so multi-tenancy is active as soon as the axoniq-multi-tenancy module is on the classpath. Use MultiTenancyUtils.disable(ComponentRegistry) to opt out, for instance when running against an infrastructure without Axon Server.

Since:

5.3.0

Author:

Jan Galinski, Laura Devriendt, Jakob Hatzl

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ENHANCER_ORDER	The order of this enhancer compared to others.

Constructor Summary

Constructors

Constructor	Description
AxonServerMultiTenancyConfigurationDefaults()

Method Summary

Modifier and Type	Method	Description
static ComponentDefinition<TenantProvider>	axonServerTenantProvider()	Provides a ComponentDefinition for the TenantProvider that is backed by Axon Server.
void	enhance(ComponentRegistry componentRegistry)	Enhances the given registry with, for example, additional components and decorators.
int	order()	Returns the relative order this enhancer should be invoked in, compared to other instances.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ENHANCER_ORDER

public static final int ENHANCER_ORDER

The order of this enhancer compared to others.

Runs early, so the Axon Server-backed multi-tenancy defaults registered here are in place before other enhancers and user registrations that build on them, most notably before Axon Server's own AxonServerConfigurationEnhancer registers its non-multi-tenant defaults for the same component types.

Expressed relative to MultiTenancyConfigurationDefaults.ENHANCER_ORDER, which anchors the multi-tenancy enhancer block, so this enhancer can never end up ahead of the generic defaults it builds on.

See Also:

• Constant Field Values

Constructor Details

AxonServerMultiTenancyConfigurationDefaults

public AxonServerMultiTenancyConfigurationDefaults()

Method Details

order

public int order()

Description copied from interface: ConfigurationEnhancer

Returns the relative order this enhancer should be invoked in, compared to other instances.

Use lower (negative) values for enhancers providing sensible defaults, and higher values for enhancers that should be able to override values potentially previously set. Defaults to 0 when not set.

Specified by:

order in interface ConfigurationEnhancer

Returns:

The order in which this enhancer should be invoked.

enhance

public void enhance(ComponentRegistry componentRegistry)

Description copied from interface: ConfigurationEnhancer

Enhances the given registry with, for example, additional components and decorators.

Specified by:

enhance in interface ConfigurationEnhancer

Parameters:

componentRegistry - The registry instance to enhance.

axonServerTenantProvider

public static ComponentDefinition<TenantProvider> axonServerTenantProvider()

Provides a ComponentDefinition for the TenantProvider that is backed by Axon Server. Uses the AxonServerConnectionManager to manage connections and the TenantConnectPredicate to determine which tenants to connect to, defaults to AxonServerTenantConnectPredicate.

Returns:

a ComponentDefinition for the TenantProvider that is backed by Axon Server