Package io.micronaut.multitenancy.tenantresolver

Class SubdomainTenantResolver

java.lang.Object

io.micronaut.multitenancy.tenantresolver.SubdomainTenantResolver

All Implemented Interfaces:

HttpRequestTenantResolver, TenantResolver

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

A tenant resolver that resolves the tenant from the Subdomain.

Since:

6.0

Field Summary

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

ALL, DEFAULT, PREFIX

Constructor Summary

Constructors

Constructor	Description
SubdomainTenantResolver()

Method Summary

Modifier and Type	Method	Description
java.io.Serializable	resolveTenantIdentifier()	Resolves the current tenant identifier.
java.io.Serializable	resolveTenantIdentifier(@NotNull io.micronaut.http.HttpRequest<?> request)	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

SubdomainTenantResolver

public SubdomainTenantResolver()

Method Detail

resolveTenantIdentifier

@NonNull
public java.io.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

resolveTenantIdentifier

@NonNull
public java.io.Serializable resolveTenantIdentifier(@NonNull @NotNull
                                                    @NotNull io.micronaut.http.HttpRequest<?> request)
                                             throws TenantNotFoundException

Description copied from interface: HttpRequestTenantResolver

Resolves the current tenant identifier.

Specified by:

resolveTenantIdentifier in interface HttpRequestTenantResolver

Parameters:

request - The HTTP request

Returns:

The tenant identifier

Throws:

TenantNotFoundException - if tenant not found