com.atlassian.tenancy.api

Interface TenantAccessor

@ExperimentalApi
public interface TenantAccessor

Service for explicitly interacting with a server's tenants.

Method Summary

Methods

Modifier and Type	Method and Description
<T> T	asTenant(Tenant tenant, Callable<T> call) Execute some code as a particular tenant.
Iterable<Tenant>	getAvailableTenants() Retrieve the tenants currently installed on this server.

Method Detail

getAvailableTenants

Iterable<Tenant> getAvailableTenants()

Retrieve the tenants currently installed on this server. If a tenant is currently in the process of being introduced, this method will block to prevent race conditions with processing of the TenantArrived event.

Returns:

the currently installed tenants. May be empty if no tenants are installed.

asTenant

<T> T asTenant(Tenant tenant,
             Callable<T> call)
           throws TenantUnavailableException,
                  InvocationTargetException

Execute some code as a particular tenant. This should only be necessary in circumstances where the application has not already put a tenant in the current context. If you attempt to use this method to change tenant contexts (i.e. you are in the context of one tenant, and try to execute code as a different tenant) an exception will be thrown

Type Parameters:

T - the expected return type of the call

Parameters:

tenant - the tenant to execute the call on behalf of

call - the Callable to execute

Returns:

the return value of the provided Callable.

Throws:

InvocationTargetException - an exception was thrown by the provided Callable

TenantUnavailableException - the operation could not be performed because the tenant is not currently installed on the server. This may happen because a tenant has been uninstalled since the last call to getAvailableTenants().

UnexpectedTenantChangeException - the method was called from the context of an tenant other than the one provided as a parameter