All Frameworks  Class Hierarchy  This Framework  Next  Indexes

PLMSecuritySSOCClient Class PLMSSOClient

PLMSSOClient
 

Usage: you must use this class as is. You should never derive it.


public class PLMSSOClient

Role: This interface enables a CAA application running within VPM Navigator to retrieve credentials when an SSO Authentication has been already performed in VPM Navigator.


Constructor and Destructor Index


o PLMSSOClient()
the default Constructor.
o ~PLMSSOClient()
the destructor.

Method Index


o GetAuthenticatedUsername(CATUnicodeString&)
Get the authenticated username.
o GetCredentialSetForApplication(CATUnicodeString,CATUnicodeString,PLMSSOCredentialSet&)
Retrieve all credentials for a given instance of a given application.
o IsAlreadyAuthenticated(CATBoolean&)
Test if the there have been an SSO authentication already.
o IsSSOActivated(CATBoolean&)
Test if the SSO runtime has been turned on.

Constructor and Destructor


o PLMSSOClient
public PLMSSOClient()
the default Constructor.
o ~PLMSSOClient
public ~PLMSSOClient()
the destructor.

Methods


o GetAuthenticatedUsername
public HRESULT GetAuthenticatedUsername(CATUnicodeString& oUserName)
Get the authenticated username.
Parameters:
oUserName:
the authenticated username.
Returns:
S_OK if successful return E_FAIL otherwise.
o GetCredentialSetForApplication
public HRESULT GetCredentialSetForApplication( const CATUnicodeString iApplicationType,
const CATUnicodeString iApplicationInstanceName,
PLMSSOCredentialSet& pCredentials)
Retrieve all credentials for a given instance of a given application. for the authenticated user.
Parameters:
iApplicationType
The name of the application you want to retrieve credentials for. this name must me the same as the one used in the .CredentialSet file in $os/resources/credentials/ folder it is name the of the attribute applicationType of the the Element Node SSOCredentialSet.
iApplicationInstanceName
The name used for credentialSet instance name in the SSO Administration Console. if a blank string is passed, the default instance of credentialSet will be returned for the given iApplicationType for the authenticatedUser.
Returns:
S_OK if successful return E_FAIL otherwise.
o IsAlreadyAuthenticated
public HRESULT IsAlreadyAuthenticated(CATBoolean& oIsAuthenticated)
Test if the there have been an SSO authentication already.
Returns:
TRUE if yes FALSE otherwise.
o IsSSOActivated
public HRESULT IsSSOActivated(CATBoolean& oIsActivated)
Test if the SSO runtime has been turned on.
Returns:
TRUE if SSO has been activated else return FALSE.

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

Copyright © 2003, Dassault Systèmes. All rights reserved.