com.cognos.CAM_AAA.authentication

Interface ITenantProvider

All Superinterfaces:

IProvider

public interface ITenantProvider
extends IProvider

Defines the interface for implementing a custom tenant identifier provider for use in a multi-tenant environment.
During system startup IProvider.init(Map, String) will be called once per configured instance. While the system is running getTenantId(IAccount) will be called as accounts are logged on to. The IProvider.destroy() method will be called at system shutdown. It is possible that multiple instances of the provider are created for a single namespace, this occurs when more than one CAM AAA service exists on the machine.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getTenantId(IAccount account) Any Unicode character is allowed in a tenantID, with the exception of tabs, carriage returns, and line feeds.

Methods inherited from interface com.cognos.CAM_AAA.authentication.IProvider

destroy, init

Method Detail

getTenantId

java.lang.String getTenantId(IAccount account)
                      throws UnrecoverableException

Any Unicode character is allowed in a tenantID, with the exception of tabs, carriage returns, and line feeds. Leading and trailing spaces are trimmed, and consecutive internal spaces are reduced to one. A tenantID consisting only of spaces is reduced to an empty string which is reserved for public content.

Parameters:

account - The account that has been logged on to.

Returns:

The identifier of the tenant the account belongs to.

Throws:

UnrecoverableException - An exception occurred while determining which tenant the account belongs to.