Class TenantUtil


  • public abstract class TenantUtil
    extends java.lang.Object
    Utility helper methods to change the tenant context for threads.
    Since:
    4.2
    Author:
    janv, Nick Smith
    • Constructor Detail

      • TenantUtil

        public TenantUtil()
    • Method Detail

      • runAsUserTenant

        public static <R> R runAsUserTenant​(TenantUtil.TenantRunAsWork<R> runAsWork,
                                            java.lang.String uid,
                                            java.lang.String tenantDomain)
        Execute a unit of work in a given tenant context. The thread's tenant context will be returned to its normal state after the call.
        Parameters:
        runAsWork - the unit of work to do
        uid - the user ID
        tenantDomain - the tenant domain
        Returns:
        Returns the work's return value
      • runAsTenant

        public static <R> R runAsTenant​(TenantUtil.TenantRunAsWork<R> runAsWork,
                                        java.lang.String tenantDomain)
        Execute a unit of work in a given tenant context. The thread's tenant context will be returned to its normal state after the call.
        Parameters:
        runAsWork - the unit of work to do
        tenantDomain - the tenant domain
        Returns:
        Returns the work's return value
      • runAsSystemTenant

        public static <R> R runAsSystemTenant​(TenantUtil.TenantRunAsWork<R> runAsWork,
                                              java.lang.String tenantDomain)
      • getCurrentDomain

        public static java.lang.String getCurrentDomain()
      • isCurrentDomainDefault

        public static boolean isCurrentDomainDefault()
      • getTenantDomain

        public static java.lang.String getTenantDomain​(java.lang.String name)
      • isDefaultTenantName

        public static boolean isDefaultTenantName​(java.lang.String name)