com.cognos.CAM_AAA.authentication

Interface IBoundingSetProvider

  • All Superinterfaces:
    IProvider

    public interface IBoundingSetProvider
extends IProvider
    Defines the interface for implementing a custom tenant bounding set 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 getBoundingSet(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 Detail

      • getBoundingSet

        java.lang.String[] getBoundingSet(IAccount account)
                           throws UnrecoverableException
        Returns the bounding set of tenantIDs for the account.
        A null bounding set indicates that the user has no bounding set. An empty bounding set indicates that the user is bounded to public and their tenant.
        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:
        An array of the tenantIDs that make up the user's bounding set.
        Throws:
        UnrecoverableException - An exception occurred while determining the account's bounding set.
Skip navigation links
  • Summary: 
  • Nested | 
  • Field | 
  • Constr | 
  • Method
  • Detail: 
  • Field | 
  • Constr | 
  • Method