QuickOPC User's Guide and Reference
IEasyUAClientServerApplication Interface Methods

OpcLabs.EasyOpcUA Assembly > OpcLabs.EasyOpc.UA.Application Namespace : IEasyUAClientServerApplication Interface

For a list of all members of this type, see IEasyUAClientServerApplication members.

Public Methods
 NameDescription
 MethodAssures presence and validity of the own certificate the application is currently configured to use.  
 MethodBegins an asynchronous operation that obtains a new application own certificate from the certificate manager, and stores it for subsequent usage.  
 MethodCancels an asynchronous operation started with the BeginObtainNewCertificate method.  
 MethodCreates the own certificate the application is currently configured to use.  
 MethodHandles the end of the asynchronous operation started by the BeginObtainNewCertificate method.  
 MethodExports the OPC UA application configuration data into an XML stream.  
 MethodExports the own certificate and optionally its private key to a given file.  
 MethodExports the registration data of the OPC UA application into an XML stream.  
 MethodExports the security settings of the OPC UA application into an XML stream.  
 MethodFinds all registrations for this application URI in the GDS.  
 MethodFinds the own certificate the application is currently configured to use.  
 MethodGets the subject distinguished name the application is configured to use for its certificates.  
 MethodGets the effective OPC UA application manifest, i.e. the currently used application registration information together with data related to PKI administration, such as paths to the certificate stores used.  
 MethodDetermines strength of the password that is configured for use with the given certificate.  
 MethodImports the own certificate and its private key from a given file.  
 MethodFinds all application certificate sub-ids.  
 MethodRetrieves certificate type elements for the certificate types available for a given application store kind.  
 MethodProtects or unprotects the private key of the given certificate.  
 MethodRetrieves the current trust lists for the application from the certificate manager, and refreshes own certificate stores accordingly.  
 MethodCreates an application registration in the GDS, assigning it a new application ID. Existing registrations with the same application URI are removed first.  
 MethodRemoves the own certificates the application is currently configured to use.  
 MethodRemoves the password used to access the private key for given certificate.  
 MethodSets the password used to access the private key for given certificate.  
 MethodRemoves an application registration from the GDS, if it exists. All existing registrations for the application URI are removed.  
 MethodUpdates an application registration in the GDS, keeping its application ID. A new registration is created if the application is not yet registered in the GDS. Preexisting registrations with the same application URI are removed.  
 MethodValidates the own certificate the application is currently configured to use.  
Top
Extension Methods
 NameDescription
Public Extension MethodOverloaded. Assures presence of the own certificate the application is currently configured to use.Returns true if a new certificate has been created. Returns false if an existing certificate was found and accepted as the current own certificate.

If the own certificate does not exist in the certificate store prior to the operation, the method creates it. Otherwise, the method also checks whether the instance certificate is present in the trusted peers certificate store, and if it is absent, it copies it there. This is in contrast to the OpcLabs.EasyOpc.UA.Application.IEasyUAClientServerApplication.CreateOwnCertificate method, which always creates a new certificate when successful.

.NET

Public Extension MethodOverloaded. Begins an asynchronous operation that obtains a new application own certificate from the certificate manager, and stores it for subsequent usage.
Public Extension MethodOverloaded. Creates the own certificate the application is currently configured to use.
Public Extension MethodExports the OPC UA application configuration data into an XML file.
Public Extension MethodExports the OPC UA application manifest into a stream.
Public Extension MethodExports the OPC UA application manifest into an XML file.
Public Extension MethodOverloaded. Exports the own certificate and optionally its private key to a given file.
Public Extension MethodExports the registration data of the OPC UA application into an XML file.
Public Extension MethodExports the security settings of the OPC UA application into an XML file.
Public Extension MethodFinds the own certificate the application is currently configured to use.
Public Extension MethodGets the OPC UA registration information for this application.
Public Extension MethodGets an application ID assigned to the application by a specified GDS.
Public Extension MethodGets the subject distinguished name the application is configured to use for its certificates.
Public Extension MethodGets a dictionary of certificate subject names corresponding to all application certificate sub-ids.
Public Extension MethodDetermines strength of the password that is configured for use with the default certificate.
Public Extension MethodOverloaded. Determines whether the application's own certificate is present.Returns true if the application's own certificate is present in the certificate store. Returns false otherwise.
Public Extension MethodOverloaded. Determines whether a non-empty password is in use for the default certificate.
Public Extension MethodImports the own default certificate and its private key from a given file.
Public Extension MethodRetrieves certificate type elements available for an application instance.
Public Extension MethodOverloaded. Obtains a new application own certificate from the certificate manager, and stores it for subsequent usage.Returns the certificate obtained from the certificate manager.

The operation is synchronous. It can take considerable time to execute, 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 an alternative based on asynchronous programming model (APM, System.IAsyncResult) pattern, see the BeginObtainNewCertificate method and related extension methods.

For a task-based asynchronous programming pattern alternative, see the ObtainNewCertificateAsync(IEasyUAClientServerApplication,UAEndpointDescriptor) extension method and its overloads.

Public Extension MethodOverloaded. Asynchronously obtains a new application own certificate from the certificate manager, and stores it for subsequent usage.Returns a task that represents the asynchronous operation. The value of the TResult contains the certificate obtained from the certificate manager.

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 ObtainNewCertificate(IEasyUAClientServerApplication,UAEndpointDescriptor) extension method and its overloads.

For an alternative based on asynchronous programming model (APM, System.IAsyncResult) pattern, see the BeginObtainNewCertificate method and related extension methods.

Public Extension MethodProtects or unprotects the private key of the default certificate.
Public Extension MethodOverloaded. Protects the private key of the default certificate.
Public Extension MethodRetrieves the current trust lists for the application from the certificate manager, and refreshes own certificate stores accordingly.
Public Extension MethodOverloaded. Removes the own default certificate the application is currently configured to use.
Public Extension MethodSets the password used to access the private key for the default certificate.
Public Extension MethodShows the form which allows the interactive user to administer the OPC UA application modally.
Public Extension MethodOverloaded. Unprotects the private key of the default certificate.
Public Extension MethodOverloaded. Validates the own certificate the application is currently configured to use.

The own certificate must exist in the certificate store prior to the operation, otherwise an error is reported.

Top
See Also

Reference

IEasyUAClientServerApplication Interface
OpcLabs.EasyOpc.UA.Application Namespace