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 and Description
static interface	TenantUtil.TenantRunAsWork<Result>

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_TENANT
static String	SYSTEM_TENANT

Constructor Summary

Constructors

Constructor and Description
TenantUtil()

Method Summary

Modifier and Type	Method and 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

Constructor Detail

TenantUtil

public TenantUtil()

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 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,
                                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

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()

getTenantDomain

public static String getTenantDomain(String name)

isDefaultTenantName

public static boolean isDefaultTenantName(String name)