#include <defaultAuthenticator.hpp>
Public Member Functions | |
| defaultAuthenticator () | |
| ~defaultAuthenticator () | |
| const string | getUsername () const |
| const string | getPassword () const |
| const string | getHostname () const |
| const string | getAnonymousToken () const |
| const string | getServiceName () const |
| const string | getAccessToken () const |
| void | setService (shared_ptr< net::service > serv) |
| weak_ptr< net::service > | getService () const |
Additional Inherited Members | |
 Protected Member Functions inherited from object | |
| object () | |
| object (const object &) | |
| object & | operator= (const object &) |
| virtual | ~object () |
Detailed Description
An authenticator that can provide some basic information by reading in the messaging session properties.
Constructor & Destructor Documentation
◆ defaultAuthenticator()
◆ ~defaultAuthenticator()
| ~defaultAuthenticator | ( | ) |
Member Function Documentation
◆ getAccessToken()
Return the optional access token for authentication.
This is used for example with XOAuth2 SASL authentication.
- Returns
- access token
- Exceptions
-
exceptions::no_auth_information if the information could not be provided
Implements authenticator.
References serviceInfos::property::AUTH_ACCESS_TOKEN, vmime::dynamicCast(), serviceInfos::property::getName(), and propertySet::hasProperty().
Referenced by defaultSASLAuthenticator::getAccessToken().
◆ getAnonymousToken()
Return the anonymous token (usually, this is the user's email address).
- Returns
- anonymous token
- Exceptions
-
exceptions::no_auth_information if the information could not be provided
Implements authenticator.
References platform::getHandler().
Referenced by defaultSASLAuthenticator::getAnonymousToken().
◆ getHostname()
Return the local host name of the machine.
- Returns
- hostname
- Exceptions
-
exceptions::no_auth_information if the information could not be provided
Implements authenticator.
References platform::getHandler().
Referenced by defaultSASLAuthenticator::getHostname().
◆ getPassword()
Return the password of the authentication identity.
- Returns
- password
- Exceptions
-
exceptions::no_auth_information if the information could not be provided
Implements authenticator.
References serviceInfos::property::AUTH_PASSWORD, vmime::dynamicCast(), serviceInfos::property::getName(), and propertySet::hasProperty().
Referenced by defaultSASLAuthenticator::getPassword().
◆ getService()
| weak_ptr< net::service > getService | ( | ) | const |
◆ getServiceName()
Return the registered service name of the application service (eg: "imap").
This can be used by GSSAPI or DIGEST-MD5 mechanisms with SASL.
- Returns
- service name
- Exceptions
-
exceptions::no_auth_information if the information could not be provided
Implements authenticator.
◆ getUsername()
Return the authentication identity (usually, this is the username).
- Returns
- username
- Exceptions
-
exceptions::no_auth_information if the information could not be provided
Implements authenticator.
References serviceInfos::property::AUTH_USERNAME, vmime::dynamicCast(), serviceInfos::property::getName(), and propertySet::hasProperty().
Referenced by defaultSASLAuthenticator::getUsername().
◆ setService()
|
virtual |
Called by the messaging service to allow this authenticator to know which service is currently using it.
This is called just before the service starts the authentication process.
- Parameters
-
serv messaging service instance
Implements authenticator.
References vmime::dynamicCast().
Referenced by defaultSASLAuthenticator::setService().
The documentation for this class was generated from the following files:
