com.edorasware.commons.core.identity

Interface CurrentTenantService

All Superinterfaces:

Service

All Known Implementing Classes:

BaseMultiTenantCurrentTenantService, BaseSingleTenantCurrentTenantService

public interface CurrentTenantService
extends Service

The service to get the current tenant.

Method Summary

Modifier and Type	Method and Description
TenantId	getCurrentTenantId() Returns the tenant to use for all data access in the current context.
TenantId	getSharedTenantId() Returns the marker tenant to use for all data access shared across all tenants.
boolean	isMultiTenant() Returns true if the service implementation supports multiple tenants.
<T> T	runAsTenant(TenantId tenantId, Callable<T> action) Runs the given action in the context of the specified tenant.
void	runAsTenant(TenantId tenantId, Runnable action) Runs the given action in the context of the specified tenant.

Methods inherited from interface com.edorasware.commons.core.util.service.Service

init

Method Detail

getCurrentTenantId

TenantId getCurrentTenantId()

Returns the tenant to use for all data access in the current context.

Returns:

the tenant to use for all data access in the current context, may be null

getSharedTenantId

TenantId getSharedTenantId()

Returns the marker tenant to use for all data access shared across all tenants.

Returns:

the marker tenant to use for all data access shared across all tenants, may be null

isMultiTenant

boolean isMultiTenant()

Returns true if the service implementation supports multiple tenants. This information allows for optimizations on the caller's end.

Returns:

true if the service supports multiple tenants

runAsTenant

void runAsTenant(TenantId tenantId,
                 Runnable action)

Runs the given action in the context of the specified tenant.

Parameters:

tenantId - the tenant id to apply

action - the action to execute

runAsTenant

<T> T runAsTenant(TenantId tenantId,
                  Callable<T> action)

Runs the given action in the context of the specified tenant.

Type Parameters:

T - the type of the callable

Parameters:

tenantId - the tenant id to apply

action - the action to execute

Returns:

the result of the action