SignOn::AbstractSecretsStorage Class
Interface for secrets storage implementations. More...
- Header:
#include <SignOn/AbstractSecretsStorage> - Inherits: QObject
List of all members, including inherited members
Public Functions
- AbstractSecretsStorage(QObject *parent = 0)
- bool checkPassword(const quint32 id, const QString &username, const QString &password)
- bool clear()
- void clearError()
- bool close()
- bool initialize(const QVariantMap &configuration)
- bool isOpen() const
- SignOn::CredentialsDBError lastError() const
- bool loadCredentials(const quint32 id, QString &username, QString &password)
- QVariantMap loadData(quint32 id, quint32 method)
- bool removeCredentials(const quint32 id)
- bool removeData(quint32 id, quint32 method)
- bool storeData(quint32 id, quint32 method, const QVariantMap &data)
- bool updateCredentials(const quint32 id, const QString &username, const QString &password)
Protected Functions
Detailed Description
Member Function Documentation
[explicit] AbstractSecretsStorage::AbstractSecretsStorage(QObject *parent = 0)
Constructor, with the given parent.
[virtual] bool AbstractSecretsStorage::checkPassword(const quint32 id, const QString &username, const QString &password)
Checks whether username and password are correct for the identity id. Returns true if username and password match.
[pure virtual] bool AbstractSecretsStorage::clear()
Removes all stored secrets. Returns true if successful, false otherwise.
void AbstractSecretsStorage::clearError()
Clear the last error.
[virtual] bool AbstractSecretsStorage::close()
Closes the secrets DB. To reopen it, call initialize(). Returns true if successful, false otherwise.
[pure virtual] bool AbstractSecretsStorage::initialize(const QVariantMap &configuration)
Initializes and opens the secrets DB. The implementation should take care of creating the DB, if it doesn't exist. configuration is a dictionary of configuration options, dependent on the specific SecretsStorage implementation.
Returns true if successful, false otherwise.
bool AbstractSecretsStorage::isOpen() const
Whether the secrets DB is open.
See also setIsOpen()
SignOn::CredentialsDBError AbstractSecretsStorage::lastError() const
Get the last error.
See also setLastError()
[pure virtual] bool AbstractSecretsStorage::loadCredentials(const quint32 id, QString &username, QString &password)
Loads the credentials of the identity id into username and password. Returns true if successful, false otherwise.
[pure virtual] QVariantMap AbstractSecretsStorage::loadData(quint32 id, quint32 method)
Loads extra secret data of the identity id for the authentication method. Returns a dictionary with the data.
[pure virtual] bool AbstractSecretsStorage::removeCredentials(const quint32 id)
Remove the credentials for the identity id. Returns true if successful, false otherwise.
[pure virtual] bool AbstractSecretsStorage::removeData(quint32 id, quint32 method)
Removes extra secret data of the identity id for the authentication method. Returns true if successful, false otherwise.
[protected] void AbstractSecretsStorage::setIsOpen(bool isOpen)
Implementations record whether the DB isOpen.
See also isOpen()
[protected] void AbstractSecretsStorage::setLastError(const SignOn::CredentialsDBError &error)
Implementations record the last error.
See also lastError()
[pure virtual] bool AbstractSecretsStorage::storeData(quint32 id, quint32 method, const QVariantMap &data)
Stores extra secret data of the identity id for the authentication method. Calling this method replaces any data which was previously stored for the given id/method. Returns true if successful, false otherwise.
[pure virtual] bool AbstractSecretsStorage::updateCredentials(const quint32 id, const QString &username, const QString &password)
Stores/updates the credentials username and password for the identity id. Returns true if successful, false otherwise.