Package io.micronaut.multitenancy.tenantresolver

Interface TenantResolver

All Known Implementing Classes:
AbstractSubdomainTenantResolver, CookieTenantResolver, FixedTenantResolver, HttpHeaderTenantResolver, InternetDomainNameSubdomainTenantResolver, PrincipalTenantResolver, PublicSuffixListSubdomainTenantResolver, SessionTenantResolver, SubdomainTenantResolver, SystemPropertyTenantResolver
public interface TenantResolver
An interface for applications that implement Multi Tenancy to implement in order to resolve the current identifier.
Since:
1.0
Author:
Sergio del Amo

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ALL
    Constant for a mapping to all tenants.
    static final String
    DEFAULT
    The name of the default tenant.
    static final String
    PREFIX
    Tenant Resolver Configuration Prefix.

  • Method Summary

    Modifier and Type
    Method
    Description
    default String
    resolveTenantId()
    Resolves the current tenant identifier.
    @NonNull Serializable
    resolveTenantIdentifier()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Use resolveTenantId() instead

  • Field Details

  • Method Details

    • resolveTenantIdentifier

      @Deprecated(forRemoval=true, since="5.5.0") @NonNull @NonNull Serializable resolveTenantIdentifier() throws TenantNotFoundException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use resolveTenantId() instead

      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.

      Returns:
      The tenant identifier
      Throws:
      TenantNotFoundException - if tenant not found

    • resolveTenantId

      default String resolveTenantId() throws TenantNotFoundException

      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.

      Returns:
      The tenant identifier
      Throws:
      TenantNotFoundException - if tenant not found
      Since:
      5.5.0