#include <SASLMechanismFactory.hpp>
Public Member Functions | |
| template<typename MECH_CLASS> | |
| void | registerMechanism (const string &name) |
| shared_ptr< SASLMechanism > | create (shared_ptr< SASLContext > ctx, const string &name) |
| const std::vector< string > | getSupportedMechanisms () const |
| bool | isMechanismSupported (const string &name) const |
| bool | isBuiltinMechanism (const string &name) const |
Static Public Member Functions | |
| static SASLMechanismFactory * | getInstance () |
Additional Inherited Members | |
| Protected Member Functions inherited from object | |
| object () | |
| object (const object &) | |
| object & | operator= (const object &) |
| virtual | ~object () |
Detailed Description
Constructs SASL mechanism objects.
Member Function Documentation
◆ create()
| shared_ptr< SASLMechanism > create | ( | shared_ptr< 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 isBuiltinMechanism(), and stringUtils::toUpper().
Referenced by SASLContext::createMechanism().
◆ getInstance()
|
static |
Referenced by SASLContext::createMechanism().
◆ getSupportedMechanisms()
| 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
◆ isBuiltinMechanism()
| bool isBuiltinMechanism | ( | const string & | name | ) | const |
Test whether an authentication mechanism is directly supported by the underlying SASL library.
- Parameters
-
name mechanism name
- Returns
- true if the specified mechanism is built-in, or false otherwise
Referenced by create(), and isMechanismSupported().
◆ isMechanismSupported()
| 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
References isBuiltinMechanism().
◆ registerMechanism()
| 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:
