defaultAuthenticator Class Reference
An authenticator that can provide some basic information by reading in the messaging session properties. More...
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 |
| void | setService (ref< net::service > serv) |
| weak_ref< net::service > | getService () const |
Detailed Description
An authenticator that can provide some basic information by reading in the messaging session properties.
Constructor & Destructor Documentation
| ~defaultAuthenticator | ( | ) |
Member Function Documentation
| const string getAnonymousToken | ( | ) | const [virtual] |
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().
| const string getHostname | ( | ) | const [virtual] |
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().
| const string getPassword | ( | ) | const [virtual] |
Return the password of the authentication identity.
- Returns:
- password
- Exceptions:
-
exceptions::no_auth_information if the information could not be provided
Implements authenticator.
References property::AUTH_PASSWORD, and propertySet::hasProperty().
Referenced by defaultSASLAuthenticator::getPassword().
| weak_ref< net::service > getService | ( | ) | const |
| const string getServiceName | ( | ) | const [virtual] |
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.
| const string getUsername | ( | ) | const [virtual] |
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 property::AUTH_USERNAME, and propertySet::hasProperty().
Referenced by defaultSASLAuthenticator::getUsername().
| void setService | ( | ref< net::service > | serv | ) | [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.
Referenced by defaultSASLAuthenticator::setService().
The documentation for this class was generated from the following files:
