All Frameworks  Class Hierarchy  This Framework  Previous  Indexes

PLMSecuritySSOCClient Class PLMSSOCredentialSet

PLMSSOCredentialSet
 

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


public class PLMSSOCredentialSet

Role: This Object represents a credentialSet.
It is a container for a set of credentials for a given instance of application.


Constructor and Destructor Index


o PLMSSOCredentialSet()
The default constructor of a PLMSSOCredentialSet.
o ~PLMSSOCredentialSet()

Method Index


o AddCredential(PLMSSOCredential)
Add a PLMSSOCredential to this PLMSSOCredentialSet.
o GetApplicationName(CATUnicodeString&)
Retrieve the name of the application for which the PLMSSOCredentialSet has been defined for.
o GetCredential(CATUnicodeString,PLMSSOCredential&)
Gives a credential added earlier from its name.
o GetInstanceName(CATUnicodeString&)
Retrieve the name of the instance of the application for which the PLMSSOCredentialSet has been defined for
o RemoveCredential(PLMSSOCredential)
Remove a PLMSSOCredential to this PLMSSOCredentialSet.
o SetApplicationName(CATUnicodeString&)
Sets the name of the application for which the PLMSSOCredentialSet has been defined for.
o SetInstanceName(CATUnicodeString&)
Sets the name of the instance of the application for which the PLMSSOCredentialSet has been defined for.
o Size()
Retrieve the number of credentials contained in the PLMSSOCredentialSet.
o operator[](int)
Returns the PLMSSOCredential at the given iIndex.

Constructor and Destructor


o PLMSSOCredentialSet
public PLMSSOCredentialSet()
The default constructor of a PLMSSOCredentialSet.
o ~PLMSSOCredentialSet
public ~PLMSSOCredentialSet()

Methods


o AddCredential
public HRESULT AddCredential(PLMSSOCredential iCredential)
Add a PLMSSOCredential to this PLMSSOCredentialSet.
Parameters:
iCredential
the credential to be added.
Returns:
return S_OK if succesfull, E_FAIL otherwise.
o GetApplicationName
public HRESULT GetApplicationName(CATUnicodeString& oApplicationName)
Retrieve the name of the application for which the PLMSSOCredentialSet has been defined for.
Parameters:
oApplicationName
the name of the application to be retrieved.
Returns:
return S_OK if succesfull, E_FAIL otherwise.
o GetCredential
public HRESULT GetCredential(CATUnicodeString iName,
PLMSSOCredential& oCredential)
Gives a credential added earlier from its name.
Parameters:
iName
the name of the credential to be retrieved.
oCredential
the returned PLMSSOCredential.
Returns:
return S_OK if succesfull, E_FAIL otherwise.
o GetInstanceName
public HRESULT GetInstanceName(CATUnicodeString& oInstanceName)
Retrieve the name of the instance of the application for which the PLMSSOCredentialSet has been defined for
Parameters:
oApplicationName
the name of the application to be retrieved.
Returns:
return S_OK if succesfull, E_FAIL otherwise.
o RemoveCredential
public HRESULT RemoveCredential(PLMSSOCredential iCredential)
Remove a PLMSSOCredential to this PLMSSOCredentialSet.
Parameters:
iCredential
the credential to be removed.
Returns:
return S_OK if succesfull, E_FAIL otherwise.
o SetApplicationName
public void SetApplicationName(CATUnicodeString& iApplicationName)
Sets the name of the application for which the PLMSSOCredentialSet has been defined for.
Parameters:
iApplicationName
the name of the application to be set.
o SetInstanceName
public void SetInstanceName(CATUnicodeString& iInstanceName)
Sets the name of the instance of the application for which the PLMSSOCredentialSet has been defined for.
Parameters:
iInstanceName
the name of the instance to be set.
o Size
public int Size()
Retrieve the number of credentials contained in the PLMSSOCredentialSet.
Returns:
the size of the PLMSSOCredentialSet.
o operator[]
public PLMSSOCredential& operator[](int iIndex)const
Returns the PLMSSOCredential at the given iIndex. An index ranges from 1 to the size of the credentialSet.
Parameters:
iIndex
the index of the PLMSSOCredential to retrieve.

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

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