com.cognos.CAM_AAA.authentication

Interface INamespaceAuthenticationProviderBase

All Superinterfaces:

IBaseClass, INamespace, IUiClass

All Known Subinterfaces:

INamespaceAuthenticationProvider, INamespaceAuthenticationProvider2

public interface INamespaceAuthenticationProviderBase
extends INamespace

Defines the base interface to use for implementing an IBM Cognos custom authentication provider. This interface should not be directly implemented, use the subclasses instead.

Field Summary

Fields inherited from interface com.cognos.CAM_AAA.authentication.INamespace

CapabilityCaseSensitive, CapabilityContains, CapabilityEndsWith, CapabilityEquals, CapabilityNotBrowsable, CapabilitySort, CapabilityStartsWith

Method Summary

Modifier and Type	Method and Description
void	logoff(IVisa theVisa, IBiBusHeader theBiBusHeader) Logs off the user from this authentication namespace.
IQueryResult	search(IVisa theVisa, IQuery theQuery) Retrieves a set of objects that exist within the current authentication namespace.

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

logoff

void logoff(IVisa theVisa,
            IBiBusHeader theBiBusHeader)

Logs off the user from this authentication namespace. After this call this visa will no longer be used by the system.

Parameters:

theVisa - A visa that grants access to this authentication namespace. This visa was previously issued by this authentication namespace using the logon method.

theBiBusHeader - The biBusHeader that contains the information used to authenticate the user. The biBusHeader can be modified to remove existing cookies, form fields, and so on.

search

IQueryResult search(IVisa theVisa,
                    IQuery theQuery)
             throws UnrecoverableException

Retrieves a set of objects that exist within the current authentication namespace. The result only contains the objects that the user has the appropriate permissions for. If the user is not authenticated, the result will only contain the information visible to an anonymous user.

Parameters:

theVisa - A visa that grants access to this authentication namespace, and identifies the user performing this search. This parameter will be null if the user is not authenticated in this namespace.

theQuery - The details about which objects to return.

Returns:

The result of the query.

Throws:

UnrecoverableException - An exception has occurred that interferes with the normal operation of the namespace.