com.atlassian.tenant.impl

Class AbstractUnicornTenantContextProvider<T extends TenantContext>

java.lang.Object

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

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

All Implemented Interfaces:

TenantContextProvider<T>, ProvisioningTenantContextSetter<T>, TenantIdSetter

public abstract class AbstractUnicornTenantContextProvider<T extends TenantContext>
extends AbstractTenantContextProvider<T>

The base class from which the Unicorn TenantContext Provider implementations will inherit.

It uses STUDIO_LICENSE_FILE to find the unicorn license file. It will default to the value of DEFAULT_STUDIO_LICENSE_FILE. The application must supply the needed file name configuration data by overriding the protected methods, as it is shown in the UnicornTenantContextProviderTest

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_STUDIO_LICENSE_FILE
static String	STUDIO_LICENSE_FILE

Constructor Summary

Constructors

Constructor and Description
AbstractUnicornTenantContextProvider()

Method Summary

Modifier and Type	Method and Description
protected TenantContext	fetchTenantContext(String tenantId) Fetches the generic TenantContext based on the supplied tenantId.
protected abstract String	getDatasourcePath() Returns the relative path to the product Tomcat root context, starting from catalina-base, for example, catalina-base/conf/Catalina/localhost/ROOT.xml.
protected abstract String	getProductName() Returns the product name, for example jira or confluence.
protected abstract String	getServiceYamlFile() Returns the product service yaml file name, for example, /data/icebat/seamless/jira.yaml.
protected String	getStudioLicenseFile() Returns the product (studio) licence file name.

Methods inherited from class com.atlassian.tenant.impl.AbstractTenantContextProvider

decorate, getTenantContext, setProvisioningTenantContext, setTenantId

Methods inherited from class java.lang.Object

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

Field Detail

STUDIO_LICENSE_FILE

public static final String STUDIO_LICENSE_FILE

See Also:

Constant Field Values

DEFAULT_STUDIO_LICENSE_FILE

public static final String DEFAULT_STUDIO_LICENSE_FILE

See Also:

Constant Field Values

Constructor Detail

AbstractUnicornTenantContextProvider

public AbstractUnicornTenantContextProvider()

Method Detail

fetchTenantContext

protected TenantContext fetchTenantContext(String tenantId)
                                    throws TenantContextException

Fetches the generic TenantContext based on the supplied tenantId.

In Unicorn environment the tenantId parameter is unused and is ignored.

Specified by:

fetchTenantContext in class AbstractTenantContextProvider<T extends TenantContext>

Parameters:

tenantId - the tenant Id

Throws:

TenantContextException

getProductName

protected abstract String getProductName()

Returns the product name, for example jira or confluence.

getServiceYamlFile

protected abstract String getServiceYamlFile()

Returns the product service yaml file name, for example, /data/icebat/seamless/jira.yaml.

getDatasourcePath

protected abstract String getDatasourcePath()

Returns the relative path to the product Tomcat root context, starting from catalina-base, for example, catalina-base/conf/Catalina/localhost/ROOT.xml. The first half of the Tomcat root context path is extracted from the file given by getServiceYamlFile().

getStudioLicenseFile

protected String getStudioLicenseFile()

Returns the product (studio) licence file name.