Arp::System::Um::Commons::Modules::IUmModule Class Reference

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. More...
	IUmModule (const IUmModule &arg)=default
	Copy constructor. More...
	IUmModule (IUmModule &&arg)=default
	Move constructor. More...
IUmModule &	operator= (const IUmModule &arg)=default
	Copy-assignment operator. More...
IUmModule &	operator= (IUmModule &&arg)=default
	Move-assignment operator. More...
virtual	~IUmModule (void)=default
	Destructs this instance and frees all resources. More...
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. More...
virtual bool	ResetModule ()=0
	Called by UmModuleManager, in order to reset/stop the module. More...

Detailed Description

This interface should be implemented by loadable UserManager modules, e.g. for providing customized user authentication methods.

Constructor & Destructor Documentation

IUmModule() [1/3]

Arp::System::Um::Commons::Modules::IUmModule::IUmModule ( void  )

default

Constructs an IUmModule instance.

IUmModule() [2/3]

Arp::System::Um::Commons::Modules::IUmModule::IUmModule ( const IUmModule &  arg )

default

Copy constructor.

IUmModule() [3/3]

Arp::System::Um::Commons::Modules::IUmModule::IUmModule ( IUmModule &&  arg )

default

Move constructor.

~IUmModule()

virtual Arp::System::Um::Commons::Modules::IUmModule::~IUmModule ( void  )

virtualdefault

Destructs this instance and frees all resources.

Member Function Documentation

GetModuleName()

virtual String Arp::System::Um::Commons::Modules::IUmModule::GetModuleName ( ) const

pure virtual

Return module name

Implemented in Arp::System::Um::Commons::Modules::UmModuleBase.

operator=() [1/2]

IUmModule& Arp::System::Um::Commons::Modules::IUmModule::operator= ( const IUmModule &  arg )

default

Copy-assignment operator.

operator=() [2/2]

IUmModule& Arp::System::Um::Commons::Modules::IUmModule::operator= ( IUmModule &&  arg )

default

Move-assignment operator.

ResetModule()

virtual bool Arp::System::Um::Commons::Modules::IUmModule::ResetModule ( )

pure virtual

Called by UmModuleManager, in order to reset/stop the module.

SetupModule()

virtual bool Arp::System::Um::Commons::Modules::IUmModule::SetupModule ( const String &  settingsPath )

pure virtual

Called by UmModuleManager, in order to setup the module. The IUmModule implementation should read its config file here, and register authentication providers.

---

The documentation for this class was generated from the following file:

• Arp/System/Um/Commons/Modules/IUmModule.hpp