com.atlassian.tenant.impl

Interface ProvisioningTenantContextSetter<T extends TenantContext>

All Known Implementing Classes:

AbstractServiceTenantContextProvider, AbstractTenantContextProvider, AbstractUnicornTenantContextProvider, YamlTenantContextProvider

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface ProvisioningTenantContextSetter<T extends TenantContext>

Allows us to set the incoming at a provisioning time TenantContext as a current TenantContext. Each application participating in a provisioning workflow can decorate an implementation of the TenantContext interface based on the data which the application receives at provisioning time and then sets this context to be used for the remaining duration of the provisioning request processing.

Method Summary

Modifier and Type	Method and Description
void	setProvisioningTenantContext(T tenantContext) Allows the application to set the created at provisioning time TenantContext.

Method Detail

setProvisioningTenantContext

void setProvisioningTenantContext(T tenantContext)

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.

Parameters:

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