Reference

OpcAccessControlEntry Members

Type

OpcAccessControlEntry

Namespace

Opc.UaFx.Server

Assembly

Opc.UaFx.Advanced.dll

Package

Opc.UaFx.Advanced v2.59.0

Constructors

OpcAccessControlEntry

3 overloads

Overload	Description
OpcAccessControlEntry(OpcPrincipal)	Initializes a new instance of the OpcAccessControlEntry class using the principal specified.
OpcAccessControlEntry(OpcPrincipal, OpcAccessControlMode)	Initializes a new instance of the OpcAccessControlEntry class using the principal and operationAccessMode specified.
OpcAccessControlEntry(OpcPrincipal, OpcAccessControlMode, OpcAccessControlMode)	Initializes a new instance of the OpcAccessControlEntry class using the principal, operationAccessMode and endpointAccessMode specified.

Exceptions (all overloads)

Exception	Condition
ArgumentNullException	The principal is a null reference (Nothing in Visual Basic).

OpcAccessControlEntry(OpcPrincipal)

Initializes a new instance of the OpcAccessControlEntry class using the principal specified.

public OpcAccessControlEntry(OpcPrincipal principal)

Public Sub New(principal As OpcPrincipal)

Parameters

Name	Type	Description
principal	OpcPrincipal	The OpcPrincipal the entry applies to.

Remarks

The entry evaluates the operations and the endpoints using the mode Blacklist.

OpcAccessControlEntry(OpcPrincipal, OpcAccessControlMode)

Initializes a new instance of the OpcAccessControlEntry class using the principal and operationAccessMode specified.

public OpcAccessControlEntry(
    OpcPrincipal principal,
    OpcAccessControlMode operationAccessMode)

Public Sub New(
    principal As OpcPrincipal,
    operationAccessMode As OpcAccessControlMode)

Parameters

Name	Type	Description
principal	OpcPrincipal	The OpcPrincipal the entry applies to.
operationAccessMode	OpcAccessControlMode	One of the members defined by the OpcAccessControlMode enumeration which specifies how the entry evaluates an operation which has neither been allowed nor denied explicitly.

Remarks

The entry evaluates the endpoints using the mode Blacklist.

OpcAccessControlEntry(OpcPrincipal, OpcAccessControlMode, OpcAccessControlMode)

Initializes a new instance of the OpcAccessControlEntry class using the principal, operationAccessMode and endpointAccessMode specified.

public OpcAccessControlEntry(
    OpcPrincipal principal,
    OpcAccessControlMode operationAccessMode,
    OpcAccessControlMode endpointAccessMode)

Public Sub New(
    principal As OpcPrincipal,
    operationAccessMode As OpcAccessControlMode,
    endpointAccessMode As OpcAccessControlMode)

Parameters

Name	Type	Description
principal	OpcPrincipal	The OpcPrincipal the entry applies to.
operationAccessMode	OpcAccessControlMode	One of the members defined by the OpcAccessControlMode enumeration which specifies how the entry evaluates an operation which has neither been allowed nor denied explicitly.
endpointAccessMode	OpcAccessControlMode	One of the members defined by the OpcAccessControlMode enumeration which specifies how the entry evaluates an endpoint which has neither been enabled nor disabled explicitly.

Properties

AllowedOperations

Gets a read-only collection of the operations which have been allowed explicitly for the Principal.

public OpcOperationTypeReadOnlyCollection AllowedOperations { get; }

Public ReadOnly Property AllowedOperations As OpcOperationTypeReadOnlyCollection

Property value

OpcOperationTypeReadOnlyCollection

An instance of the OpcOperationTypeReadOnlyCollection class.

DeniedOperations

Gets a read-only collection of the operations which have been denied explicitly for the Principal.

public OpcOperationTypeReadOnlyCollection DeniedOperations { get; }

Public ReadOnly Property DeniedOperations As OpcOperationTypeReadOnlyCollection

Property value

OpcOperationTypeReadOnlyCollection

An instance of the OpcOperationTypeReadOnlyCollection class.

DisabledEndpoints

Gets a read-only collection of the endpoints which have been disabled explicitly for the Principal.

public OpcEndpointIdentityReadOnlyCollection DisabledEndpoints { get; }

Public ReadOnly Property DisabledEndpoints As OpcEndpointIdentityReadOnlyCollection

