Package 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 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	Description
SessionTenantResolver(SessionTenantResolverConfiguration configuration)

Method Summary

Modifier and Type	Method	Description
@NonNull String	resolveTenantId()	Resolves the current tenant identifier.
@NonNull String	resolveTenantId(@NonNull io.micronaut.http.HttpRequest<?> request)	Resolves the current tenant identifier.
@NonNull Serializable	resolveTenantIdentifier()	Deprecated, for removal: This API element is subject to removal in a future version.
@NonNull Serializable	resolveTenantIdentifier(@NonNull io.micronaut.http.HttpRequest<?> request)	Deprecated, for removal: This API element is subject to removal in a future version.

Methods inherited from class java.lang.Object

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

Constructor Details

SessionTenantResolver

public SessionTenantResolver(SessionTenantResolverConfiguration configuration)

Parameters:

configuration - SessionTenantResolverConfiguration configuration.

Method Details

resolveTenantId

@NonNull
public @NonNull String resolveTenantId()
                                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:

resolveTenantId in interface TenantResolver

Returns:

The tenant identifier

Throws:

TenantNotFoundException - if tenant not found

resolveTenantId

@NonNull
public @NonNull String resolveTenantId(@NonNull
 @NonNull io.micronaut.http.HttpRequest<?> request)
                                throws TenantNotFoundException

Description copied from interface: HttpRequestTenantResolver

Resolves the current tenant identifier.

Specified by:

resolveTenantId in interface HttpRequestTenantResolver

Parameters:

request - The HTTP request

Returns:

The tenant identifier

Throws:

TenantNotFoundException - if tenant not found

resolveTenantIdentifier

@NonNull
@Deprecated(forRemoval=true,
            since="5.5.0")
public @NonNull Serializable resolveTenantIdentifier()
                                              throws TenantNotFoundException

Deprecated, for removal: This API element is subject to removal in a future version.

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

resolveTenantIdentifier

@NonNull
@Deprecated(forRemoval=true,
            since="5.5.0")
public @NonNull Serializable resolveTenantIdentifier(@NonNull
 @NonNull io.micronaut.http.HttpRequest<?> request)
                                              throws TenantNotFoundException

Deprecated, for removal: This API element is subject to removal in a future version.

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