Workspace 6.21.5
Public Member Functions | Static Public Member Functions | List of all members
ProviderManager Class Reference

Maintains a list of authentication providers. More...

#include <Authentication/Common/providermanager.h>

Public Member Functions

 ProviderManager (const ProviderManager &)=delete
 
void addProvider (Provider &provider)
 
int count () const
 
bool empty () const
 
ProvidergetByName (const QString &methodName) const
 
void load (const QStringList &paths)
 
ProviderManageroperator= (const ProviderManager &)=delete
 
Provideroperator[] (int index)
 
void removeProvider (Provider &provider)
 

Static Public Member Functions

static QString getFrameworkVersion ()
 
static ProviderManagergetInstance ()
 

Detailed Description

See also
Provider

Constructor & Destructor Documentation

◆ ProviderManager()

ProviderManager ( const ProviderManager )
delete

Member Function Documentation

◆ addProvider()

void addProvider ( Provider provider)

Adds a Provider to the provider collection.

Parameters
providerThe Provider to add.

◆ count()

int count ( ) const

Returns a count of the Providers in the collection.

Returns
A count of Providers in the collection.

◆ empty()

bool empty ( ) const

Indicates if the Provider collection is empty or not.

Returns
Returns true if the provider collection is empty.

◆ getByName()

Provider * getByName ( const QString &  name) const

Returns the provider with the specified name or null if none exists.

Returns
A provider with the specified name.

◆ getFrameworkVersion()

QString getFrameworkVersion ( )
static

Returns the version of the authentication framework.

Returns
The authentication framework version.

◆ getInstance()

ProviderManager & getInstance ( )
static

Returns the singleton instance of the ProviderManager.

Returns
Singleton instance of the ProviderManager.

◆ load()

void load ( const QStringList paths)

Used to load all installed providers. Now it's deprecated.

Parameters
pathsA list of paths to scan for authentication providers.
See also
ProviderManager::addProvider(SchedulerProvider&), ProviderManager::removeProvider(SchedulerProvider&)

◆ operator=()

ProviderManager & operator= ( const ProviderManager )
delete

◆ operator[]()

Provider & operator[] ( int  index)

Returns the Provider at the provided index.

Returns
Returns the provider at the specified index.

◆ removeProvider()

void removeProvider ( Provider provider)

Removes a Provider from the provider collection.

Parameters
providerThe Provider to remove from the collection.