Uses of Class
io.axoniq.framework.messaging.multitenancy.api.TenantDescriptor

Packages that use TenantDescriptor

Package	Description
io.axoniq.framework.messaging.multitenancy.api	Contains the multi-tenancy API, like the tenant descriptor, tenant provider, and tenant resolution contracts.
io.axoniq.framework.messaging.multitenancy.axonserver.api	Part of the Axoniq Framework multi-tenancy module.
io.axoniq.framework.messaging.multitenancy.axonserver.commandhandling	Part of the Axoniq Framework multi-tenancy module.
io.axoniq.framework.messaging.multitenancy.axonserver.eventsourcing	Part of the Axoniq Framework multi-tenancy module.
io.axoniq.framework.messaging.multitenancy.axonserver.eventstreaming	Axon Server specific multi-tenant event streaming infrastructure, giving each tenant its own persistent stream and labelling the events it delivers with the tenant they belong to.
io.axoniq.framework.messaging.multitenancy.axonserver.queryhandling	Part of the Axoniq Framework multi-tenancy module.
io.axoniq.framework.messaging.multitenancy.eventsourcing	Package containing multitenancy support for event sourcing components.

Uses of TenantDescriptor in io.axoniq.framework.messaging.multitenancy.api

Fields in io.axoniq.framework.messaging.multitenancy.api with type parameters of type TenantDescriptor

Modifier and Type	Field	Description
static final Context.ResourceKey<TenantDescriptor>	TenantDescriptor.RESOURCE_KEY	The Context.ResourceKey used whenever a ProcessingContext would contain a TenantDescriptor.

Methods in io.axoniq.framework.messaging.multitenancy.api that return TenantDescriptor

Modifier and Type	Method	Description
TenantDescriptor	MetadataBasedTenantResolver.resolveTenant(Message message, Collection<TenantDescriptor> tenants)	Resolves the target tenant by extracting the tenant identifier from the message's metadata.
default TenantDescriptor	TenantResolver.resolveTenant(Message message)	Returns TenantDescriptor for the given message.
TenantDescriptor	TenantResolver.resolveTenant(Message message, Collection<TenantDescriptor> tenants)	Returns TenantDescriptor for the given message.
static TenantDescriptor	TenantDescriptor.tenantWithId(String tenantId)	Constructs a TenantDescriptor with the given tenantId.

Methods in io.axoniq.framework.messaging.multitenancy.api that return types with arguments of type TenantDescriptor

Modifier and Type	Method	Description
static Optional<TenantDescriptor>	TenantDescriptor.fromContext(ProcessingContext context)	Returns an Optional of the TenantDescriptor kept under the RESOURCE_KEY in the given context, or Optional.empty() when none is present.
Optional<TenantDescriptor>	TenantRouter.resolveFromContext(@Nullable ProcessingContext context)	Resolves the tenant carried by the given context, taken from its tenant resource when present, otherwise from the message the context carries.
Optional<TenantDescriptor>	TenantRouter.resolveFromMessage(Message message)	Resolves the tenant of the given message.
Optional<TenantDescriptor>	TenantRouter.resolveSharedTenant(Collection<? extends Message> messages)	Resolves the single tenant shared by all given messages.
List<TenantDescriptor>	TenantDescriptors.tenants()	Returns a list of tenant descriptors.
List<TenantDescriptor>	TenantProvider.tenants()	Get the list of registered tenants with this provided.
List<TenantDescriptor>	TenantScopedCache.tenants()	Returns the tenants currently registered with this cache, whether their component was built yet or not.

Methods in io.axoniq.framework.messaging.multitenancy.api with parameters of type TenantDescriptor

