All Frameworks Class Hierarchy This Framework Indexes Previous Next

PLMSecuritySSOCClient Interface CATIUExitCredentialsSource

Usage: you can freely reimplement this interface.

interface CATIUExitCredentialsSource

This is the interface of the CredentialsSource User Exit.
Role: This interface is a user exit, which must be implemented if a specific SSO (Single Sign-On) mechanism is needed.
This interface must be implemented on the CATUExittCredentialsSource component by creating a data extension of this object.

Method Index

o GetCredentialSetForApplication(CATUnicodeString&,CATUnicodeString&,int&,PLMSSOCredential**&): This method is be called by the SSO infrastructure when the credentials, for a given application type are requested by an application.

Methods

o GetCredentialSetForApplication

public virtual GetCredentialSetForApplication(	const	`iAppType`,
	const	`iAppInstance`,
		`oCredentialSetCount`,
		`oCredentialSet`)

This method is be called by the SSO infrastructure when the credentials, for a given application type are requested by an application. Typically, such credentials are requested when opening a connection to ENOVIA when running CATIA in SSO mode. The credentials are described in
Role: This method returns an array of pointers to PLMSSOCredential instances, representing the credential set of the given application type..

Parameters:

iAppType: Name of the application type for which credentials are requested. This name must match the one used in the .CredentialSet file in $os/resources/credentials/ folder: it is the name the of the applicationType attribute of the SSOCredentialSet node.
iAppInstance: Name of the application instance for which credentials are requested. The empty string "" is used in order to specify a default instance.
oCredentialSetCount: Number of items returned upon successful completion of this method. If the method's return code is different from S_OK, then the value of this parameter not defined.
oCredentialSet: Array of credentials which must be returned upon successful completion of this method. If the method's return code is different from S_OK, then the value of this parameter is not defined. Note that the array must be allocated using new C++ keyword: any other allocation method, such as malloc will lead to unspecified behavior.

Returns:

S_OK If the method successfully returned the credentials for the application. Otherwise, this method must return a code indicating a failure, and must use the CATError infrastructure, so as to allow proper error handling by the caller.

This object is included in the file: CATIUExitCredentialsSource.h
If needed, your Imakefile.mk should include the module: PLMSecSSOCClientInterfaces