io.micronaut.multitenancy.tenantresolver

Class SubdomainTenantResolver

java.lang.Object

io.micronaut.multitenancy.tenantresolver.SubdomainTenantResolver

All Implemented Interfaces:

TenantResolver

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

A tenant resolver that resolves the tenant from the Subdomain.

Since:

6.0

Author:

Sergio del Amo

Field Summary

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

ALL, DEFAULT, PREFIX

Constructor Summary

Constructors

Constructor and Description
SubdomainTenantResolver()

Method Summary

Modifier and Type	Method and Description
Serializable	resolveTenantIdentifier() Resolves the current tenant identifier.
protected Serializable	resolveTenantIdentifierAtRequest(HttpRequest<Object> request)

Methods inherited from class java.lang.Object

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

Constructor Detail

SubdomainTenantResolver

public SubdomainTenantResolver()

Method Detail

resolveTenantIdentifier

public Serializable resolveTenantIdentifier()

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 identifier

resolveTenantIdentifierAtRequest

protected Serializable resolveTenantIdentifierAtRequest(HttpRequest<Object> request)
                                                 throws TenantNotFoundException

Parameters:

request - The HTTP request

Returns:

the tenant ID if resolved.

Throws:

TenantNotFoundException - if tenant not found