com.atlassian.confluence.tenant

Class TenantGate

java.lang.Object

com.atlassian.confluence.tenant.TenantGate

All Implemented Interfaces:

org.springframework.beans.factory.FactoryBean

public abstract class TenantGate
extends Object
implements org.springframework.beans.factory.FactoryBean

Prevents access to tenanted beans in case of a vacant (zero tenancy) instance.

The default behaviour is to escape with a VacantException, but the gate can also delegate to a vacant implementation which could behave somehow differently.

This class should be considered a temporary solution on the way to multi-tenancy. It's sole purpose is currently to delay the initialisation of SessionFactory beans until a system tenant arrived.

I've seen things you people wouldn't believe. Attack ships on fire off the shoulder of Orion. I watched C-beams glitter in the dark near the TenantGate. All those moments will be lost in time... like tears in rain... Time to die.

Since:

5.6

See Also:

SystemTenant

Field Summary

Fields

Modifier and Type	Field and Description
protected Class[]	proxyInterfaces
protected TenantRegistry	tenantRegistry

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TenantGate(TenantRegistry tenantRegistry, Class[] proxyInterfaces)

Method Summary

Modifier and Type	Method and Description
static <T> Callable<T>	close(Callable<T> callback) Close all gates for the given closure on the current thread.
protected abstract Object	createTenantedDelegate()
protected Object	createVacantDelegate()
Object	getObject()
Class	getObjectType()
boolean	isPermitted()
boolean	isSingleton()
static <T> Callable<T>	open(Callable<T> callback) Open all gates for the given closure on the current thread.
static <T> Callable<T>	permit(boolean permitted, Callable<T> callback)

Methods inherited from class java.lang.Object

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

Field Detail

tenantRegistry

protected final TenantRegistry tenantRegistry

proxyInterfaces

protected final Class[] proxyInterfaces

Constructor Detail

TenantGate

protected TenantGate(TenantRegistry tenantRegistry,
                     Class[] proxyInterfaces)

Method Detail

isPermitted

public boolean isPermitted()

Returns:

checks if the current thread is allowed to pass through the gate

open

public static <T> Callable<T> open(Callable<T> callback)

Open all gates for the given closure on the current thread.

This only makes sense in a pre-tenanted state, e.g. during setup allow code to prepare the database before it's made available to a broader audience.

Parameters:

callback - the function allowed to pass through the gate

Returns:

the permitted function

close

public static <T> Callable<T> close(Callable<T> callback)

Close all gates for the given closure on the current thread.

This only makes sense in a pre-tenanted state, if you want to ensure that the given code can not access tenanted resources even though an outer closure might have granted that access, e.g. loading DefaultPluginManager.earlyStartup() plugins which should not be able to eagerly access tenanted resources.

Parameters:

callback - the function allowed to pass through the gate

Returns:

the permitted function

createVacantDelegate

protected Object createVacantDelegate()

createTenantedDelegate

protected abstract Object createTenantedDelegate()

getObject

public final Object getObject()
                       throws Exception

Specified by:

getObject in interface org.springframework.beans.factory.FactoryBean

Throws:

Exception

getObjectType

public final Class getObjectType()

Specified by:

getObjectType in interface org.springframework.beans.factory.FactoryBean

isSingleton

public final boolean isSingleton()

Specified by:

isSingleton in interface org.springframework.beans.factory.FactoryBean

permit

public static <T> Callable<T> permit(boolean permitted,
                                     Callable<T> callback)