QGIS API Documentation
4.3.0-Master (16eddb2670e)
Toggle main menu visibility
Loading...
Searching...
No Matches
src
core
auth
qgsauthconfigurationstorageregistry.h
Go to the documentation of this file.
1
/***************************************************************************
2
qgsauthconfigurationstorageregistry.h - QgsAuthConfigurationStorageRegistry
3
4
---------------------
5
begin : 20.6.2024
6
copyright : (C) 2024 by Alessandro Pasotti
7
email : elpaso at itopen dot it
8
***************************************************************************
9
* *
10
* This program is free software; you can redistribute it and/or modify *
11
* it under the terms of the GNU General Public License as published by *
12
* the Free Software Foundation; either version 2 of the License, or *
13
* (at your option) any later version. *
14
* *
15
***************************************************************************/
16
#ifndef QGSAUTHCONFIGURATIONSTORAGEREGISTRY_H
17
#define QGSAUTHCONFIGURATIONSTORAGEREGISTRY_H
18
19
#include <memory>
20
21
#include "
qgis.h
"
22
#include "qgis_core.h"
23
#include "
qgis_sip.h
"
24
25
#include <QMap>
26
#include <QMutex>
27
#include <QObject>
28
29
class
QgsAuthConfigurationStorage
;
30
31
42
class
CORE_EXPORT
QgsAuthConfigurationStorageRegistry
:
public
QObject
43
{
44
Q_OBJECT
45
public
:
49
QgsAuthConfigurationStorageRegistry
();
50
51
~QgsAuthConfigurationStorageRegistry
()
override
;
52
61
bool
addStorage
(
QgsAuthConfigurationStorage
*
storage
SIP_TRANSFER
);
62
69
bool
removeStorage
(
const
QString &
id
);
70
74
QList<QgsAuthConfigurationStorage *>
storages
()
const
;
75
79
QList<QgsAuthConfigurationStorage *>
readyStorages
()
const
;
80
86
QList<QgsAuthConfigurationStorage *>
readyStoragesWithCapability
(
Qgis::AuthConfigurationStorageCapability
capability )
const
;
87
92
QgsAuthConfigurationStorage
*
firstReadyStorageWithCapability
(
Qgis::AuthConfigurationStorageCapability
capability )
const
;
93
98
QgsAuthConfigurationStorage
*
storage
(
const
QString &
id
)
const
;
99
105
void
setStorageOrder
(
const
QStringList &orderIds );
106
107
108
signals:
109
114
void
storageAdded
(
const
QString &
id
);
115
120
void
storageChanged
(
const
QString &
id
);
121
126
void
storageRemoved
(
const
QString &
id
);
127
128
private
:
129
mutable
QMutex mMutex;
130
131
std::vector<std::unique_ptr<QgsAuthConfigurationStorage>> mStorages;
132
};
133
134
#endif
// QGSAUTHCONFIGURATIONSTORAGEREGISTRY_H
Qgis::AuthConfigurationStorageCapability
AuthConfigurationStorageCapability
Authentication configuration storage capabilities.
Definition
qgis.h:107
QgsAuthConfigurationStorageRegistry::storageChanged
void storageChanged(const QString &id)
Emitted after a storage was changed.
QgsAuthConfigurationStorageRegistry::setStorageOrder
void setStorageOrder(const QStringList &orderIds)
Order the storages by the specified orderIds.
Definition
qgsauthconfigurationstorageregistry.cpp:164
QgsAuthConfigurationStorageRegistry::firstReadyStorageWithCapability
QgsAuthConfigurationStorage * firstReadyStorageWithCapability(Qgis::AuthConfigurationStorageCapability capability) const
Returns the first ready (and enabled) authentication configuration storage which has the required cap...
Definition
qgsauthconfigurationstorageregistry.cpp:136
QgsAuthConfigurationStorageRegistry::removeStorage
bool removeStorage(const QString &id)
Remove the authentication configuration storage identified by id from the registry.
Definition
qgsauthconfigurationstorageregistry.cpp:72
QgsAuthConfigurationStorageRegistry::storage
QgsAuthConfigurationStorage * storage(const QString &id) const
Returns the storage with the specified id or nullptr if not found in the registry.
Definition
qgsauthconfigurationstorageregistry.cpp:150
QgsAuthConfigurationStorageRegistry::storages
QList< QgsAuthConfigurationStorage * > storages() const
Returns the list of all registered authentication configuration storages.
Definition
qgsauthconfigurationstorageregistry.cpp:91
QgsAuthConfigurationStorageRegistry::QgsAuthConfigurationStorageRegistry
QgsAuthConfigurationStorageRegistry()
Creates a new QgsAuthConfigurationStorageRegistry instance.
Definition
qgsauthconfigurationstorageregistry.cpp:31
QgsAuthConfigurationStorageRegistry::storageRemoved
void storageRemoved(const QString &id)
Emitted after a storage was removed.
QgsAuthConfigurationStorageRegistry::readyStoragesWithCapability
QList< QgsAuthConfigurationStorage * > readyStoragesWithCapability(Qgis::AuthConfigurationStorageCapability capability) const
Returns the list of all ready (and enabled) authentication configuration storage with the required ca...
Definition
qgsauthconfigurationstorageregistry.cpp:120
QgsAuthConfigurationStorageRegistry::storageAdded
void storageAdded(const QString &id)
Emitted after a storage was added.
QgsAuthConfigurationStorageRegistry::readyStorages
QList< QgsAuthConfigurationStorage * > readyStorages() const
Returns the list of all ready (and enabled) authentication configuration storage.
Definition
qgsauthconfigurationstorageregistry.cpp:104
QgsAuthConfigurationStorageRegistry::addStorage
bool addStorage(QgsAuthConfigurationStorage *storage)
Add an authentication configuration storage to the registry.
Definition
qgsauthconfigurationstorageregistry.cpp:37
QgsAuthConfigurationStorage
Abstract class that defines the interface for all authentication configuration storage implementation...
Definition
qgsauthconfigurationstorage.h:38
qgis.h
qgis_sip.h
SIP_TRANSFER
#define SIP_TRANSFER
Definition
qgis_sip.h:35
Generated on
for QGIS API Documentation by
1.17.0