Package io.micronaut.multitenancy.tenantresolver

Class SystemPropertyTenantResolver

java.lang.Object

io.micronaut.multitenancy.tenantresolver.SystemPropertyTenantResolver

All Implemented Interfaces:

TenantResolver

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

A TenantResolver that resolves from a System property called "tenantId". Useful for testing.

Since:

1.0

Author:

Sergio del Amo

Field Summary

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

ALL, DEFAULT, PREFIX

Constructor Summary

Constructors

Constructor	Description
SystemPropertyTenantResolver(SystemPropertyTenantResolverConfiguration systemPropertyTenantResolverConfiguration)	Constructs a system property 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

SystemPropertyTenantResolver

public SystemPropertyTenantResolver(SystemPropertyTenantResolverConfiguration systemPropertyTenantResolverConfiguration)

Constructs a system property tenant resolver.

Parameters:

systemPropertyTenantResolverConfiguration - SystemPropertyTenantResolverConfiguration Configuration for system property tenant resolver.

Method Details

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.

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.