PLCnext API Documentation 25.0.2.69
Public Member Functions | List of all members
Arp::Base::Rsc::Commons::Services::IRscAuthorizator Class Referenceabstract

This interface is used to authorize a Rsc service call. More...

#include <IRscAuthorizator.hpp>

Public Member Functions

 IRscAuthorizator (void)=default
 The default constructor.
 
 IRscAuthorizator (const IRscAuthorizator &arg)=delete
 The deleted copy constructor.
 
 IRscAuthorizator (IRscAuthorizator &&arg) noexcept=default
 The default move constructor. More...
 
IRscAuthorizatoroperator= (const IRscAuthorizator &)=delete
 The deleted assignment operator.
 
IRscAuthorizatoroperator= (IRscAuthorizator &&arg) noexcept=default
 The default move-assignment operator. More...
 
virtual ~IRscAuthorizator ()=default
 The virtual destructor.
 
virtual bool IsServiceCallAllowed (const SecurityToken &securityToken, const String &objectName)=0
 This operation checks if a service call is well authorized. More...
 

Detailed Description

This interface is used to authorize a Rsc service call.

This interface is not intended for direct use, but required by RscGenerator to implement services.

Constructor & Destructor Documentation

◆ IRscAuthorizator()

Arp::Base::Rsc::Commons::Services::IRscAuthorizator::IRscAuthorizator ( IRscAuthorizator &&  arg)
defaultnoexcept

The default move constructor.

Parameters
argThe argument to move.

Member Function Documentation

◆ IsServiceCallAllowed()

virtual bool Arp::Base::Rsc::Commons::Services::IRscAuthorizator::IsServiceCallAllowed ( const SecurityToken securityToken,
const String objectName 
)
pure virtual

This operation checks if a service call is well authorized.

Parameters
securityTokenThe security token of the current connection, which is used to determine the access rights of the current user.
objectNameThe service operation name, which shall be authorized.
Returns
true if the specified service call is allowed, otherwise false.

◆ operator=()

IRscAuthorizator & Arp::Base::Rsc::Commons::Services::IRscAuthorizator::operator= ( IRscAuthorizator &&  arg)
defaultnoexcept

The default move-assignment operator.

Parameters
argThe argument to move.
Returns
This instance.

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