io.micronaut.multitenancy.tenantresolver

Class HttpHeaderTenantResolver

java.lang.Object

io.micronaut.multitenancy.tenantresolver.HttpHeaderTenantResolver

All Implemented Interfaces:

HttpRequestTenantResolver, TenantResolver

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

A TenantResolver that resolves the tenant from the request HTTP Header.

Since:

1.0.0

Author:

Sergio del Amo

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	headerName The name of the header.

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

ALL, DEFAULT, PREFIX

Constructor Summary

Constructors

Constructor and Description
HttpHeaderTenantResolver(HttpHeaderTenantResolverConfiguration configuration)

Method Summary

Modifier and Type	Method and Description
java.io.Serializable	resolveTenantIdentifier() Resolves the current tenant identifier.
java.io.Serializable	resolveTenantIdentifier(@NotNull HttpRequest<?> request) Resolves the current tenant identifier.
protected java.io.Serializable	resolveTenantIdentifierAtRequest(HttpRequest<java.lang.Object> request) Deprecated. Use resolveTenantIdentifier(HttpRequest) instead.

Methods inherited from class java.lang.Object

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

Field Detail

headerName

protected java.lang.String headerName

The name of the header.

Constructor Detail

HttpHeaderTenantResolver

public HttpHeaderTenantResolver(HttpHeaderTenantResolverConfiguration configuration)

Parameters:

configuration - HttpHeaderTenantResolverConfiguration configuration

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

resolveTenantIdentifier

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

resolveTenantIdentifierAtRequest

@Deprecated
protected java.io.Serializable resolveTenantIdentifierAtRequest(HttpRequest<java.lang.Object> request)
                                                                     throws TenantNotFoundException

Deprecated. Use resolveTenantIdentifier(HttpRequest) instead.

Parameters:

request - The HTTP request

Returns:

the tenant ID if resolved.

Throws:

TenantNotFoundException - A exception thrown if the tenant could not be resolved.