SASLMechanismFactory Class Reference
Constructs SASL mechanism objects. More...
Inheritance diagram for SASLMechanismFactory:
Collaboration diagram for SASLMechanismFactory:
Classes | |
| class | registeredMechanism |
| class | registeredMechanismImpl |
Public Member Functions | |
| template<typename MECH_CLASS > | |
| void | registerMechanism (const string &name) |
| ref< SASLMechanism > | create (ref< SASLContext > ctx, const string &name) |
| const std::vector< string > | getSupportedMechanisms () const |
| bool | isMechanismSupported (const string &name) const |
Static Public Member Functions | |
| static SASLMechanismFactory * | getInstance () |
Detailed Description
Constructs SASL mechanism objects.
Member Function Documentation
| ref< SASLMechanism > create | ( | ref< SASLContext > | ctx, | |
| const string & | name | |||
| ) |
Create a mechanism object given its name.
- Parameters:
-
ctx SASL context name mechanism name
- Returns:
- a new mechanism object
- Exceptions:
-
exceptions::no_such_mechanism if no mechanism is registered for the specified name
References stringUtils::toUpper().
Referenced by SASLContext::createMechanism().
| SASLMechanismFactory * getInstance | ( | ) | [static] |
Referenced by SASLContext::createMechanism().
| const std::vector< string > getSupportedMechanisms | ( | ) | const |
Return a list of supported mechanisms.
This includes mechanisms registered using registerMechanism() as well as the ones that are built-in.
- Returns:
- list of supported mechanisms
| bool isMechanismSupported | ( | const string & | name | ) | const |
Test whether an authentication mechanism is supported.
- Parameters:
-
name mechanism name
- Returns:
- true if the specified mechanism is supported, false otherwise
| void registerMechanism | ( | const string & | name | ) |
Register a mechanism into this factory, so that subsequent calls to create return a valid object for this mechanism.
- Parameters:
-
name mechanism name
The documentation for this class was generated from the following files:
