INamespaceAuthenticationProvider

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

All Superinterfaces:

IBaseClass, INamespace, INamespaceAuthenticationProviderBase, IUiClass
```
public interface INamespaceAuthenticationProvider
extends INamespaceAuthenticationProviderBase
```
Defines the interface to use for implementing an IBM Cognos custom authentication provider.

- Field Summary
  - Fields inherited from interface com.cognos.CAM_AAA.authentication.INamespace
    CapabilityCaseSensitive, CapabilityContains, CapabilityEndsWith, CapabilityEquals, CapabilityNotBrowsable, CapabilitySort, CapabilityStartsWith
- Method Summary
  
  All Methods Instance Methods Abstract Methods
  Modifier and Type Method and Description
  
  IVisa logon(IBiBusHeader theBiBusHeader)
  Logs on the user to this authentication namespace.
  - Methods inherited from interface com.cognos.CAM_AAA.authentication.INamespaceAuthenticationProviderBase
    logoff, search
  - Methods inherited from interface com.cognos.CAM_AAA.authentication.INamespace
    destroy, getCapabilities, getNamespaceFormat, init, setNamespaceFormat
  - Methods inherited from interface com.cognos.CAM_AAA.authentication.IUiClass
    getAvailableDescriptionLocales, getDescription
  - Methods inherited from interface com.cognos.CAM_AAA.authentication.IBaseClass
    getAncestors, getAvailableNameLocales, getHasChildren, getName, getObjectID

- Method Detail
  - logon
```
IVisa logon(IBiBusHeader theBiBusHeader)
     throws UserRecoverableException,
            SystemRecoverableException,
            UnrecoverableException
```
    Logs on the user to this authentication namespace.
    
    Parameters:
    
    theBiBusHeader - The biBusHeader that contains the information used to authenticate the user.
    
    Returns:
    
    A visa that grants access to the authentication namespace.
    
    Throws:
    
    UserRecoverableException - Indicates that authentication is not possible using the available information. It may be possible to authenticate after interacting with the user.
    
    SystemRecoverableException - Indicates that authentication is not possible using the available information. It may be possible to authenticate after interacting with the system.
    
    UnrecoverableException - Indicates that an exception has occurred that interferes with the normal operation of the namespace.