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

#include <Workspace/Authentication/Basic/baauthenticator.h>

Inheritance diagram for BAAuthenticator:
[legend]

Public Member Functions

 BAAuthenticator ()
 
 ~BAAuthenticator () override
 
bool authenticate (const ServerSettings &, const QString &, const Credentials *) const override
 
- Public Member Functions inherited from Authenticator
 Authenticator ()=default
 
 Authenticator (const Authenticator &)=delete
 
virtual ~Authenticator ()=default
 
virtual bool authenticate (const ServerSettings &, const QString &providerVersionNumber, const Credentials *) const =0
 
Authenticatoroperator= (const Authenticator &)=delete
 

Detailed Description

An authenticator that performs user name and password authentication.

Constructor & Destructor Documentation

◆ BAAuthenticator()

BAAuthenticator ( )
default

◆ ~BAAuthenticator()

~BAAuthenticator ( )
overridedefault

Member Function Documentation

◆ authenticate()

bool authenticate ( const ServerSettings settings,
const QString &  recvdProviderVersionNumber,
const Credentials credentials 
) const
overridevirtual

Authenticates the provided user name and password based credentials against pre-authenticated credentials that exist in the provided authentication store.

Parameters
settingsThe settings store that contains pre-authenticated users.
recvdProviderVersionNumberThe version number of the provider that was used to generate the supplied credentials.
credentialsThe credentials to authenticate.

Implements Authenticator.