Property value

OpcEndpointIdentityReadOnlyCollection

An instance of the OpcEndpointIdentityReadOnlyCollection class.

EnabledEndpoints

Gets a read-only collection of the endpoints which have been enabled explicitly for the Principal.

public OpcEndpointIdentityReadOnlyCollection EnabledEndpoints { get; }

Public ReadOnly Property EnabledEndpoints As OpcEndpointIdentityReadOnlyCollection

Property value

OpcEndpointIdentityReadOnlyCollection

An instance of the OpcEndpointIdentityReadOnlyCollection class.

EndpointAccessMode

Gets the mode which the entry uses to evaluate an endpoint which has neither been enabled nor disabled explicitly.

public OpcAccessControlMode EndpointAccessMode { get; }

Public ReadOnly Property EndpointAccessMode As OpcAccessControlMode

Property value

OpcAccessControlMode

One of the members defined by the OpcAccessControlMode enumeration.

OperationAccessMode

Gets the mode which the entry uses to evaluate an operation which has neither been allowed nor denied explicitly.

public OpcAccessControlMode OperationAccessMode { get; }

Public ReadOnly Property OperationAccessMode As OpcAccessControlMode

Property value

OpcAccessControlMode

One of the members defined by the OpcAccessControlMode enumeration.

Principal

Gets the principal the entry applies to.

public OpcPrincipal Principal { get; }

Public ReadOnly Property Principal As OpcPrincipal

Property value

OpcPrincipal

The OpcPrincipal specified on construction.

Methods

Allow

4 overloads

Overload	Description
Allow(IEnumerable<OpcOperationType>)	Allows the operations specified explicitly for the Principal.
Allow(params OpcOperationType[])	Allows the operations specified explicitly for the Principal.
Allow(IEnumerable<OpcRequestType>)	Allows the requests of the types specified by operations explicitly for the Principal.
Allow(params OpcRequestType[])	Allows the requests of the types specified by operations explicitly for the Principal.

Allow(IEnumerable<OpcOperationType>)

Allows the operations specified explicitly for the Principal.

public OpcAccessControlEntry Allow(IEnumerable<OpcOperationType> operations)

Public Function Allow(
    operations As IEnumerable(Of OpcOperationType)) As OpcAccessControlEntry

Parameters

Name	Type	Description
operations	IEnumerable<OpcOperationType>	A sequence of OpcOperationType instances to allow.

Returns

OpcAccessControlEntry

The current OpcAccessControlEntry instance to continue with subsequent operations on this instance.

Exceptions

Exception	Condition
ArgumentNullException	The operations or one of the instances in the sequence is a null reference (Nothing in Visual Basic).

Remarks

An operation which has been denied explicitly before is removed from the DeniedOperations. Operations are compared by their Key.

Allow(params OpcOperationType[])

Allows the operations specified explicitly for the Principal.

public OpcAccessControlEntry Allow(params OpcOperationType[] operations)

Public Function Allow(
    ParamArray operations As OpcOperationType()) As OpcAccessControlEntry

Parameters

Name	Type	Description
operations	params OpcOperationType[]	An array of OpcOperationType instances to allow.

Returns

OpcAccessControlEntry

The current OpcAccessControlEntry instance to continue with subsequent operations on this instance.

Exceptions

Exception	Condition
ArgumentNullException	The operations or one of the instances in the array is a null reference (Nothing in Visual Basic).

Remarks

An operation which has been denied explicitly before is removed from the DeniedOperations. Operations are compared by their Key.

Allow(IEnumerable<OpcRequestType>)

Allows the requests of the types specified by operations explicitly for the Principal.

public OpcAccessControlEntry Allow(IEnumerable<OpcRequestType> operations)

Public Function Allow(
    operations As IEnumerable(Of OpcRequestType)) As OpcAccessControlEntry

Parameters

Name	Type	Description
operations	IEnumerable<OpcRequestType>	A sequence of members defined by the OpcRequestType enumeration which specify the requests to allow.

Returns

OpcAccessControlEntry

The current OpcAccessControlEntry instance to continue with subsequent operations on this instance.

Exceptions

Exception	Condition
ArgumentNullException	The operations is a null reference (Nothing in Visual Basic).

Remarks

A request type which has been denied explicitly before is removed from the DeniedOperations.

