PLCnext API Documentation 25.0.2.69
Public Member Functions | List of all members
Arp::System::Um::Commons::IAuthenticationProvider Class Referenceabstract

Public Member Functions

 IAuthenticationProvider (const IAuthenticationProvider &arg)=delete
 
 IAuthenticationProvider (IAuthenticationProvider &&arg)=delete
 
IAuthenticationProvideroperator= (const IAuthenticationProvider &arg)=delete
 
IAuthenticationProvideroperator= (IAuthenticationProvider &&arg)=delete
 
virtual UmAuthenticationResult AuthenticateUser (const String &username, const String &password, Commons::SessionInfo &sessionInfo)=0
 This is called when the UserManager sets up a session. More...
 
virtual void OnSessionClose (Commons::SessionInfo &session)=0
 This is called when the UserManager ends a session, in case the user actively logs out or a timeout appeared. More...
 

Member Function Documentation

◆ AuthenticateUser()

virtual UmAuthenticationResult Arp::System::Um::Commons::IAuthenticationProvider::AuthenticateUser ( const String username,
const String password,
Commons::SessionInfo sessionInfo 
)
pure virtual

This is called when the UserManager sets up a session.

Parameters
sessionSession meta info. The AuthenticationProvider should use this to set the returned role list, by sessionInfo.SetRoles().

◆ OnSessionClose()

virtual void Arp::System::Um::Commons::IAuthenticationProvider::OnSessionClose ( Commons::SessionInfo session)
pure virtual

This is called when the UserManager ends a session, in case the user actively logs out or a timeout appeared.

Parameters
sessionSession meta info. Do not keep a reference on this, it is deleted after the call.

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