Package io.micronaut.multitenancy.tenantresolver

Class AbstractSubdomainTenantResolver

java.lang.Object

io.micronaut.multitenancy.tenantresolver.AbstractSubdomainTenantResolver

All Implemented Interfaces:

HttpRequestTenantResolver, TenantResolver

Direct Known Subclasses:

InternetDomainNameSubdomainTenantResolver, PublicSuffixListSubdomainTenantResolver, SubdomainTenantResolver

public abstract class AbstractSubdomainTenantResolver
extends Object
implements TenantResolver, HttpRequestTenantResolver

Abstract class for a tenant resolver that resolves the tenant from the Subdomain.

Since:

5.1.0

Author:

Sergio del Amo

Field Summary

Fields

Modifier and Type	Field	Description
protected io.micronaut.http.server.util.HttpHostResolver	httpHostResolver	Http Host resolver.

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

ALL, DEFAULT, PREFIX

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractSubdomainTenantResolver(io.micronaut.http.server.util.HttpHostResolver httpHostResolver)

Method Summary

Modifier and Type	Method	Description
protected abstract @NonNull Serializable	resolveSubdomain(@NonNull String host)
@NonNull Serializable	resolveTenantIdentifier()	Resolves the current tenant identifier.
@NonNull Serializable	resolveTenantIdentifier(@NonNull 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

Field Details

httpHostResolver

protected io.micronaut.http.server.util.HttpHostResolver httpHostResolver

Http Host resolver.

Constructor Details

AbstractSubdomainTenantResolver

protected AbstractSubdomainTenantResolver(io.micronaut.http.server.util.HttpHostResolver httpHostResolver)

Parameters:

httpHostResolver - HTTP host resolver.

Method Details

resolveTenantIdentifier

@NonNull
public @NonNull 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 @NonNull Serializable resolveTenantIdentifier(@NonNull
 @NonNull 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

resolveSubdomain

@NonNull
protected abstract @NonNull Serializable resolveSubdomain(@NonNull
 @NonNull String host)

Parameters:

host - Host

Returns:

The subdomain.