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

Interface to be implemented by an additional authorization provider, which is loaded from a user-provided module. Every loaded authorization provider further restricts the default access rights. More...

#include <IAuthorizationProvider.hpp>

Public Types

using Ptr = std::shared_ptr< IAuthorizationProvider >
 

Public Member Functions

 IAuthorizationProvider (void)=default
 Constructs an IAuthorizationProvider instance.
 
 IAuthorizationProvider (const IAuthorizationProvider &arg)=default
 Copy constructor.
 
 IAuthorizationProvider (IAuthorizationProvider &&arg)=default
 Move constructor.
 
IAuthorizationProvideroperator= (const IAuthorizationProvider &arg)=default
 Copy-assignment operator.
 
IAuthorizationProvideroperator= (IAuthorizationProvider &&arg)=default
 Move-assignment operator.
 
virtual ~IAuthorizationProvider (void)=default
 Destructs this instance and frees all resources.
 
virtual boolean SessionHasPermissionOnObject (const String &objectName, Operation operation, SessionInfo &session)=0
 This is called only if the default authorization check on the session returns true, in which case the loaded authorization provider may further restrict access rights. More...
 

Detailed Description

Interface to be implemented by an additional authorization provider, which is loaded from a user-provided module. Every loaded authorization provider further restricts the default access rights.

Member Function Documentation

◆ SessionHasPermissionOnObject()

virtual boolean Arp::System::Um::Commons::IAuthorizationProvider::SessionHasPermissionOnObject ( const String objectName,
Operation  operation,
SessionInfo session 
)
pure virtual

This is called only if the default authorization check on the session returns true, in which case the loaded authorization provider may further restrict access rights.

Parameters
objectNameObject name as mentioned in permission configuration files, it identifies the object on which the operation is intended to be performed.
operationOperation as mentioned in permission configuration files
sessionSession meta info
Returns
Returns false if the permission should be blocked by this provider.

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