OPC Studio User's Guide and Reference
IEasyUAClientServerApplicationExtension Class Methods


OpcLabs.EasyOpcUA Assembly > OpcLabs.EasyOpc.UA.Application.Extensions Namespace : IEasyUAClientServerApplicationExtension Class

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

Public Methods
 NameDescription
Public Methodstatic (Shared in Visual Basic)Overloaded. Assures presence of the own certificate the application is currently configured to use.

The AssureOwnCertificate methods check if the application has its own application certificate (according to application configuration), and create the certificate if it is missing.

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 CreateOwnCertificate method, which always creates a new certificate when successful.

 
Public Methodstatic (Shared in Visual Basic)Overloaded. Begins obtaining a new application certificate from the certificate manager.

The BeginObtainNewCertificate methods begin an asynchronous operation that obtains a new application own certificate from the certificate manager, and stores it for subsequent usage.

 
Public Methodstatic (Shared in Visual Basic)Overloaded. Creates the own application certificate.

The CreateOwnCertificate methods create the own certificate the application is currently configured to use.

 
Public Method (Inherited from object)
Public Methodstatic (Shared in Visual Basic)Exports the OPC UA application configuration data into an XML file.  
Public Methodstatic (Shared in Visual Basic)Exports the OPC UA application manifest into a stream.  
Public Methodstatic (Shared in Visual Basic)Exports the OPC UA application manifest into an XML file.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Exports the own certificate and optionally its private key to a given file.  
Public Methodstatic (Shared in Visual Basic)Exports the registration data of the OPC UA application into an XML file.  
Public Methodstatic (Shared in Visual Basic)Exports the security settings of the OPC UA application into an XML file.  
Public Methodstatic (Shared in Visual Basic)Finds the own certificate the application is currently configured to use.  
Public Methodstatic (Shared in Visual Basic)Gets the OPC UA registration information for this application.  
Public Methodstatic (Shared in Visual Basic)Gets an application ID assigned to the application by a specified GDS.  
Public Methodstatic (Shared in Visual Basic)Gets the subject distinguished name the application is configured to use for its certificates.  
Public Methodstatic (Shared in Visual Basic)Gets a dictionary of certificate subject names corresponding to all application certificate sub-ids.  
Public MethodServes as the default hash function. (Inherited from object)
Public Methodstatic (Shared in Visual Basic)Determines strength of the password that is configured for use with the default certificate.  
Public MethodGets the System.Type of the current instance. (Inherited from object)
Public Methodstatic (Shared in Visual Basic)Overloaded. 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 Methodstatic (Shared in Visual Basic)Overloaded. Determines whether a non-empty password is in use for the default certificate.  
Public Methodstatic (Shared in Visual Basic)Imports the own default certificate and its private key from a given file.  
Public Methodstatic (Shared in Visual Basic)Retrieves certificate type elements available for an application instance.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Obtains a new certificate from the certificate manager.

The ObtainNewCertificate methods obtain a new application own certificate from the certificate manager, and store 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 Methodstatic (Shared in Visual Basic)Overloaded. Asynchronously obtains a new certificate from the certificate manager.

The ObtainNewCertificateAsync asynchronously obtain a new application own certificate from the certificate manager, and store 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 Methodstatic (Shared in Visual Basic)Protects or unprotects the private key of the default certificate.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Protects the private key of the default certificate.  
Public Methodstatic (Shared in Visual Basic)Retrieves the current trust lists for the application from the certificate manager, and refreshes own certificate stores accordingly.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Removes the own application certificate. The RemoveOwnCertificate methods removes the own default certificate the application is currently configured to use.

 
Public Methodstatic (Shared in Visual Basic)Sets the password used to access the private key for the default certificate.  
Public MethodReturns a string that represents the current object. (Inherited from object)
Public Methodstatic (Shared in Visual Basic)Overloaded. Unprotects the private key of the default certificate.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Validates the own application certificate.

The ValidateOwnCertificate methods 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
Protected Methods
 NameDescription
Protected MethodAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from object)
Protected MethodCreates a shallow copy of the current System.Object. (Inherited from object)
Top
Extension Methods
 NameDescription
Public Extension MethodSets the arbitrary object associated with the node.
Top
See Also

Reference

IEasyUAClientServerApplicationExtension Class
OpcLabs.EasyOpc.UA.Application.Extensions Namespace