IEasyUAClientServerApplication Interface Methods

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

Public Methods

	Name	Description
	AssureOwnCertificate	Assures presence and validity of the own certificate the application is currently configured to use.
	BeginObtainNewCertificate	Begins an asynchronous operation that obtains a new application own certificate from the certificate manager, and stores it for subsequent usage.
	CancelObtainNewCertificate	Cancels an asynchronous operation started with the BeginObtainNewCertificate method.
	CreateOwnCertificate	Creates the own certificate the application is currently configured to use.
	EndObtainNewCertificate	Handles the end of the asynchronous operation started by the BeginObtainNewCertificate method.
	ExportApplicationConfiguration	Exports the OPC UA application configuration data into an XML stream.
	ExportOwnCertificateToFile	Exports the own certificate and optionally its private key to a given file.
	ExportRegisteredApplication	Exports the registration data of the OPC UA application into an XML stream.
	ExportSecuredApplication	Exports the security settings of the OPC UA application into an XML stream.
	FindGdsRegistrations	Finds all registrations for this application URI in the GDS.
	FindOwnCertificate	Finds the own certificate the application is currently configured to use.
	GetCertificateSubjectName	Gets the subject distinguished name the application is configured to use for its certificates.
	GetEffectiveApplicationManifest	Gets 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.
	GetEffectiveHostNames	Get the effective application host names.
	GetPrivateKeyPasswordStrength	Determines strength of the password that is configured for use with the given certificate.
	ImportOwnCertificateFromFile	Imports the own certificate and its private key from a given file.
	ListCertificateSubIds	Finds all application certificate sub-ids.
	ListCertificateTypeElements	Retrieves certificate type elements for the certificate types available for a given application store kind.
	ProtectOrUnprotectOwnCertificate	Protects or unprotects the private key of the given certificate.
	RefreshTrustLists	Retrieves the current trust lists for the application from the certificate manager, and refreshes own certificate stores accordingly.
	RegisterToGds	Creates an application registration in the GDS, assigning it a new application ID. Existing registrations with the same application URI are removed first.
	RemoveOwnCertificates	Removes the own certificates the application is currently configured to use.
	RemovePrivateKeyPassword	Removes the password used to access the private key for given certificate.
	SetPrivateKeyPassword	Sets the password used to access the private key for given certificate.
	UnregisterFromGds	Removes an application registration from the GDS, if it exists. All existing registrations for the application URI are removed.
	UpdateGdsRegistration	Updates 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.
	ValidateOwnCertificate	Validates the own certificate the application is currently configured to use.

Top

Extension Methods

	Name	Description
	AssureOwnCertificate	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 OpcLabs.EasyOpc.UA.Application.IEasyUAClientServerApplication.CreateOwnCertificate method, which always creates a new certificate when successful.
	BeginObtainNewCertificate	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.
	CreateOwnCertificate	Overloaded. Creates the own application certificate. The CreateOwnCertificate methods create the own certificate the application is currently configured to use.
	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.
	GetPrivateKeyPasswordStrength	Determines strength of the password that is configured for use with the default certificate.
	HasOwnCertificate	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.
	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.
	ObtainNewCertificate	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.
	ObtainNewCertificateAsync	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.
	ProtectOrUnprotectOwnCertificate	Protects or unprotects the private key of the default certificate.
	ProtectOwnCertificate	Overloaded. Protects the private key of the default certificate.
	RefreshTrustLists	Retrieves the current trust lists for the application from the certificate manager, and refreshes own certificate stores accordingly.
	RemoveOwnCertificate	Overloaded. Removes the own application certificate. The RemoveOwnCertificate methods removes the own default certificate 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.
	UnprotectOwnCertificate	Overloaded. Unprotects the private key of the default certificate.
	ValidateOwnCertificate	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

Reference

IEasyUAClientServerApplication Interface
OpcLabs.EasyOpc.UA.Application Namespace