com.atlassian.tenant.impl

Interface TenantIdSetter

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 TenantIdSetter

The companion of the TenantContextProvider API. It allows us to set the incoming from a cookie, HTTP header or SQS message tenantId. The setTenantId(java.lang.String) method is expected to be called only once per work-context, for example in a Tomcat filter.

Method Summary

Modifier and Type	Method and Description
void	setTenantId(String tenantId) This method allows us to set the incoming from a cookie, HTTP header or SQS message tenantId.

Method Detail

setTenantId

void setTenantId(String tenantId)

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.

Parameters:

tenantId - the tenant id, must not be null