Modifier and Type	Method	Description
Message	MetadataBasedTenantResolver.attachTenant(Message message, TenantDescriptor tenant)	Attaches the given tenant to the given message by writing its identifier into the message's metadata under this instance's metadataKey, merged with any metadata the message already carries.
Message	TenantResolver.attachTenant(Message message, TenantDescriptor tenant)	Returns a copy of the given message carrying the given tenant, the inverse of TenantResolver.resolveTenant(Message, Collection): where that method determines the tenant a message belongs to, this one makes that determination survive the message being dispatched elsewhere.
Message	TenantRouter.attachTenant(Message message, TenantDescriptor tenant)	Attaches the given tenant to the given message, the inverse of TenantRouter.resolveFromMessage(Message), delegating to the wrapped TenantResolver.
T	TenantComponentProvider.componentFor(TenantDescriptor tenant)	Returns the component instance for the given tenant.
C	TenantScopedCache.componentFor(TenantDescriptor tenant)	Returns the component of the given tenant, creating and caching it on first access.
T	TenantComponentFactory.create(TenantDescriptor tenant)	Creates a component instance for the given tenant.
default void	TenantComponentFactory.destroy(TenantDescriptor tenant, T component)	Destroys the given component when its tenant is removed.
default boolean	TenantDescriptors.isKnown(TenantDescriptor tenant)	Indicates whether the given tenant is one of the tenants of this application.
Registration	MultiTenantAwareComponent.registerAndStartTenant(TenantDescriptor tenantDescriptor)	Registers the given tenantDescriptor as a known tenant with this multi-tenant aware component.
Registration	TenantScopedCache.registerAndStartTenant(TenantDescriptor tenantDescriptor)	Behaves identically to TenantScopedCache.registerTenant(TenantDescriptor): components are created lazily on first use, so there is nothing to start eagerly.
Registration	MultiTenantAwareComponent.registerTenant(TenantDescriptor tenantDescriptor)	Registers the given tenantDescriptor as a known tenant with this multi-tenant aware component.
Registration	TenantScopedCache.registerTenant(TenantDescriptor tenantDescriptor)

Method parameters in io.axoniq.framework.messaging.multitenancy.api with type arguments of type TenantDescriptor

Modifier and Type	Method	Description
TenantDescriptor	MetadataBasedTenantResolver.resolveTenant(Message message, Collection<TenantDescriptor> tenants)	Resolves the target tenant by extracting the tenant identifier from the message's metadata.
TenantDescriptor	TenantResolver.resolveTenant(Message message, Collection<TenantDescriptor> tenants)	Returns TenantDescriptor for the given message.

Constructor parameters in io.axoniq.framework.messaging.multitenancy.api with type arguments of type TenantDescriptor

Modifier	Constructor	Description
	TenantScopedCache(Function<TenantDescriptor,C> componentFactory, String owner)	Constructs a TenantScopedCache building its components with the given componentFactory, dropping its reference to a component on eviction without releasing it any further.
	TenantScopedCache(Function<TenantDescriptor,C> componentFactory, BiConsumer<TenantDescriptor,C> onEviction, String owner)	Constructs a TenantScopedCache building its components with the given componentFactory and handing every component it evicts to the given onEviction.
	TenantScopedCache(Function<TenantDescriptor,C> componentFactory, BiConsumer<TenantDescriptor,C> onEviction, String owner)	Constructs a TenantScopedCache building its components with the given componentFactory and handing every component it evicts to the given onEviction.

Uses of TenantDescriptor in io.axoniq.framework.messaging.multitenancy.axonserver.api

Methods in io.axoniq.framework.messaging.multitenancy.axonserver.api that return types with arguments of type TenantDescriptor

Modifier and Type	Method	Description
List<TenantDescriptor>	AxonServerTenantProvider.tenants()

Methods in io.axoniq.framework.messaging.multitenancy.axonserver.api with parameters of type TenantDescriptor

Modifier and Type	Method	Description
void	AxonServerTenantProvider.addTenant(TenantDescriptor tenantDescriptor)	Adds the given tenantDescriptor as a known tenant, registering and starting every subscribed MultiTenantAwareComponent for it.
boolean	AxonServerTenantProvider.isKnown(TenantDescriptor tenant)
void	AxonServerTenantProvider.removeTenant(TenantDescriptor tenantDescriptor)	Removes a tenant from the system.
boolean	AxonServerTenantConnectPredicate.test(TenantDescriptor tenantDescriptor)

Uses of TenantDescriptor in io.axoniq.framework.messaging.multitenancy.axonserver.commandhandling

Methods in io.axoniq.framework.messaging.multitenancy.axonserver.commandhandling with parameters of type TenantDescriptor

Modifier and Type	Method	Description
Registration	MultiTenantAxonServerCommandBusConnector.registerAndStartTenant(TenantDescriptor tenantDescriptor)
Registration	MultiTenantAxonServerCommandBusConnector.registerTenant(TenantDescriptor tenantDescriptor)

Uses of TenantDescriptor in io.axoniq.framework.messaging.multitenancy.axonserver.eventsourcing

Methods in io.axoniq.framework.messaging.multitenancy.axonserver.eventsourcing with parameters of type TenantDescriptor

Modifier and Type	Method	Description
EventStorageEngine	AxonServerTenantEventStorageEngineFactory.engineFor(TenantDescriptor tenant)
Registration	AxonServerTenantEventStorageEngineFactory.registerAndStartTenant(TenantDescriptor tenantDescriptor)
Registration	AxonServerTenantSnapshotStoreFactory.registerAndStartTenant(TenantDescriptor tenantDescriptor)
Registration	AxonServerTenantEventStorageEngineFactory.registerTenant(TenantDescriptor tenantDescriptor)
Registration	AxonServerTenantSnapshotStoreFactory.registerTenant(TenantDescriptor tenantDescriptor)
SnapshotStore	AxonServerTenantSnapshotStoreFactory.storeFor(TenantDescriptor tenant)

Uses of TenantDescriptor in io.axoniq.framework.messaging.multitenancy.axonserver.eventstreaming

Methods in io.axoniq.framework.messaging.multitenancy.axonserver.eventstreaming with parameters of type TenantDescriptor

Modifier and Type	Method	Description
Registration	MultiTenantPersistentStreamEventSource.registerAndStartTenant(TenantDescriptor tenantDescriptor)	Behaves identically to MultiTenantPersistentStreamEventSource.registerTenant(TenantDescriptor), which already opens the tenant's stream: this source is only registered with the TenantProvider while it has a consumer to feed, so there is no registered-but-not-started state to distinguish.
Registration	MultiTenantPersistentStreamEventSource.registerTenant(TenantDescriptor tenantDescriptor)	Opens the persistent stream of the given tenantDescriptor and joins it to the subscribed consumer.

Uses of TenantDescriptor in io.axoniq.framework.messaging.multitenancy.axonserver.queryhandling

Methods in io.axoniq.framework.messaging.multitenancy.axonserver.queryhandling with parameters of type TenantDescriptor

Modifier and Type	Method	Description
Registration	MultiTenantAxonServerQueryBusConnector.registerAndStartTenant(TenantDescriptor tenantDescriptor)
Registration	MultiTenantAxonServerQueryBusConnector.registerTenant(TenantDescriptor tenantDescriptor)

Uses of TenantDescriptor in io.axoniq.framework.messaging.multitenancy.eventsourcing

Methods in io.axoniq.framework.messaging.multitenancy.eventsourcing that return types with arguments of type TenantDescriptor

Modifier and Type	Method	Description
List<TenantDescriptor>	MultiTenantEventStorageEngine.tenants()	Returns the tenants currently registered with this engine.

Methods in io.axoniq.framework.messaging.multitenancy.eventsourcing with parameters of type TenantDescriptor

Modifier and Type	Method	Description
EventStorageEngine	TenantEventStorageEngineFactory.engineFor(TenantDescriptor tenant)	Returns the EventStorageEngine of the given tenant.
Registration	MultiTenantEventStorageEngine.registerAndStartTenant(TenantDescriptor tenantDescriptor)
Registration	MultiTenantEventStorageEngine.registerTenant(TenantDescriptor tenantDescriptor)
SnapshotStore	TenantSnapshotStoreFactory.storeFor(TenantDescriptor tenant)	Returns the SnapshotStore of the given tenant.