Package io.micronaut.multitenancy.tenantresolver

Class FixedTenantResolver

java.lang.Object

io.micronaut.multitenancy.tenantresolver.FixedTenantResolver

All Implemented Interfaces:

TenantResolver

@Requires(beans=FixedTenantResolverConfiguration.class) @Requires(property="micronaut.multitenancy.tenantresolver.fixed.enabled",value="true",defaultValue="false")
@Singleton
public class FixedTenantResolver
extends Object
implements TenantResolver

A TenantResolver that resolves to a fixed static named tenant id.

Since:

1.0.0

Author:

Sergio del Amo

Field Summary

Fields inherited from interface io.micronaut.multitenancy.tenantresolver.TenantResolver

ALL, DEFAULT, PREFIX

Constructor Summary

Constructors

Constructor	Description
FixedTenantResolver(FixedTenantResolverConfiguration fixedTenantResolverConfiguration)	Constructs a fixed tenant resolver.

Method Summary

Modifier and Type	Method	Description
@NonNull String	resolveTenantId()	Resolves the current tenant identifier.
@NonNull Serializable	resolveTenantIdentifier()	Deprecated, for removal: This API element is subject to removal in a future version. Use resolveTenantId() instead

Methods inherited from class java.lang.Object

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

Constructor Details

FixedTenantResolver

public FixedTenantResolver(FixedTenantResolverConfiguration fixedTenantResolverConfiguration)

Constructs a fixed tenant resolver.

Parameters:

fixedTenantResolverConfiguration - Fixed tenant resolver configuration FixedTenantResolverConfiguration.

Method Details

resolveTenantIdentifier

@Deprecated(forRemoval=true,
            since="5.5.0")
@NonNull
public @NonNull Serializable resolveTenantIdentifier()
                                              throws TenantNotFoundException

Deprecated, for removal: This API element is subject to removal in a future version.

Use resolveTenantId() instead

Description copied from interface: TenantResolver

Resolves the current tenant identifier.

In a Multi Tenant setup where a single database is being used amongst multiple tenants this would be the object that is used as the tenantId property for each domain class.

Specified by:

resolveTenantIdentifier in interface TenantResolver

Returns:

the tenant ID if resolved.

Throws:

TenantNotFoundException - if tenant not found

resolveTenantId

@NonNull
public @NonNull String resolveTenantId()
                                throws TenantNotFoundException

Description copied from interface: TenantResolver

Resolves the current tenant identifier.

In a Multi Tenant setup where a single database is being used amongst multiple tenants this would be the object that is used as the tenantId property for each domain class.

Specified by:

resolveTenantId in interface TenantResolver

Returns:

the tenant ID if resolved.

Throws:

TenantNotFoundException - if tenant not found