Celartem::CredentialInfo Class Reference

#include <cel_credprovider.h>

Inheritance diagram for Celartem::CredentialInfo:

[legend]

List of all members.

Public Member Functions
virtual String	getTarget () const =0
virtual String	getUserName () const =0
virtual String	getPassword () const =0
virtual void	confirm (bool inCredentialIsConfirmed)=0
virtual bool	isConfirmed () const =0

---

Detailed Description

This class stores a credential information returned by CredentialProvider::getCredential method. The instances of this class should be removed as soon as possible to reduce security risks.
Instances of this class is created by CredentialProvider::create, CredentialProvider::createFromStrings. For more information about CredentialProvider or authentication, see Open the Image Files that Requires Authentication.

See also:

CredentialProvider, CredentialProvider::create, CredentialProvider::createFromStrings

Definition at line 42 of file cel_credprovider.h.

---

Member Function Documentation

virtual String Celartem::CredentialInfo::getTarget

(

)

const [pure virtual]

This method returns the target of this credential information.

Returns:

The String instance that holds the credential target.

virtual String Celartem::CredentialInfo::getUserName

(

)

const [pure virtual]

This method returns the user name of this credential.
You should not preserve the information obtained by this method to some persist storage (including member variables of some class) to reduce security risks.

Returns:

The String instance that holds the user name.

virtual String Celartem::CredentialInfo::getPassword

(

)

const [pure virtual]

This method returns the password of this credential.
You should not preserve the information obtained by this method to some persist storage (including member variables of some class) to reduce security risks.

Returns:

The String instance that holds the password.

virtual void Celartem::CredentialInfo::confirm

(

bool

inCredentialIsConfirmed

)

[pure virtual]

This method is to confirm the validity of the credential and save it to the internal store. This method is useful when the CredentialProvider::getCredential method shows some dialog and the user checks "Save this password" checkbox.
Please call this method if the application confirms that the credential information provided by this instance is valid and the user want to save it to the CredentialProvider specific persistent (and secure) storage.

virtual bool Celartem::CredentialInfo::isConfirmed

(

)

const [pure virtual]

This method determines whether the credential is confirmed or not.

Returns:

true if the credential is confirmed; otherwise false.

---

The documentation for this class was generated from the following file:

• cel_credprovider.h

---

This document is automatically generated using doxygen 1.5.4 at Fri Jun 27 18:23:15 2008.