RevokeOwnCertificatesOrCertificatePack Method (AbstractEasyUAClientServerApplication)

The endpoint of OPC UA Global Discovery Server (GDS).

Because the OpcLabs.EasyOpc.UA.UAEndpointDescriptor has implicit conversions from System.String and System.Uri, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a string (representing the endpoint URL, or a so-called OPC UA endpoint descriptor string), or a System.Uri object, in place of this parameter, and the corresponding endpoint descriptor will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the OpcLabs.EasyOpc.UA.UAEndpointDescriptor.FromString or OpcLabs.EasyOpc.UA.UAEndpointDescriptor.FromUri static method instead.

If you are using OPC Wizard (for server development), an implicit conversion from OpcLabs.EasyOpc.UA.EasyUAServerCore can be used in the same way to simply pass the server object in place of this parameter, which will use its OpcLabs.EasyOpc.UA.EasyUAServerCore.EffectiveServerDescriptor property for the connection.

The value of this parameter cannot be null (Nothing in Visual Basic).

Revokes the own certificates or certificate pack issued by the Certificate Manager (CM).

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Function RevokeOwnCertificatesOrCertificatePack( _
   ByVal gdsEndpointDescriptor As UAEndpointDescriptor, _
   ByVal certificateSubIdPattern As String, _
   ByVal certificateTypeId As UANodeId _
) As Integer

'Usage
 
Dim instance As AbstractEasyUAClientServerApplication
Dim gdsEndpointDescriptor As UAEndpointDescriptor
Dim certificateSubIdPattern As String
Dim certificateTypeId As UANodeId
Dim value As Integer
 
value = instance.RevokeOwnCertificatesOrCertificatePack(gdsEndpointDescriptor, certificateSubIdPattern, certificateTypeId)

public int RevokeOwnCertificatesOrCertificatePack( 
   UAEndpointDescriptor gdsEndpointDescriptor,
   string certificateSubIdPattern,
   UANodeId certificateTypeId
)

public:
int RevokeOwnCertificatesOrCertificatePack( 
   UAEndpointDescriptor^ gdsEndpointDescriptor,
   String^ certificateSubIdPattern,
   UANodeId^ certificateTypeId
)

Parameters

gdsEndpointDescriptor

The endpoint of OPC UA Global Discovery Server (GDS).

The value of this parameter cannot be null (Nothing in Visual Basic).

certificateSubIdPattern

The match pattern for the certificate sub-ids. Normally an empty string.

The value of this parameter cannot be null (Nothing in Visual Basic).

certificateTypeId

The certificate type Id, or null (Nothing in Visual Basic) for certificate pack.

Because the OpcLabs.EasyOpc.UA.AddressSpace.UANodeId has an implicit conversion from System.String, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a string (representing the expanded text of the nodeId) in place of this parameter, and the corresponding OPC UA node Id will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the OpcLabs.EasyOpc.UA.AddressSpace.UANodeId.UANodeId Constructor(String) constructor instead.

The value of this parameter can be null (Nothing in Visual Basic).

Return Value

Returns the number of certificates that have been revoked.

Exceptions

Exception Description

Exception	Description
System.ArgumentNullException	A `null` reference (`Nothing` in Visual Basic) is passed to a method that does not accept it as a valid argument. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.
System.ObjectDisposedException	An operation was performed on a disposed object.
OpcLabs.EasyOpc.UA.OperationModel.UAException	The OPC UA operation has failed. This operation exception in uniformly used to allow common handling of various kinds of errors. The System.Exception.InnerException always contains information about the actual error cause. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

System.ArgumentNullException

A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

System.ObjectDisposedException An operation was performed on a disposed object.

OpcLabs.EasyOpc.UA.OperationModel.UAException

The OPC UA operation has failed. This operation exception in uniformly used to allow common handling of various kinds of errors. The System.Exception.InnerException always contains information about the actual error cause.

This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

Remarks

When certificate pack is used, this method operates on certificates with certificate type Ids given by PackCertificateTypeIds.

If the specified certificate type Id is OpcLabs.EasyOpc.UA.AddressSpace.UANodeId.Null, the default certificate type Id from DefaultCertificateTypeId is used instead.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

Reference

AbstractEasyUAClientServerApplication Class
AbstractEasyUAClientServerApplication Members

Documentation Home, Send Feedback. Resources: Knowledge Base, Product Downloads. Technical support: Online Forums, FAQ.

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.