All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

PLMSecuritySSOCClient Class PLMSSOCredential

PLMSSOCredential
 

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


public class PLMSSOCredential

Role: This Object represents a credential.
It is a common name for any critical information used to authenticate yourself on a given System.


Constructor and Destructor Index


o PLMSSOCredential()
Construct an empty credential with a given name and value.
o PLMSSOCredential(CATUnicodeString,CATUnicodeString)
Construct a credential with a given name and value.

Method Index


o GetCredentialName(CATUnicodeString&)
Retrieve the name of the credential.
o GetCredentialValue(CATUnicodeString&)
Retrieve the value of the credential.
o operator!=(PLMSSOCredential&)
Inequality operator.
o operator=(PLMSSOCredential&)
Assignment operator from a PLMSSOCredential instance.
o operator==(PLMSSOCredential&)
Equality operator.

Constructor and Destructor


o PLMSSOCredential
public PLMSSOCredential()
Construct an empty credential with a given name and value.
o PLMSSOCredential
public PLMSSOCredential(CATUnicodeString iName,
CATUnicodeString iValue)
Construct a credential with a given name and value.
Parameters:
iName
the name of the credential.
iValue
the value of the credential.

Methods


o GetCredentialName
public HRESULT GetCredentialName(CATUnicodeString& oName)
Retrieve the name of the credential.
Parameters:
oName
the name of the credential.
Returns:
return S_OK if succesfull, E_FAIL otherwise.
o GetCredentialValue
public HRESULT GetCredentialValue(CATUnicodeString& oValue)
Retrieve the value of the credential.
Parameters:
oName
the value of the credential.
Returns:
return S_OK if succesfull, E_FAIL otherwise.
o operator!=
public int operator!=( const PLMSSOCredential& iCredential)const
Inequality operator.
Parameters:
iCredential
The SSOCredential to compare with the current one.
Returns:
boolean
Legal values: 0: FALSE or Other: TRUE if both name and value are not equal, credentials are different.
o operator=
public PLMSSOCredential& operator=( const PLMSSOCredential& iCredential)
Assignment operator from a PLMSSOCredential instance.
Parameters:
iCredential
The provided credential.
Returns:
The credential resulting from the assignment.
o operator==
public int operator==( const PLMSSOCredential& iCredential)const
Equality operator.
Parameters:
iCredential
The SSOCredential to compare with the current one.
Returns:
boolean
Legal values: 0: FALSE or Other: TRUE if both name and value are equal, credentials are equal.

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

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