| | Name | Description |
|---|
 | AssureOwnCertificateOrCertificatePack | Assures presence and validity of the own certificate or certificate pack the application is currently configured to use. |
| AssureOwnCertificatePack | Overloaded. Assures presence of the own certificate pack the application is currently configured to use.
This method operates on certificates with certificate type Ids given by OpcLabs.EasyOpc.UA.Application.IEasyUAClientServerApplication.PackCertificateTypeIds.
The AssureOwnCertificatePack methods check if the application has its own application certificate pack (according to application configuration), and create the certificate pack if it is missing. Returns true if a new certificate pack has been created. Returns false if an existing certificate pack was found and accepted as the current own certificate pack.
If the own certificate pack does not exist in the certificate store prior to the operation, the method creates it. Otherwise, the method also checks whether the instance certificates are present in the trusted peers certificate store, and if they are absent, it copies them there. This is in contrast to the OpcLabs.EasyOpc.UA.Application.IEasyUAClientServerApplication.CreateOwnCertificateOrCertificatePack method, which always creates new certificate(s) when successful. |
| AssureOwnTrustedPeersCertificatePack | Overloaded. Assures the presence of the own application certificate pack in the trusted peers certificate store, specifying certificate sub-id. |
| BeginObtainNewCertificateOrCertificatePack | Overloaded. Begins obtaining a new application certificate or certificate pack from the certificate manager.
The BeginObtainNewCertificateOrCertificatePack methods begin an asynchronous operation that obtains a new application own certificate or certificate pack from the certificate manager, and stores it for subsequent usage.
When certificate pack is used, this method operates on certificates with certificate type Ids given by OpcLabs.EasyOpc.UA.Application.IEasyUAClientServerApplication.PackCertificateTypeIds. |
| BeginObtainNewCertificatePack | Overloaded. Begins obtaining a new application certificate pack from the certificate manager.
The BeginObtainNewCertificatePack methods begin an asynchronous operation that obtains a new application own certificate pack from the certificate manager, and stores it for subsequent usage.
This method operates on certificates with certificate type Ids given by OpcLabs.EasyOpc.UA.Application.IEasyUAClientServerApplication.PackCertificateTypeIds. |
| CreateOwnCertificatePack | Overloaded. Creates the own application certificate pack.
The CreateOwnCertificatePack methods create the own certificate pack the application is currently configured to use.
This method operates on certificates with certificate type Ids given by OpcLabs.EasyOpc.UA.Application.IEasyUAClientServerApplication.PackCertificateTypeIds. |
| ExportApplicationConfigurationToFile | Exports the OPC UA application configuration data into an XML file. |
| ExportApplicationManifest | Exports the OPC UA application manifest into a stream. |
| ExportApplicationManifestToFile | Exports the OPC UA application manifest into an XML file. |
| ExportOwnCertificateToFile | Overloaded. Exports the own certificate and optionally its private key to a given file. |
| ExportRegisteredApplicationToFile | Exports the registration data of the OPC UA application into an XML file. |
| ExportSecuredApplicationToFile | Exports the security settings of the OPC UA application into an XML file. |
| FindOwnCertificate | Finds the own certificate the application is currently configured to use. |
| GetApplicationElement | Gets the OPC UA registration information for this application. |
| GetApplicationId | Gets an application ID assigned to the application by a specified GDS. |
| GetCertificateSubjectName | Gets the subject distinguished name the application is configured to use for its certificates. |
| GetCertificateSubjectNameDictionary | Gets a dictionary of certificate subject names corresponding to all application certificate sub-ids. |
| GetOwnCertificatePack | Overloaded. Gets the own certificate pack the application is currently configured to use. Returns the own certificate pack, i.e. the dictionary of own certificates, keyed by the certificate type Id.
This method operates on certificates with certificate type Ids given by OpcLabs.EasyOpc.UA.Application.IEasyUAClientServerApplication.PackCertificateTypeIds.
The actual number of certificates in the application certificate pack may be lower than the count of OpcLabs.EasyOpc.UA.Application.IEasyUAClientServerApplication.PackCertificateTypeIds. This is because multiple certificate types may end up using the same certificate. For example, OpcLabs.EasyOpc.UA.Gds.AddressSpace.UACertificateTypeIds.RsaMinApplicationCertificateType specifies an application certificate with RSA key size 1024 or 2048 bits, and OpcLabs.EasyOpc.UA.Gds.AddressSpace.UACertificateTypeIds.RsaSha256ApplicationCertificateType specifies an application certificate with RSA key size 2048, 3072 or 4096 bits. A single certificate with RSA key size of 2048 bits can therefore be used with both these certificate types. |
| GetPrivateKeyPasswordStrength | Determines strength of the password that is configured for use with the default certificate. |
| HasOwnCertificateOrCertificatePack | Overloaded. Determines whether the application's own certificate or certificate pack is present.
When certificate pack is used, this method operates on certificates with certificate type Ids given by OpcLabs.EasyOpc.UA.Application.IEasyUAClientServerApplication.PackCertificateTypeIds.
If the specified certificate type Id is Null, the default certificate type Id from OpcLabs.EasyOpc.UA.Application.IEasyUAClientServerApplication.DefaultCertificateTypeId is used instead. |
| HasOwnCertificatePack | Overloaded. Determines whether the application's own certificate pack is present. Returns true if the application's own certificate pack is present in the certificate store. Returns false otherwise. |
| HasPrivateKeyPassword | Overloaded. Determines whether a non-empty password is in use for the default certificate. |
| ImportOwnCertificateFromFile | Imports the own default certificate and its private key from a given file. |
| ListCertificateTypeElements | Retrieves certificate type elements available for an application instance. |
| ObtainNewCertificateOrCertificatePack | Overloaded. Obtains a new certificate or certificate pack from the certificate manager. Returns the collection of certificates obtained from the certificate manager.
The ObtainNewCertificateOrCertificatePack methods obtain a new application own certificate or certificate pack from the certificate manager, and store it for subsequent usage.
When certificate pack is used, this method operates on certificates with certificate type Ids given by OpcLabs.EasyOpc.UA.Application.IEasyUAClientServerApplication.PackCertificateTypeIds.
If the specified certificate type Id is Null, the default certificate type Id from OpcLabs.EasyOpc.UA.Application.IEasyUAClientServerApplication.DefaultCertificateTypeId is used instead.
The actual number of certificates in the application certificate pack may be lower than the count of OpcLabs.EasyOpc.UA.Application.IEasyUAClientServerApplication.PackCertificateTypeIds. This is because multiple certificate types may end up using the same certificate. For example, OpcLabs.EasyOpc.UA.Gds.AddressSpace.UACertificateTypeIds.RsaMinApplicationCertificateType specifies an application certificate with RSA key size 1024 or 2048 bits, and OpcLabs.EasyOpc.UA.Gds.AddressSpace.UACertificateTypeIds.RsaSha256ApplicationCertificateType specifies an application certificate with RSA key size 2048, 3072 or 4096 bits. A single certificate with RSA key size of 2048 bits can therefore be used with both these certificate types.
The certificate manager may not support all certificate types in the application certificate pack. For an unsupported certificate type, the value of the certificate in the resulting dictionary is null (Nothing in Visual Basic). Unsupported certificate types do not cause the method to fail (throw an exception).
The operation is synchronous. It can take considerable time to execute, because it involves multiple steps, and waiting for a finalization of the requests by the GDS (see the OpcLabs.EasyOpc.UA.Gds.IEasyUACertificateManagement.FinishRequest method).
For an alternative based on asynchronous programming model (APM, System.IAsyncResult) pattern, see the BeginObtainNewCertificateOrCertificatePack method and related extension methods.
For a task-based asynchronous programming pattern alternative, see the ObtainNewCertificateOrCertificatePackAsync(IEasyUAClientServerApplication,UAObtainCertificateArguments) extension method and its overloads. |
| ObtainNewCertificateOrCertificatePackAsync | Overloaded. Asynchronously obtains a new certificate or certificate pack from the certificate manager. Returns a task that represents the asynchronous operation. The value of the TResult contains the collection of certificates obtained from the certificate manager.
The ObtainNewCertificateOrCertificatePackAsync methods asynchronously obtain a new application own certificate or certificate pack from the certificate manager, and store it for subsequent usage.
When certificate pack is used, this method operates on certificates with certificate type Ids given by OpcLabs.EasyOpc.UA.Application.IEasyUAClientServerApplication.PackCertificateTypeIds.
If the specified certificate type Id is Null, the default certificate type Id from OpcLabs.EasyOpc.UA.Application.IEasyUAClientServerApplication.DefaultCertificateTypeId is used instead.
The operation is asynchronous, because it involves multiple steps, and waiting for a finalization of the request by the GDS (see the OpcLabs.EasyOpc.UA.Gds.IEasyUACertificateManagement.FinishRequest method).
For a synchronous alternative, see the ObtainNewCertificateOrCertificatePack(IEasyUAClientServerApplication,UAObtainCertificateArguments) extension method and its overloads.
For an alternative based on asynchronous programming model (APM, System.IAsyncResult) pattern, see the BeginObtainNewCertificateOrCertificatePack method and related extension methods. |
| ObtainNewCertificatePack | Overloaded. Obtains a new certificate pack from the certificate manager. Returns the collection of certificates obtained from the certificate manager.
The ObtainNewCertificatePack methods obtain a new application own certificate pack from the certificate manager, and store it for subsequent usage.
When certificate pack is used, this method operates on certificates with certificate type Ids given by OpcLabs.EasyOpc.UA.Application.IEasyUAClientServerApplication.PackCertificateTypeIds.
The actual number of certificates in the application certificate pack may be lower than the count of OpcLabs.EasyOpc.UA.Application.IEasyUAClientServerApplication.PackCertificateTypeIds. This is because multiple certificate types may end up using the same certificate. For example, OpcLabs.EasyOpc.UA.Gds.AddressSpace.UACertificateTypeIds.RsaMinApplicationCertificateType specifies an application certificate with RSA key size 1024 or 2048 bits, and OpcLabs.EasyOpc.UA.Gds.AddressSpace.UACertificateTypeIds.RsaSha256ApplicationCertificateType specifies an application certificate with RSA key size 2048, 3072 or 4096 bits. A single certificate with RSA key size of 2048 bits can therefore be used with both these certificate types.
The certificate manager may not support all certificate types in the application certificate pack. For an unsupported certificate type, the value of the certificate in the resulting dictionary is null (Nothing in Visual Basic). Unsupported certificate types do not cause the method to fail (throw an exception).
The operation is synchronous. It can take considerable time to execute, because it involves multiple steps, and waiting for a finalization of the requests by the GDS (see the OpcLabs.EasyOpc.UA.Gds.IEasyUACertificateManagement.FinishRequest method).
For an alternative based on asynchronous programming model (APM, System.IAsyncResult) pattern, see the BeginObtainNewCertificatePack(IEasyUAClientServerApplication,UAEndpointDescriptor) method and related extension methods.
For a task-based asynchronous programming pattern alternative, see the ObtainNewCertificatePackAsync(IEasyUAClientServerApplication,UAEndpointDescriptor) extension method and its overloads. |
| ObtainNewCertificatePackAsync | Overloaded. Asynchronously obtains a new certificate pack from the certificate manager. Returns a task that represents the asynchronous operation. The value of the TResult contains the collection of certificates obtained from the certificate manager.
The ObtainNewCertificatePackAsync methods asynchronously obtain a new application own certificate pack from the certificate manager, and store it for subsequent usage.
When certificate pack is used, this method operates on certificates with certificate type Ids given by OpcLabs.EasyOpc.UA.Application.IEasyUAClientServerApplication.PackCertificateTypeIds.
The operation is asynchronous, because it involves multiple steps, and waiting for a finalization of the request by the GDS (see the OpcLabs.EasyOpc.UA.Gds.IEasyUACertificateManagement.FinishRequest method).
For a synchronous alternative, see the ObtainNewCertificatePack(IEasyUAClientServerApplication,UAEndpointDescriptor) extension method and its overloads.
For an alternative based on asynchronous programming model (APM, System.IAsyncResult) pattern, see the BeginObtainNewCertificatePack(IEasyUAClientServerApplication,UAEndpointDescriptor) method and related extension methods. |
| ProtectOwnCertificateOrCertificatePack | Overloaded. Protects the private key of the given certificate, or certificate pack.
When certificate pack is used, this method operates on certificates with certificate type Ids given by OpcLabs.EasyOpc.UA.Application.IEasyUAClientServerApplication.PackCertificateTypeIds.
If the specified certificate type Id is Null, the default certificate type Id from OpcLabs.EasyOpc.UA.Application.IEasyUAClientServerApplication.DefaultCertificateTypeId is used instead.
A preexisting private key password, if any, must be correctly configured in the application, for this operation to succeed. |
| ProtectOwnCertificatePack | Overloaded. Protects the private keys of the certificate pack.
This method operates on certificates with certificate type Ids given by OpcLabs.EasyOpc.UA.Application.IEasyUAClientServerApplication.PackCertificateTypeIds.
A preexisting private key password, if any, must be correctly configured in the application, for this operation to succeed. |
| RefreshTrustLists | Retrieves the current trust lists for the application from the certificate manager, and refreshes own certificate stores accordingly. |
| RemoveOwnCertificatePack | Overloaded. Removes the own application certificate pack.
This method operates on certificates with certificate type Ids given by OpcLabs.EasyOpc.UA.Application.IEasyUAClientServerApplication.PackCertificateTypeIds.
The RemoveOwnCertificatePack methods remove the own certificate pack the application is currently configured to use. |
| SetPrivateKeyPassword | Sets the password used to access the private key for the default certificate. |
| UIAdministerApplication | Shows the form which allows the interactive user to administer the OPC UA application modally. |
| UnprotectOwnCertificateOrCertificatePack | Overloaded. Unprotects the private key of the given certificate, or certificate pack.
When certificate pack is used, this method operates on certificates with certificate type Ids given by OpcLabs.EasyOpc.UA.Application.IEasyUAClientServerApplication.PackCertificateTypeIds.
If the specified certificate type Id is Null, the default certificate type Id from OpcLabs.EasyOpc.UA.Application.IEasyUAClientServerApplication.DefaultCertificateTypeId is used instead.
A preexisting private key password, if any, must be correctly configured in the application, for this operation to succeed. |
| UnprotectOwnCertificatePack | Overloaded. Unprotects the private keys of the certificate pack.
This method operates on certificates with certificate type Ids given by OpcLabs.EasyOpc.UA.Application.IEasyUAClientServerApplication.PackCertificateTypeIds.
A preexisting private key password, if any, must be correctly configured in the application, for this operation to succeed. |
| ValidateOwnCertificatePack | Overloaded. Validates the own application certificate pack.
The ValidateOwnCertificatePack methods validate the own certificate pack the application is currently configured to use.
This method operates on certificates with certificate type Ids given by OpcLabs.EasyOpc.UA.Application.IEasyUAClientServerApplication.PackCertificateTypeIds.
The own certificate must exist in the certificate store prior to the operation, otherwise an error is reported. |
