C++ Based OPC UA Client/Server/PubSub SDK  1.7.6.537
RoleTypeOperations Class Referenceabstract

Interface to modify the configuration of a role. More...

#include <roletypeoperations.h>

Inherits ReferenceCounter.

Inherited by RoleTypeUaNode.

Public Member Functions

 RoleTypeOperations ()
 construction
 
virtual UaNodeId getNodeId () const =0
 Return the NodeId for this Role Instance. More...
 
virtual OpcUa_UInt32 getRoleId () const =0
 Return the RoleId for this Role Instance. More...
 
virtual void setRoleId (OpcUa_UInt32 roleId)=0
 Set the RoleId for this Role Instance. More...
 
virtual UaQualifiedName getBrowseName ()=0
 Return the BrowseName for this Role Instance. More...
 
virtual bool grantAccess (const Session *pSession, const UaIdentityMappingRuleType &identity) const =0
 Check if any rule grants access and check that no rule excludes the context (Endpoint, Application, User)
 
virtual UaStatus addIdentity (const UaIdentityMappingRuleType &rule)=0
 Adds an identity to the list of identity mappings for the role.
 
virtual UaStatus removeIdentity (const UaIdentityMappingRuleType &rule)=0
 Remove an identity from the list of identity mappings for the role.
 
virtual UaStatus addApplication (const UaString &applicationUri)=0
 Adds an application to the list of applications known for the role.
 
virtual UaStatus removeApplication (const UaString &applicationUri)=0
 Removes an application from the list of applications known for the role.
 
virtual UaStatus setApplicationsExclude (OpcUa_Boolean)
 Sets the applications exclude flag for the list of applications known for the role. More...
 
virtual UaStatus addEndpoint (const UaEndpointType &endpoint)=0
 Adds an enpoint to the list of enpoints known for the role.
 
virtual UaStatus removeEndpoint (const UaEndpointType &endpoint)=0
 Removes an enpoint from the list of enpoints known for the role.
 
virtual UaStatus setEndpointsExclude (OpcUa_Boolean)
 Sets the enpoints exclude flag for the list of enpoints known for the role. More...
 
- Public Member Functions inherited from ReferenceCounter
 ReferenceCounter ()
 construction
 
virtual ~ReferenceCounter ()
 destruction
 

Protected Member Functions

virtual ~RoleTypeOperations ()
 destruction
 

Detailed Description

Interface to modify the configuration of a role.

This includes to add and remove Identities, Applications, Endpoints. It is not possible to create shallow copies of this Interface.

Member Function Documentation

virtual UaQualifiedName RoleTypeOperations::getBrowseName ( )
pure virtual

Return the BrowseName for this Role Instance.

Returns
The RoleId

Implemented in RoleTypeUaNode.

virtual UaNodeId RoleTypeOperations::getNodeId ( ) const
pure virtual

Return the NodeId for this Role Instance.

Returns
The NodeId

Implemented in RoleTypeUaNode.

virtual OpcUa_UInt32 RoleTypeOperations::getRoleId ( ) const
pure virtual

Return the RoleId for this Role Instance.

Returns
The RoleId

Implemented in RoleTypeUaNode.

virtual UaStatus RoleTypeOperations::setApplicationsExclude ( OpcUa_Boolean  )
inlinevirtual

Sets the applications exclude flag for the list of applications known for the role.

The default implementation returns BadNotSupported

Reimplemented in RoleTypeUaNode.

virtual UaStatus RoleTypeOperations::setEndpointsExclude ( OpcUa_Boolean  )
inlinevirtual

Sets the enpoints exclude flag for the list of enpoints known for the role.

The default implementation returns BadNotSupported

Reimplemented in RoleTypeUaNode.

virtual void RoleTypeOperations::setRoleId ( OpcUa_UInt32  roleId)
pure virtual

Set the RoleId for this Role Instance.

Parameters
roleIdthe new roleId

Implemented in RoleTypeUaNode.


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