Package io.quarkus.hibernate.orm.runtime.tenant

Interface TenantResolver

public interface TenantResolver
Resolves tenant identifier dynamically so that the proper configuration can be used.
Author:
Michael Schnell

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDefaultTenantId()
    Returns the identifier of the default tenant.
    default boolean
    isRoot(String tenantId)
    Does the given tenant id represent a "root" tenant with access to all partitions?
    String
    resolveTenantId()
    Returns the current tenant identifier.

  • Method Details

    • getDefaultTenantId

      String getDefaultTenantId()
      Returns the identifier of the default tenant.
      Returns:
      Default tenant.A non-null value is required.

    • resolveTenantId

      String resolveTenantId()
      Returns the current tenant identifier.
      Returns:
      the tenant identifier. This value will be used to select the proper configuration at runtime. A non-null value is required.

    • isRoot

      default boolean isRoot(String tenantId)
      Does the given tenant id represent a "root" tenant with access to all partitions?
      Parameters:
      tenantId - a tenant id produced by resolveTenantId()
      Returns:
      true is this is root tenant