Allow(params OpcRequestType[])

Allows the requests of the types specified by operations explicitly for the Principal.

public OpcAccessControlEntry Allow(params OpcRequestType[] operations)

Public Function Allow(
    ParamArray operations As OpcRequestType()) As OpcAccessControlEntry

Parameters

Name	Type	Description
operations	params OpcRequestType[]	An array of members defined by the OpcRequestType enumeration which specify the requests to allow.

Returns

OpcAccessControlEntry

The current OpcAccessControlEntry instance to continue with subsequent operations on this instance.

Exceptions

Exception	Condition
ArgumentNullException	The operations is a null reference (Nothing in Visual Basic).

Remarks

A request type which has been denied explicitly before is removed from the DeniedOperations.

Assign

2 overloads · since v2.53

Overload	Description
Assign(IEnumerable<OpcAccessControlRole>)since v2.53	Assigns the Principal of the current OpcAccessControlEntry to the OpcAccessControlRole instances defined by roles.
Assign(params OpcAccessControlRole[])since v2.53	Assigns the Principal of the current OpcAccessControlEntry to the OpcAccessControlRole instances defined by roles.

Assign(IEnumerable<OpcAccessControlRole>)

since v2.53

Assigns the Principal of the current OpcAccessControlEntry to the OpcAccessControlRole instances defined by roles.

public OpcAccessControlEntry Assign(IEnumerable<OpcAccessControlRole> roles)

Public Function Assign(
    roles As IEnumerable(Of OpcAccessControlRole)) As OpcAccessControlEntry

Parameters

Name	Type	Description
roles	IEnumerable<OpcAccessControlRole>	A sequence of OpcAccessControlRole instances the Principal is to be assigned to.

Returns

OpcAccessControlEntry

The current OpcAccessControlEntry instance to continue with subsequent operations on this instance.

Exceptions

Exception	Condition
ArgumentNullException	The roles or one of the instances in the sequence is a null reference (Nothing in Visual Basic).

Assign(params OpcAccessControlRole[])

since v2.53

Assigns the Principal of the current OpcAccessControlEntry to the OpcAccessControlRole instances defined by roles.

public OpcAccessControlEntry Assign(params OpcAccessControlRole[] roles)

Public Function Assign(
    ParamArray roles As OpcAccessControlRole()) As OpcAccessControlEntry

Parameters

Name	Type	Description
roles	params OpcAccessControlRole[]	An array of OpcAccessControlRole instances the Principal is to be assigned to.

Returns

OpcAccessControlEntry

The current OpcAccessControlEntry instance to continue with subsequent operations on this instance.

Exceptions

Exception	Condition
ArgumentNullException	The roles or one of the instances in the array is a null reference (Nothing in Visual Basic).

Deny

4 overloads

Overload	Description
Deny(IEnumerable<OpcOperationType>)	Denies the operations specified explicitly for the Principal.
Deny(params OpcOperationType[])	Denies the operations specified explicitly for the Principal.
Deny(IEnumerable<OpcRequestType>)	Denies the requests of the types specified by operations explicitly for the Principal.
Deny(params OpcRequestType[])	Denies the requests of the types specified by operations explicitly for the Principal.

Deny(IEnumerable<OpcOperationType>)

Denies the operations specified explicitly for the Principal.

public OpcAccessControlEntry Deny(IEnumerable<OpcOperationType> operations)

Public Function Deny(
    operations As IEnumerable(Of OpcOperationType)) As OpcAccessControlEntry

Parameters

Name	Type	Description
operations	IEnumerable<OpcOperationType>	A sequence of OpcOperationType instances to deny.

Returns

OpcAccessControlEntry

The current OpcAccessControlEntry instance to continue with subsequent operations on this instance.

Exceptions

Exception	Condition
ArgumentNullException	The operations or one of the instances in the sequence is a null reference (Nothing in Visual Basic).

Remarks

An operation which has been allowed explicitly before is removed from the AllowedOperations. Operations are compared by their Key.

Deny(params OpcOperationType[])

Denies the operations specified explicitly for the Principal.

public OpcAccessControlEntry Deny(params OpcOperationType[] operations)

Public Function Deny(
    ParamArray operations As OpcOperationType()) As OpcAccessControlEntry

Parameters

