IBoundingSetProvider Interface
The IBoundingSetProvider interface is used to share content among multiple tenants.
During system startup, the init(Map, String)
method is called once per
configured instance. While the system is running, getBoundingSet(IAccount)
is
called as accounts are logged on to. The destroy()
method is 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 is running.
The following methods are available in the IBoundingSetProvider interface.
- destroy
- Destroys this IBoundingSetProvider and frees resources held by it. This method is called during the system shutdown process.
- getBoundingSet
- Returns the bounding set of tenant identifiers that the provided account belongs to. A null
string is returned if the account has no bounding set. An empty string is returned for public
accounts. A
tenantID
may contain any Unicode characters, with the exception of tabs, carriage returns, and line feeds. Leading and trailing spaces are trimmed, and consecutive internal spaces are reduced to one. AtenantID
consisting only of spaces is reduced to an empty string, which is reserved for public content. - init
- Initializes the IBoundingSetProvider interface. This method is called during the system startup process.
If the initialization or tenantID
retrieval process fails to complete, the
init
or getBoundingSet
methods may be returned with an
UnrecoverableException
error.