com.cognos.CAM_AAA.authentication

Interface IVisa

All Known Subinterfaces:

IRestorableVisa

public interface IVisa

Defines the interface to be used for implementing a visa. A visa is used to maintain state information for the logged on user. A visa is tied to a user's session.

Method Summary

Modifier and Type	Method and Description
ICredential	generateCredential(IBiBusHeader theBiBusHeader) Generates credentials for the user.
ITrustedCredential	generateTrustedCredential(IBiBusHeader theBiBusHeader) Generates trusted credentials for the user.
IAccount	getAccount() Returns information about the logged on user.
IGroup[]	getGroups() Returns the groups of which the user is a member.
IRole[]	getRoles() Returns the roles of which the user is a member.
boolean	isValid() Verifies whether a visa is still valid.

Method Detail

generateTrustedCredential

ITrustedCredential generateTrustedCredential(IBiBusHeader theBiBusHeader)
                                      throws UserRecoverableException,
                                             SystemRecoverableException,
                                             UnrecoverableException

Generates trusted credentials for the user. A trusted credential contains authentication information that is stored for a later usage and does not expire.

Parameters:

theBiBusHeader - Request containing the information used to generate this trusted credential for the user.

Returns:

Valid trusted credentials for the owner of the visa.

Throws:

UserRecoverableException - Indicates that this trusted credential cannot be generated using the available information. It may be possible to generate a trusted credential after interacting with the user.

SystemRecoverableException - Indicates that this trusted credential cannot be generated using the available information. It may be possible to generate a trusted after interacting with the system.

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

generateCredential

ICredential generateCredential(IBiBusHeader theBiBusHeader)
                        throws UserRecoverableException,
                               SystemRecoverableException,
                               UnrecoverableException

Generates credentials for the user. A credential contains authentication information that can be used to achieve SSO with the database system. Unlike trusted credentials, this type of credential is not stored anywhere and can expire.

Parameters:

theBiBusHeader - Request containing the information used to generate the credential for the caller.

Returns:

Valid credentials for the owner of the visa.

Throws:

UserRecoverableException - Indicates that this trusted credential cannot be generated using the available information. It may be possible to generate a trusted credential after interacting with the user.

SystemRecoverableException - Indicates that this trusted credential cannot be generated using the available information. It may be possible to generate a trusted after interacting with the system.

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

isValid

boolean isValid()

Verifies whether a visa is still valid.

Returns:

A boolean to indicate whether the visa is valid.

getAccount

IAccount getAccount()

Returns information about the logged on user.

Returns:

The account object for the logged on user.

getGroups

IGroup[] getGroups()

Returns the groups of which the user is a member.

Returns:

The groups of which the user is a member.

getRoles

IRole[] getRoles()

Returns the roles of which the user is a member.

Returns:

The roles of which the user is a member.