Name	Type	Description
operations	params OpcOperationType[]	An array of OpcOperationType instances to deny.

Returns

OpcAccessControlEntry

The current OpcAccessControlEntry instance to continue with subsequent operations on this instance.

Exceptions

Exception	Condition
ArgumentNullException	The operations or one of the instances in the array is a null reference (Nothing in Visual Basic).

Remarks

An operation which has been allowed explicitly before is removed from the AllowedOperations. Operations are compared by their Key.

Deny(IEnumerable<OpcRequestType>)

Denies the requests of the types specified by operations explicitly for the Principal.

public OpcAccessControlEntry Deny(IEnumerable<OpcRequestType> operations)

Public Function Deny(
    operations As IEnumerable(Of OpcRequestType)) As OpcAccessControlEntry

Parameters

Name	Type	Description
operations	IEnumerable<OpcRequestType>	A sequence of members defined by the OpcRequestType enumeration which specify the requests to deny.

Returns

OpcAccessControlEntry

The current OpcAccessControlEntry instance to continue with subsequent operations on this instance.

Exceptions

Exception	Condition
ArgumentNullException	The operations is a null reference (Nothing in Visual Basic).

Remarks

A request type which has been allowed explicitly before is removed from the AllowedOperations.

Deny(params OpcRequestType[])

Denies the requests of the types specified by operations explicitly for the Principal.

public OpcAccessControlEntry Deny(params OpcRequestType[] operations)

Public Function Deny(
    ParamArray operations As OpcRequestType()) As OpcAccessControlEntry

Parameters

Name	Type	Description
operations	params OpcRequestType[]	An array of members defined by the OpcRequestType enumeration which specify the requests to deny.

Returns

OpcAccessControlEntry

The current OpcAccessControlEntry instance to continue with subsequent operations on this instance.

Exceptions

Exception	Condition
ArgumentNullException	The operations is a null reference (Nothing in Visual Basic).

Remarks

A request type which has been allowed explicitly before is removed from the AllowedOperations.

Disable

2 overloads

Overload	Description
Disable(IEnumerable<OpcEndpointIdentity>)	Disables the endpoints specified explicitly for the Principal.
Disable(params OpcEndpointIdentity[])	Disables the endpoints specified explicitly for the Principal.

Disable(IEnumerable<OpcEndpointIdentity>)

Disables the endpoints specified explicitly for the Principal.

public OpcAccessControlEntry Disable(IEnumerable<OpcEndpointIdentity> endpoints)

Public Function Disable(
    endpoints As IEnumerable(Of OpcEndpointIdentity)) As OpcAccessControlEntry

Parameters

Name	Type	Description
endpoints	IEnumerable<OpcEndpointIdentity>	A sequence of OpcEndpointIdentity instances to disable.

Returns

OpcAccessControlEntry

The current OpcAccessControlEntry instance to continue with subsequent operations on this instance.

Exceptions

Exception	Condition
ArgumentNullException	The endpoints or one of the instances in the sequence is a null reference (Nothing in Visual Basic).

Remarks

An endpoint which has been enabled explicitly before is removed from the EnabledEndpoints. Endpoints are compared by their URL and by the mode, algorithm and level of their security policy.

Disable(params OpcEndpointIdentity[])

Disables the endpoints specified explicitly for the Principal.

public OpcAccessControlEntry Disable(params OpcEndpointIdentity[] endpoints)

Public Function Disable(
    ParamArray endpoints As OpcEndpointIdentity()) As OpcAccessControlEntry

Parameters

Name	Type	Description
endpoints	params OpcEndpointIdentity[]	An array of OpcEndpointIdentity instances to disable.

Returns

OpcAccessControlEntry

The current OpcAccessControlEntry instance to continue with subsequent operations on this instance.

Exceptions

Exception	Condition
ArgumentNullException	The endpoints or one of the instances in the array is a null reference (Nothing in Visual Basic).

Remarks

An endpoint which has been enabled explicitly before is removed from the EnabledEndpoints. Endpoints are compared by their URL and by the mode, algorithm and level of their security policy.

Enable

2 overloads

Overload	Description
Enable(IEnumerable<OpcEndpointIdentity>)	Enables the endpoints specified explicitly for the Principal.
Enable(params OpcEndpointIdentity[])	Enables the endpoints specified explicitly for the Principal.

