Package org.alfresco.repo.tenant
Class TenantUtil
- java.lang.Object
-
- org.alfresco.repo.tenant.TenantUtil
-
public abstract class TenantUtil extends Object
Utility helper methods to change the tenant context for threads.- Since:
- 4.2
- Author:
- janv, Nick Smith
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
TenantUtil.TenantRunAsWork<Result>
-
Field Summary
Fields Modifier and Type Field Description static String
DEFAULT_TENANT
static String
SYSTEM_TENANT
-
Constructor Summary
Constructors Constructor Description TenantUtil()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static String
getCurrentDomain()
static String
getTenantDomain(String name)
static boolean
isCurrentDomainDefault()
static boolean
isDefaultTenantName(String name)
static <R> R
runAsDefaultTenant(TenantUtil.TenantRunAsWork<R> runAsWork)
static <R> R
runAsSystemTenant(TenantUtil.TenantRunAsWork<R> runAsWork, String tenantDomain)
static <R> R
runAsTenant(TenantUtil.TenantRunAsWork<R> runAsWork, String tenantDomain)
Execute a unit of work in a given tenant context.static <R> R
runAsUserTenant(TenantUtil.TenantRunAsWork<R> runAsWork, String uid, String tenantDomain)
Execute a unit of work in a given tenant context.
-
-
-
Field Detail
-
SYSTEM_TENANT
public static final String SYSTEM_TENANT
- See Also:
- Constant Field Values
-
DEFAULT_TENANT
public static final String DEFAULT_TENANT
- See Also:
- Constant Field Values
-
-
Method Detail
-
runAsUserTenant
public static <R> R runAsUserTenant(TenantUtil.TenantRunAsWork<R> runAsWork, String uid, 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 douid
- the user IDtenantDomain
- the tenant domain- Returns:
- Returns the work's return value
-
runAsTenant
public static <R> R runAsTenant(TenantUtil.TenantRunAsWork<R> runAsWork, 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 dotenantDomain
- the tenant domain- Returns:
- Returns the work's return value
-
runAsDefaultTenant
public static <R> R runAsDefaultTenant(TenantUtil.TenantRunAsWork<R> runAsWork)
-
runAsSystemTenant
public static <R> R runAsSystemTenant(TenantUtil.TenantRunAsWork<R> runAsWork, String tenantDomain)
-
getCurrentDomain
public static String getCurrentDomain()
-
isCurrentDomainDefault
public static boolean isCurrentDomainDefault()
-
isDefaultTenantName
public static boolean isDefaultTenantName(String name)
-
-