io.micronaut.multitenancy.tenantresolver

Class SessionTenantResolver

java.lang.Object

io.micronaut.multitenancy.tenantresolver.SessionTenantResolver

All Implemented Interfaces:

HttpRequestTenantResolver, TenantResolver

@Requires(classes={io.micronaut.session.Session.class,io.micronaut.session.http.HttpSessionFilter.class}) @Requires(beans=SessionTenantResolverConfiguration.class) @Requires(property="micronaut.multitenancy.tenantresolver.session.enabled",value="true",defaultValue="false")
 @Singleton
public class SessionTenantResolver
extends java.lang.Object
implements TenantResolver, HttpRequestTenantResolver

Resolves the tenant id from the user HTTP session.

Since:

1.0.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
SessionTenantResolver(SessionTenantResolverConfiguration configuration)

Method Summary

Modifier and Type	Method and 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.
protected java.io.Serializable	resolveTenantIdentifierAtRequest(io.micronaut.http.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

Constructor Detail

SessionTenantResolver

public SessionTenantResolver(SessionTenantResolverConfiguration configuration)

Parameters:

configuration - SessionTenantResolverConfiguration 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 identifier

Throws:

TenantNotFoundException - if tenant not found

resolveTenantIdentifierAtRequest

@Deprecated
protected java.io.Serializable resolveTenantIdentifierAtRequest(io.micronaut.http.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 - if tenant not found

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