Enable(IEnumerable<OpcEndpointIdentity>)

Enables the endpoints specified explicitly for the Principal.

public OpcAccessControlEntry Enable(IEnumerable<OpcEndpointIdentity> endpoints)

Public Function Enable(
    endpoints As IEnumerable(Of OpcEndpointIdentity)) As OpcAccessControlEntry

Parameters

Name	Type	Description
endpoints	IEnumerable<OpcEndpointIdentity>	A sequence of OpcEndpointIdentity instances to enable.

Returns

OpcAccessControlEntry

The current OpcAccessControlEntry instance to continue with subsequent operations on this instance.

Exceptions

Exception	Condition
ArgumentNullException	The endpoints or one of the instances in the sequence is a null reference (Nothing in Visual Basic).

Remarks

An endpoint which has been disabled explicitly before is removed from the DisabledEndpoints. Endpoints are compared by their URL and by the mode, algorithm and level of their security policy.

Enable(params OpcEndpointIdentity[])

Enables the endpoints specified explicitly for the Principal.

public OpcAccessControlEntry Enable(params OpcEndpointIdentity[] endpoints)

Public Function Enable(
    ParamArray endpoints As OpcEndpointIdentity()) As OpcAccessControlEntry

Parameters

Name	Type	Description
endpoints	params OpcEndpointIdentity[]	An array of OpcEndpointIdentity instances to enable.

Returns

OpcAccessControlEntry

The current OpcAccessControlEntry instance to continue with subsequent operations on this instance.

Exceptions

Exception	Condition
ArgumentNullException	The endpoints or one of the instances in the array is a null reference (Nothing in Visual Basic).

Remarks

An endpoint which has been disabled explicitly before is removed from the DisabledEndpoints. Endpoints are compared by their URL and by the mode, algorithm and level of their security policy.

IsAllowed

2 overloads

Overload	Description
IsAllowed(OpcOperationType)	Determines whether the operation specified is allowed for the Principal.
IsAllowed(OpcRequestType)	Determines whether the requests of the type specified by operation are allowed for the Principal.

IsAllowed(OpcOperationType)

Determines whether the operation specified is allowed for the Principal.

public bool IsAllowed(OpcOperationType operation)

Public Function IsAllowed(operation As OpcOperationType) As Boolean

Parameters

Name	Type	Description
operation	OpcOperationType	The OpcOperationType to verify.

Returns

Boolean

The value true if the operation has been allowed explicitly or if the OperationAccessMode is Whitelist and the operation has not been denied explicitly; otherwise the value false.

Exceptions

Exception	Condition
ArgumentNullException	The operation is a null reference (Nothing in Visual Basic).

Remarks

In the mode Explicit an operation which has neither been allowed nor denied explicitly is neither allowed nor denied, so that IsAllowed and IsDenied both return false.

IsAllowed(OpcRequestType)

Determines whether the requests of the type specified by operation are allowed for the Principal.

public bool IsAllowed(OpcRequestType operation)

Public Function IsAllowed(operation As OpcRequestType) As Boolean

Parameters

Name	Type	Description
operation	OpcRequestType	One of the members defined by the OpcRequestType enumeration which specifies the requests to verify.

Returns

Boolean

The value true if the request type has been allowed explicitly or if the OperationAccessMode is Whitelist and the request type has not been denied explicitly; otherwise the value false.

IsDenied

2 overloads

Overload	Description
IsDenied(OpcOperationType)	Determines whether the operation specified is denied for the Principal.
IsDenied(OpcRequestType)	Determines whether the requests of the type specified by operation are denied for the Principal.

IsDenied(OpcOperationType)

Determines whether the operation specified is denied for the Principal.

public bool IsDenied(OpcOperationType operation)

Public Function IsDenied(operation As OpcOperationType) As Boolean

Parameters

Name	Type	Description
operation	OpcOperationType	The OpcOperationType to verify.

Returns

Boolean

The value true if the operation has been denied explicitly or if the OperationAccessMode is Blacklist and the operation has not been allowed explicitly; otherwise the value false.

Exceptions

Exception	Condition
ArgumentNullException	The operation is a null reference (Nothing in Visual Basic).

Remarks

In the mode Explicit an operation which has neither been allowed nor denied explicitly is neither allowed nor denied, so that IsAllowed and IsDenied both return false.

IsDenied(OpcRequestType)

Determines whether the requests of the type specified by operation are denied for the Principal.

public bool IsDenied(OpcRequestType operation)

Public Function IsDenied(operation As OpcRequestType) As Boolean

Parameters

Name	Type	Description
operation	OpcRequestType	One of the members defined by the OpcRequestType enumeration which specifies the requests to verify.

Returns

Boolean

The value true if the request type has been denied explicitly or if the OperationAccessMode is Blacklist and the request type has not been allowed explicitly; otherwise the value false.

IsDisabled

Determines whether the endpoint specified is disabled for the Principal.

public bool IsDisabled(OpcEndpointIdentity endpoint)

Public Function IsDisabled(endpoint As OpcEndpointIdentity) As Boolean

Parameters

Name	Type	Description
endpoint	OpcEndpointIdentity	The OpcEndpointIdentity to verify.

Returns

Boolean

The value true if the endpoint has been disabled explicitly or if the endpoint access mode specified on construction is Blacklist and the endpoint has not been enabled explicitly; otherwise the value false.

Exceptions

Exception	Condition
ArgumentNullException	The endpoint is a null reference (Nothing in Visual Basic).

Remarks

In the mode Explicit an endpoint which has neither been enabled nor disabled explicitly is neither enabled nor disabled, so that IsEnabled and IsDisabled both return false.

IsEnabled

Determines whether the endpoint specified is enabled for the Principal.

public bool IsEnabled(OpcEndpointIdentity endpoint)

Public Function IsEnabled(endpoint As OpcEndpointIdentity) As Boolean

Parameters

Name	Type	Description
endpoint	OpcEndpointIdentity	The OpcEndpointIdentity to verify.

Returns

Boolean

The value true if the endpoint has been enabled explicitly or if the endpoint access mode specified on construction is Whitelist and the endpoint has not been disabled explicitly; otherwise the value false.

Exceptions

Exception	Condition
ArgumentNullException	The endpoint is a null reference (Nothing in Visual Basic).

Remarks

In the mode Explicit an endpoint which has neither been enabled nor disabled explicitly is neither enabled nor disabled, so that IsEnabled and IsDisabled both return false.

Revoke

2 overloads · since v2.53

Overload	Description
Revoke(IEnumerable<OpcAccessControlRole>)since v2.53	Revokes the assignment of the Principal of the current OpcAccessControlEntry to the OpcAccessControlRole instances defined by roles.
Revoke(params OpcAccessControlRole[])since v2.53	Revokes the assignment of the Principal of the current OpcAccessControlEntry to the OpcAccessControlRole instances defined by roles.

Revoke(IEnumerable<OpcAccessControlRole>)

since v2.53

Revokes the assignment of the Principal of the current OpcAccessControlEntry to the OpcAccessControlRole instances defined by roles.

public OpcAccessControlEntry Revoke(IEnumerable<OpcAccessControlRole> roles)

Public Function Revoke(
    roles As IEnumerable(Of OpcAccessControlRole)) As OpcAccessControlEntry

Parameters

Name	Type	Description
roles	IEnumerable<OpcAccessControlRole>	A sequence of OpcAccessControlRole instances the Principal is to be unassigned from.

Returns

OpcAccessControlEntry

The current OpcAccessControlEntry instance to continue with subsequent operations on this instance.

Exceptions

Exception	Condition
ArgumentNullException	The roles or one of the instances in the sequence is a null reference (Nothing in Visual Basic).

Revoke(params OpcAccessControlRole[])

since v2.53

Revokes the assignment of the Principal of the current OpcAccessControlEntry to the OpcAccessControlRole instances defined by roles.

public OpcAccessControlEntry Revoke(params OpcAccessControlRole[] roles)

Public Function Revoke(
    ParamArray roles As OpcAccessControlRole()) As OpcAccessControlEntry

Parameters

Name	Type	Description
roles	params OpcAccessControlRole[]	An array of OpcAccessControlRole instances the Principal is to be unassigned from.

Returns

OpcAccessControlEntry

The current OpcAccessControlEntry instance to continue with subsequent operations on this instance.

Exceptions

Exception	Condition
ArgumentNullException	The roles or one of the instances in the array is a null reference (Nothing in Visual Basic).