Registry for authentication configuration storages. More...

#include <qgsauthconfigurationstorageregistry.h>

Inheritance diagram for QgsAuthConfigurationStorageRegistry:

Signals
void	storageAdded (const QString &id)
	Emitted after a storage was added.

void	storageChanged (const QString &id)
	Emitted after a storage was changed.

void	storageRemoved (const QString &id)
	Emitted after a storage was removed.

Public Member Functions
	QgsAuthConfigurationStorageRegistry ()
	Creates a new QgsAuthConfigurationStorageRegistry instance.

virtual	~QgsAuthConfigurationStorageRegistry ()

bool	addStorage (QgsAuthConfigurationStorage *storage)
	Add an authentication configuration storage to the registry.

QgsAuthConfigurationStorage *	firstReadyStorageWithCapability (Qgis::AuthConfigurationStorageCapability capability) const
	Returns the first ready (and enabled) authentication configuration storage which has the required capability.

QList< QgsAuthConfigurationStorage * >	readyStorages () const
	Returns the list of all ready (and enabled) authentication configuration storage.

QList< QgsAuthConfigurationStorage * >	readyStoragesWithCapability (Qgis::AuthConfigurationStorageCapability capability) const
	Returns the list of all ready (and enabled) authentication configuration storage with the required capability.

bool	removeStorage (const QString &id)
	Remove the authentication configuration storage identified by id from the registry.

void	setStorageOrder (const QStringList &orderIds)
	Order the storages by the specified orderIds.

QgsAuthConfigurationStorage *	storage (const QString &id) const
	Returns the storage with the specified id or `nullptr` if not found in the registry.

QList< QgsAuthConfigurationStorage * >	storages () const
	Returns the list of all registered authentication configuration storages.

Detailed Description

Registry for authentication configuration storages.

This singleton class manages a list of authentication configuration storages.

QgsAuthConfigurationStorageRegistry is not usually directly created, but rather accessed through QgsApplication::authConfigurationStorageRegistry().

Since: QGIS 3.40

Definition at line 41 of file qgsauthconfigurationstorageregistry.h.

Constructor & Destructor Documentation

◆ QgsAuthConfigurationStorageRegistry()

QgsAuthConfigurationStorageRegistry::QgsAuthConfigurationStorageRegistry ( )

Creates a new QgsAuthConfigurationStorageRegistry instance.

Definition at line 25 of file qgsauthconfigurationstorageregistry.cpp.

◆ ~QgsAuthConfigurationStorageRegistry()

QgsAuthConfigurationStorageRegistry::~QgsAuthConfigurationStorageRegistry ( )

virtual

Definition at line 29 of file qgsauthconfigurationstorageregistry.cpp.

Member Function Documentation

◆ addStorage()

bool QgsAuthConfigurationStorageRegistry::addStorage ( QgsAuthConfigurationStorage * storage )

Add an authentication configuration storage to the registry.

The registry takes ownership of the storage object.

Parameters

storage The storage to add

Returns: true if the storage was added, false if it was already present in the registry.

Note: The storage object must have a unique id.; This method must be called from the same thread the registry was created in.

Definition at line 33 of file qgsauthconfigurationstorageregistry.cpp.

◆ firstReadyStorageWithCapability()

QgsAuthConfigurationStorage * QgsAuthConfigurationStorageRegistry::firstReadyStorageWithCapability ( Qgis::AuthConfigurationStorageCapability capability ) const

Returns the first ready (and enabled) authentication configuration storage which has the required capability.

Parameters

capability The capability to look for

Definition at line 137 of file qgsauthconfigurationstorageregistry.cpp.

◆ readyStorages()

QList< QgsAuthConfigurationStorage * > QgsAuthConfigurationStorageRegistry::readyStorages ( ) const

Returns the list of all ready (and enabled) authentication configuration storage.

Definition at line 103 of file qgsauthconfigurationstorageregistry.cpp.

◆ readyStoragesWithCapability()

QList< QgsAuthConfigurationStorage * > QgsAuthConfigurationStorageRegistry::readyStoragesWithCapability ( Qgis::AuthConfigurationStorageCapability capability ) const

Returns the list of all ready (and enabled) authentication configuration storage with the required capability.

Parameters

capability The capability to look for

Definition at line 120 of file qgsauthconfigurationstorageregistry.cpp.

◆ removeStorage()

bool QgsAuthConfigurationStorageRegistry::removeStorage ( const QString & id )

Remove the authentication configuration storage identified by id from the registry.

Returns: true if the storage was removed, false if it was not present in the registry.

Note: This method must be called from the same thread the registry was created in.; The storage will be deleted.

Definition at line 69 of file qgsauthconfigurationstorageregistry.cpp.

◆ setStorageOrder()

void QgsAuthConfigurationStorageRegistry::setStorageOrder ( const QStringList & orderIds )

Order the storages by the specified orderIds.

Parameters

orderIds The ordered list of storage Ids to apply, storages not in the list will be appended at the end.

Note: This method must be called from the same thread the registry was created in.

Definition at line 168 of file qgsauthconfigurationstorageregistry.cpp.

◆ storage()

QgsAuthConfigurationStorage * QgsAuthConfigurationStorageRegistry::storage ( const QString & id ) const

Returns the storage with the specified id or nullptr if not found in the registry.

Parameters

id	The id of the storage to retrieve

Definition at line 153 of file qgsauthconfigurationstorageregistry.cpp.

◆ storageAdded

void QgsAuthConfigurationStorageRegistry::storageAdded ( const QString & id )

signal

Emitted after a storage was added.

Parameters

id	The id of the added storage

◆ storageChanged

void QgsAuthConfigurationStorageRegistry::storageChanged ( const QString & id )

signal

Emitted after a storage was changed.

Parameters

id	The id of the changed storage

◆ storageRemoved

void QgsAuthConfigurationStorageRegistry::storageRemoved ( const QString & id )

signal

Emitted after a storage was removed.

Parameters

id	The id of the removed storage

◆ storages()

QList< QgsAuthConfigurationStorage * > QgsAuthConfigurationStorageRegistry::storages ( ) const

Returns the list of all registered authentication configuration storages.

Definition at line 89 of file qgsauthconfigurationstorageregistry.cpp.

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

/build/qgis-3.39.0+git20240920+d85f3c2a281+99sid/src/core/auth/qgsauthconfigurationstorageregistry.h
/build/qgis-3.39.0+git20240920+d85f3c2a281+99sid/src/core/auth/qgsauthconfigurationstorageregistry.cpp

Signals

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ QgsAuthConfigurationStorageRegistry()

◆ ~QgsAuthConfigurationStorageRegistry()

Member Function Documentation

◆ addStorage()

◆ firstReadyStorageWithCapability()

◆ readyStorages()

◆ readyStoragesWithCapability()

◆ removeStorage()

◆ setStorageOrder()

◆ storage()

◆ storageAdded

◆ storageChanged

◆ storageRemoved

◆ storages()