com.atlassian.tenant.impl

Class AbstractTenantContextProvider<T extends TenantContext>

java.lang.Object

com.atlassian.tenant.impl.AbstractTenantContextProvider<T>

All Implemented Interfaces:

TenantContextProvider<T>, ProvisioningTenantContextSetter<T>, TenantIdSetter

Direct Known Subclasses:

AbstractServiceTenantContextProvider, AbstractUnicornTenantContextProvider, YamlTenantContextProvider

public abstract class AbstractTenantContextProvider<T extends TenantContext>
extends Object
implements TenantContextProvider<T>, TenantIdSetter, ProvisioningTenantContextSetter<T>

The AbstractTenantContextProvider allows us to create product specific LocalTenantContextProvider(s) or ServiceTenantContextProvider(s) based on the abstract fetchTenantContext(java.lang.String) method.

It provides support for caching of the retrieved tenant contexts, which is controlled via the tcapi.cache.timeout.seconds and tcapi.cache.max.size system properties. The caching is by default enabled.

Constructor Summary

Constructors

Constructor and Description
AbstractTenantContextProvider()

Method Summary

Modifier and Type	Method and Description
protected abstract T	decorate(TenantContext tc)
protected abstract TenantContext	fetchTenantContext(String tenantId) Fetches the generic TenantContext based on the supplied tenantId.
T	getTenantContext() Retrieves the TenantContext corresponding to the set earlier tenantId.
boolean	isTenanted() Returns true if the there is an available tenant.
void	setProvisioningTenantContext(T tenantContext) Allows the application to set the created at provisioning time TenantContext.
void	setTenantId(String tenantId) This method allows us to set the incoming from a cookie, HTTP header or SQS message tenantId.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractTenantContextProvider

public AbstractTenantContextProvider()

Method Detail

fetchTenantContext

protected abstract TenantContext fetchTenantContext(String tenantId)

Fetches the generic TenantContext based on the supplied tenantId.

Parameters:

tenantId - the tenant Id

decorate

protected abstract T decorate(TenantContext tc)

Parameters:

tc - the TenantContext generic instance which has to be decorated to a product specific TenantContext

getTenantContext

public T getTenantContext()
                   throws TenantContextException

Description copied from interface: TenantContextProvider

Retrieves the TenantContext corresponding to the set earlier tenantId. If this method is called before/without a previous call to TenantIdConsumer.setTenantId(String), the concrete TenantContextProvider implementation may choose to return a default TenantContext or to throw an Exception.

Specified by:

getTenantContext in interface TenantContextProvider<T extends TenantContext>

Throws:

TenantContextException

setTenantId

public void setTenantId(String tenantId)
                 throws TenantContextException

Description copied from interface: TenantIdSetter

This method allows us to set the incoming from a cookie, HTTP header or SQS message tenantId. This method must be called once only per work-context, for example in a Tomcat filter or similar, and should normally be invoked before a call to TenantContextProvider.getTenantContext() occurs. If it is called more than once per WorkContext it will throw a TenantContextException.

Specified by:

setTenantId in interface TenantIdSetter

Parameters:

tenantId - the tenant id, must not be null

Throws:

TenantContextException

setProvisioningTenantContext

public void setProvisioningTenantContext(T tenantContext)
                                  throws TenantContextException

Description copied from interface: ProvisioningTenantContextSetter

Allows the application to set the created at provisioning time TenantContext. This method must be called once only per work-context as part of the provisioning flow, for example in a Tomcat filter or similar, and should normally be invoked before a call to TenantContextProvider.getTenantContext() occurs. If it is called more than once per WorkContext it will throw a TenantContextException.

Specified by:

setProvisioningTenantContext in interface ProvisioningTenantContextSetter<T extends TenantContext>

Parameters:

tenantContext - the supplied by the application TenantContext, must not be null

Throws:

TenantContextException

isTenanted

public boolean isTenanted()

Description copied from interface: TenantContextProvider

Returns true if the there is an available tenant. Checks the WorkContext first - if there is no WorkContext there is no tenant.

Specified by:

isTenanted in interface TenantContextProvider<T extends TenantContext>

Returns:

True if there is a tenant, false otherwise.