com.atlassian.tenant.api

Interface TenantContextProvider<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.

@PublicApi
 @FunctionalInterface
public interface TenantContextProvider<T extends TenantContext>

The TenantContext provider API. It allows us to retrieve the TenantContext corresponding to the supplied earlier tenantId via the TenantIdConsumer.setTenantId(String) method. The getTenantContext() method can be called multiple times while processing the current piece of work.

Method Summary

Modifier and Type	Method and Description
T	getTenantContext() Retrieves the TenantContext corresponding to the set earlier tenantId.

Method Detail

getTenantContext

T getTenantContext()

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.