This interface should be implemented by loadable UserManager modules, e.g. for providing customized user authentication methods. More...
#include <IUmModule.hpp>
Inheritance diagram for Arp::System::Um::Commons::Modules::IUmModule:
Public Types | |
| using | Ptr = std::unique_ptr< IUmModule > |
Public Member Functions | |
| IUmModule (void)=default | |
| Constructs an IUmModule instance. | |
| IUmModule (const IUmModule &arg)=default | |
| Copy constructor. | |
| IUmModule (IUmModule &&arg)=default | |
| Move constructor. | |
| IUmModule & | operator= (const IUmModule &arg)=default |
| Copy-assignment operator. | |
| IUmModule & | operator= (IUmModule &&arg)=default |
| Move-assignment operator. | |
| virtual | ~IUmModule (void)=default |
| Destructs this instance and frees all resources. | |
| virtual String | GetModuleName () const =0 |
| Return module name More... | |
| virtual bool | SetupModule (const String &settingsPath)=0 |
| Called by UmModuleManager, in order to setup the module. The IUmModule implementation should read its config file here, and register authentication providers. | |
| virtual bool | ResetModule ()=0 |
| Called by UmModuleManager, in order to reset/stop the module. | |
Detailed Description
This interface should be implemented by loadable UserManager modules, e.g. for providing customized user authentication methods.
Member Function Documentation
◆ GetModuleName()
|
pure virtual |
Return module name
Implemented in Arp::System::Um::Commons::Modules::UmModuleBase.
The documentation for this class was generated from the following file:
- Arp/System/Um/Commons/Modules/IUmModule.hpp
