A specialized OPC UA client object for certificate management.
Object Model
Syntax
'Declaration<CLSCompliantAttribute(True)> <ComDefaultInterfaceAttribute(OpcLabs.EasyOpc.UA.Gds.ComTypes._EasyUACertificateManagementClient)> <ComVisibleAttribute(True)> <GuidAttribute("77433805-E74B-4DD3-ADD5-864622DE9614")> <TypeConverterAttribute(System.ComponentModel.ExpandableObjectConverter)> <DesignerCategoryAttribute("Component")> <SerializableAttribute()> Public NotInheritable Class EasyUACertificateManagementClient Inherits OpcLabs.EasyOpc.UA.EasyUASpecializedClient Implements OpcLabs.BaseLib.Arrangement.IQueryTraits, OpcLabs.BaseLib.IValueEquatable, OpcLabs.BaseLib.Licensing.ILicensingContextHolder, OpcLabs.BaseLib.Widgets.ComTypes._Widget, OpcLabs.BaseLib.Widgets.IWidget, OpcLabs.EasyOpc.UA.ComTypes._EasyUASpecializedClient, OpcLabs.EasyOpc.UA.Gds.ComTypes._EasyUACertificateManagementClient, IEasyUACertificateManagement, IEasyUACertificateManagementClient, OpcLabs.EasyOpc.UA.IEasyUASpecializedClient, System.ComponentModel.IComponent, System.ICloneable, System.IDisposable, System.IServiceProvider, System.Runtime.Serialization.ISerializable, System.Xml.Serialization.IXmlSerializable
'UsageDim instance As EasyUACertificateManagementClient
[CLSCompliant(true)] [ComDefaultInterface(OpcLabs.EasyOpc.UA.Gds.ComTypes._EasyUACertificateManagementClient)] [ComVisible(true)] [Guid("77433805-E74B-4DD3-ADD5-864622DE9614")] [TypeConverter(System.ComponentModel.ExpandableObjectConverter)] [DesignerCategory("Component")] [Serializable()] public sealed class EasyUACertificateManagementClient : OpcLabs.EasyOpc.UA.EasyUASpecializedClient, OpcLabs.BaseLib.Arrangement.IQueryTraits, OpcLabs.BaseLib.IValueEquatable, OpcLabs.BaseLib.Licensing.ILicensingContextHolder, OpcLabs.BaseLib.Widgets.ComTypes._Widget, OpcLabs.BaseLib.Widgets.IWidget, OpcLabs.EasyOpc.UA.ComTypes._EasyUASpecializedClient, OpcLabs.EasyOpc.UA.Gds.ComTypes._EasyUACertificateManagementClient, IEasyUACertificateManagement, IEasyUACertificateManagementClient, OpcLabs.EasyOpc.UA.IEasyUASpecializedClient, System.ComponentModel.IComponent, System.ICloneable, System.IDisposable, System.IServiceProvider, System.Runtime.Serialization.ISerializable, System.Xml.Serialization.IXmlSerializable
[CLSCompliant(true)] [ComDefaultInterface(OpcLabs.EasyOpc.UA.Gds.ComTypes._EasyUACertificateManagementClient)] [ComVisible(true)] [Guid("77433805-E74B-4DD3-ADD5-864622DE9614")] [TypeConverter(System.ComponentModel.ExpandableObjectConverter)] [DesignerCategory("Component")] [Serializable()] public ref class EasyUACertificateManagementClient sealed : public OpcLabs.EasyOpc.UA.EasyUASpecializedClient, OpcLabs.BaseLib.Arrangement.IQueryTraits, OpcLabs.BaseLib.IValueEquatable, OpcLabs.BaseLib.Licensing.ILicensingContextHolder, OpcLabs.BaseLib.Widgets.ComTypes._Widget, OpcLabs.BaseLib.Widgets.IWidget, OpcLabs.EasyOpc.UA.ComTypes._EasyUASpecializedClient, OpcLabs.EasyOpc.UA.Gds.ComTypes._EasyUACertificateManagementClient, IEasyUACertificateManagement, IEasyUACertificateManagementClient, OpcLabs.EasyOpc.UA.IEasyUASpecializedClient, System.ComponentModel.IComponent, System.ICloneable, System.IDisposable, System.IServiceProvider, System.Runtime.Serialization.ISerializable, System.Xml.Serialization.IXmlSerializable
Remarks
In the OPC UA specifications, the functionality covered by this type is described in Part 12: Discovery and Global Services, in the section Certificate Management Overview.
The OPC UA Certificate Management Client is a specialized OPC UA client object providing access to certificate management (CM) information model of an OPC UA Global Discovery Server (GDS). In the OPC UA specifications, the functionality covered by this type is described in Part 12: Discovery and Global Services, in the section Certificate Management Overview.
This specialized client object can be derived from IEasyUAClient Interface using the AsCertificateManagementClient Extension Method, or it can be created standalone as EasyUACertificateManagementClient Component.
This interface contains methods to communicate with the OPC UA Global Discovery Server (GDS) using its information model for certificate management, making the work of assembling the proper OPC UA method parameters and retrieving the results. The methods allow getting certificate groups, requesting key pairs or certificate signing and obtaining the results, retrieving trust lists, and more.
Before deciding to use methods provided by this specialized client, it is recommended that you have a look at the IEasyUAClientServerApplication service (see OPC UA Client-Server Application Service), available from IServiceProvider.GetService method from the IEasyUAClient interface. The client application service works on even a higher level, and conveniently combines several methods together to achieve the typically needed functionality related to GDS and certificate management in OPC UA.
Available methods are:
- BrowseCertificateGroups Method. Browses the certificate groups available in the Certificate Management information model.
- BrowseCertificateTypeTree Method. Browses the certificate types available in the Certificate Manager.
- FinishRequest Method. Finishes a certificate request started with a call to StartNewKeyPairRequest Method or StartSigningRequest Method.
- GetCertificateGroupElement Method. Returns the certificate group element for a given certificate group Id.
- GetCertificateGroupIds Method. Returns Ids of the certificate groups assigned to application.
- GetCertificateStatus Method. Checks if an application needs to update its certificate.
- GetTrustList Method. Retrieves the node ID of a trust list assigned to an application.
- StartNewKeyPairRequest Method. Starts a request for a new certificate and private key. The certificate and private key are returned in the FinishRequest response.
- StartSigningRequest Method. Initiates a request to create a certificate which uses the private key which the caller currently has. The new certificate is returned in the FinishRequest response.
There are also helper classes are available that relate to certificate management:
- UACertificateGroupIds Class. A class that declares constants for certificate group Ids.
- UACertificateTypeIds Class. A class that declares constants for certificate type Ids.
The features discussed here, or some of them, may not be available in all editions of the product. Check the Product Editions page for differences between the editions. The trial license has all features enabled (and is limited in period for which it provides valid data), but licenses for specific commercial editions may have functionality limitations.
Inheritance Hierarchy
System.Object
System.MarshalByRefObject
System.ComponentModel.Component
OpcLabs.BaseLib.Widgets.Widget
OpcLabs.EasyOpc.UA.EasyUASpecializedClient
OpcLabs.EasyOpc.UA.Gds.EasyUACertificateManagementClient
Requirements