com.atlassian.tenant.impl

Class YamlTenantContextProvider

java.lang.Object

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

com.atlassian.tenant.impl.YamlTenantContextProvider

All Implemented Interfaces:

TenantContextProvider<TenantContext>, ProvisioningTenantContextSetter<TenantContext>, TenantIdSetter

public class YamlTenantContextProvider
extends AbstractTenantContextProvider<TenantContext>

Atlassian TenantContext API, YAML provider implementation.

The expected mandatory yaml fields are shown below, all of these fields are of type String. If there are any additional fields in the yaml file, they will be parsed and included in extraContext. All these additional fields are also expected to be of type String. Sample yaml files are included in the test resources tenants folder.

• tenantId
• jdbcUrl
• jdbcUsername
• jdbcPassword
• memcachedUrl
• globalCacheIdentifier

The tenantId supplied to this provider is used as the name of the YAML file (with extension .yaml) from which the tenant configuration data will be extracted. The tenant file will be loaded as a resource from a tenants folder under the application resources root or from the file system if the TENANT_DIRECTORY system property is specified.

Since:

v1.0

Constructor Summary

Constructors

Constructor and Description
YamlTenantContextProvider()

Method Summary

Modifier and Type	Method and Description
protected TenantContext	decorate(TenantContext tc)
protected TenantContext	fetchTenantContext(String tenantFileName) Creates the TenantContext for local environment from an yaml file named tenantFileName.

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

getTenantContext, setProvisioningTenantContext, setTenantId

Methods inherited from class java.lang.Object

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

Constructor Detail

YamlTenantContextProvider

public YamlTenantContextProvider()

Method Detail

fetchTenantContext

protected TenantContext fetchTenantContext(String tenantFileName)
                                    throws TenantContextException

Creates the TenantContext for local environment from an yaml file named tenantFileName.

Specified by:

fetchTenantContext in class AbstractTenantContextProvider<TenantContext>

Parameters:

tenantFileName - the name of the yaml file from which the TenantContext configuration data will be read.

Throws:

TenantContextException

decorate

protected TenantContext decorate(TenantContext tc)

Specified by:

decorate in class AbstractTenantContextProvider<TenantContext>

Parameters:

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