Workspace 6.21.5
Public Member Functions | Protected Member Functions | List of all members
Provider Class Referenceabstract

The base class of all authentication providers.

#include <Authentication/Common/provider.h>

Inheritance diagram for Provider:
[legend]

Public Member Functions

virtual CredentialscreateCredentialsFromString (const QString &)=0
 
virtual CredentialsWidgetcreateCredentialsWidget ()=0
 
CredentialscreateDefaultCredentials ()
 
virtual QString defaultCredentials ()=0
 
virtual const AuthenticatorgetAuthenticator ()=0
 
const QString & getDescription () const
 
QString getName () const
 
virtual QString getVersion () const =0
 

Protected Member Functions

 Provider (const QString &name, const QString &description)
 
virtual ~Provider ()
 

Constructor & Destructor Documentation

◆ Provider()

Provider ( const QString &  name,
const QString &  description 
)
protected

An initialising constructor.

Parameters
nameThe name of the provider
descriptionA description of the provider

◆ ~Provider()

~Provider ( )
protectedvirtual

Destructor.

Member Function Documentation

◆ createCredentialsFromString()

virtual Credentials * createCredentialsFromString ( const QString &  )
pure virtual

Implemented in BAProvider, and NoneProvider.

◆ createCredentialsWidget()

virtual CredentialsWidget * createCredentialsWidget ( )
pure virtual

Implemented in BAProvider, and NoneProvider.

◆ createDefaultCredentials()

Credentials * createDefaultCredentials ( )
inline

◆ defaultCredentials()

virtual QString defaultCredentials ( )
pure virtual

Implemented in BAProvider, and NoneProvider.

◆ getAuthenticator()

virtual const Authenticator * getAuthenticator ( )
pure virtual

Implemented in BAProvider, and NoneProvider.

◆ getDescription()

const QString & getDescription ( ) const

Returns a description of the provider.

Returns
Provider description.

◆ getName()

QString getName ( ) const

Returns the provider name.

Returns
The name of the provider.

◆ getVersion()

virtual QString getVersion ( ) const
pure virtual

Implemented in BAProvider, and NoneProvider.