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 java.lang.Object
implements TenantResolver

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

Since:

1.0

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
java.io.Serializable	resolveTenantIdentifier()	Resolves the current tenant identifier.

Methods inherited from class java.lang.Object

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

Constructor Detail

SystemPropertyTenantResolver

public SystemPropertyTenantResolver(SystemPropertyTenantResolverConfiguration systemPropertyTenantResolverConfiguration)

Constructs a system property tenant resolver.

Parameters:

systemPropertyTenantResolverConfiguration - SystemPropertyTenantResolverConfiguration Configuration for system property tenant resolver.

Method Detail

resolveTenantIdentifier

@NonNull
public java.io.Serializable resolveTenantIdentifier()
                                             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:

resolveTenantIdentifier in interface TenantResolver

Returns:

the tenant ID if resolved.

Throws:

TenantNotFoundException - if tenant not found.