.NET Based OPC UA Client/Server SDK  3.0.10.493
UnifiedAutomation.UaClient.ServerConfigurationClient Class Reference

Used to access the ServerConfigurationClient features of an OPC UA Server. More...

Inherits UnifiedAutomation.UaClient.SessionMethodHelper.

Public Member Functions

 ServerConfigurationClient (ApplicationInstanceBase application)
 Initializes a new instance of the ServerConfigurationClient class. More...
 
 ServerConfigurationClient (Session session)
 Initializes a new instance of the ServerConfigurationClient class. More...
 
ApplicationRecordDataType ReadServerInfo ()
 Reads the application metadata from the server. More...
 
IAsyncResult BeginReadServerInfo (AsyncCallback callback, object callbackData)
 Begins an operation to read the application metadata from the server. More...
 
ApplicationRecordDataType EndReadServerInfo (IAsyncResult result)
 Completes an operation to read the application metadata from the server. More...
 
bool UpdateCertificate (NodeId certificateGroupId, NodeId certificateTypeId, ICertificate certificate, ICertificate[] issuerCertificates, string privateKeyFormat, byte[] privateKey)
 Updates the certificate used by the server. More...
 
IAsyncResult BeginUpdateCertificate (NodeId certificateGroupId, NodeId certificateTypeId, ICertificate certificate, ICertificate[] issuerCertificates, string privateKeyFormat, byte[] privateKey, AsyncCallback callback, object callbackData)
 Begins an operation to update the certificate used by the server. More...
 
bool EndUpdateCertificate (IAsyncResult result)
 Completes an operation to update the certificate used by the server. More...
 
void ApplyChanges ()
 ApplyChangess the server. More...
 
IAsyncResult BeginApplyChanges (AsyncCallback callback, object callbackData)
 Begins an operation to ApplyChanges the server. More...
 
void EndApplyChanges (IAsyncResult result)
 Completes an operation to ApplyChanges the server. More...
 
byte[] CreateSigningRequest (NodeId certificateGroupId, NodeId certificateTypeId, string subjectName, bool regeneratePrivateKey, byte[] nonce)
 Create a new certificate request. More...
 
IAsyncResult BeginCreateSigningRequest (NodeId certificateGroupId, NodeId certificateTypeId, string subjectName, bool regeneratePrivateKey, byte[] nonce, AsyncCallback callback, object callbackData)
 Begins an operation to CreateSigningRequest the server. More...
 
byte[] EndCreateSigningRequest (IAsyncResult result)
 Ends the create CSR. More...
 
bool UpdateTrustList (TrustListDataType trustList)
 Updates the application certificate trust list used by the server. More...
 
IAsyncResult BeginUpdateTrustList (TrustListDataType trustList, AsyncCallback callback, object callbackData)
 Begins an operation to update the application certificate trust list used by the server. More...
 
bool EndUpdateTrustList (IAsyncResult result)
 Completes an operation to update the application certificate trust list used by the server. More...
 
- Public Member Functions inherited from UnifiedAutomation.UaClient.SessionMethodHelper
 SessionMethodHelper (ApplicationInstanceBase application)
 Initializes a new instance of the SessionMethodHelper class. More...
 
 SessionMethodHelper (Session session)
 Initializes a new instance of the SessionMethodHelper class. More...
 
void Dispose ()
 Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. More...
 
void Connect (int timeout)
 Connects to the server. More...
 
void BeginConnect (AsyncCallback callback, object callbackData)
 Connects to the server. More...
 
void Disconnect ()
 Disconnects from the server. More...
 

Properties

EndpointDescription Endpoint [get]
 Gets the endpoint of the server being managed. More...
 
ApplicationRecordDataType ApplicationRecord [get]
 Gets the application record. More...
 
IList< string > SupportedPrivateKeyFormats [get]
 Gets the supported private key formats. More...
 
- Properties inherited from UnifiedAutomation.UaClient.SessionMethodHelper
string EndpointUrl [get, set]
 Gets or sets the endpoint URL. More...
 
Session Session [get]
 Gets the session. More...
 
RequestSettings DefaultRequestSettings [get, set]
 Gets or sets the default request settings. More...
 
int DefaultTimeout [get]
 Gets the default timeout. More...
 
UserIdentity AdminCredentials [get, set]
 Gets or sets the administrator credentials. More...
 
bool IsConnected [get]
 Gets a value indicating whether a connection to the server is active. More...
 
bool MustCloseSession [get]
 A flag indicating that the object created the session and therefore must close it. More...
 

Additional Inherited Members

- Protected Member Functions inherited from UnifiedAutomation.UaClient.SessionMethodHelper
virtual void Dispose (bool disposing)
 Releases unmanaged and—optionally—managed resources. More...
 
UserIdentity RequestAdminCredentials ()
 Gets the admin credentials. More...
 
- Events inherited from UnifiedAutomation.UaClient.SessionMethodHelper
EventHandler ServerStatusChanged
 Occurs when the server status changes. More...
 
EventHandler
< CredentialsRequiredEventArgs
AdminCredentialsRequired
 Raised when admin credentials are required. More...
 

Detailed Description

Used to access the ServerConfigurationClient features of an OPC UA Server.

Constructor & Destructor Documentation

UnifiedAutomation.UaClient.ServerConfigurationClient.ServerConfigurationClient ( ApplicationInstanceBase  application)
inline

Initializes a new instance of the ServerConfigurationClient class.

Parameters
applicationThe application to use.
UnifiedAutomation.UaClient.ServerConfigurationClient.ServerConfigurationClient ( Session  session)
inline

Initializes a new instance of the ServerConfigurationClient class.

Parameters
sessionThe session to use.

Member Function Documentation

void UnifiedAutomation.UaClient.ServerConfigurationClient.ApplyChanges ( )
inline

ApplyChangess the server.

The exact effect of this method depends on the server. Some server may simply close and re-open their endpoints which means any Sessions are still alive. Other servers will close all Sessions and ApplyChanges.

This method disconnects from the server before returning since the server is supposed to be ApplyChangesing.

IAsyncResult UnifiedAutomation.UaClient.ServerConfigurationClient.BeginApplyChanges ( AsyncCallback  callback,
object  callbackData 
)
inline

Begins an operation to ApplyChanges the server.

Parameters
callbackThe callback.
callbackDataThe callback data.
Returns
The object used to manage the state of the asychronous operation.

The exact effect of this method depends on the server. Some server may simply close and re-open their endpoints which means any Sessions are still alive. Other servers will close all Sessions and ApplyChanges.

IAsyncResult UnifiedAutomation.UaClient.ServerConfigurationClient.BeginCreateSigningRequest ( NodeId  certificateGroupId,
NodeId  certificateTypeId,
string  subjectName,
bool  regeneratePrivateKey,
byte[]  nonce,
AsyncCallback  callback,
object  callbackData 
)
inline

Begins an operation to CreateSigningRequest the server.

Parameters
certificateGroupIdThe id of the certificate group.
certificateTypeIdThe id of the certificate type in the certificate group.
subjectNameName of the subject.
regeneratePrivateKeyif set to true then regenerate the private key.
nonceThe nonce.
callbackThe callback.
callbackDataThe callback data.
Returns
The object used to manage the state of the asychronous operation.
IAsyncResult UnifiedAutomation.UaClient.ServerConfigurationClient.BeginReadServerInfo ( AsyncCallback  callback,
object  callbackData 
)
inline

Begins an operation to read the application metadata from the server.

Parameters
callbackThe callback.
callbackDataThe callback data.
Returns
The object used to manage the state of the asychronous operation.
IAsyncResult UnifiedAutomation.UaClient.ServerConfigurationClient.BeginUpdateCertificate ( NodeId  certificateGroupId,
NodeId  certificateTypeId,
ICertificate  certificate,
ICertificate[]  issuerCertificates,
string  privateKeyFormat,
byte[]  privateKey,
AsyncCallback  callback,
object  callbackData 
)
inline

Begins an operation to update the certificate used by the server.

Parameters
certificateGroupIdThe id of the certificate group.
certificateTypeIdThe id of the certificate type in the certificate group.
certificateThe certificate.
issuerCertificatesThe issuer certificates.
privateKeyFormatThe private key format. Must be one of the formats specified by SupportedPrivateKeyFormats. Set to null if the private key is not provided.
privateKeyThe private key associated with the certificate. If null the server must keep using the private key it already has.
callbackThe callback.
callbackDataThe callback data.
Returns
The object used to manage the state of the asychronous operation.
Exceptions
System.ArgumentNullExceptioncertificate
IAsyncResult UnifiedAutomation.UaClient.ServerConfigurationClient.BeginUpdateTrustList ( TrustListDataType  trustList,
AsyncCallback  callback,
object  callbackData 
)
inline

Begins an operation to update the application certificate trust list used by the server.

Parameters
trustListThe trust list.
callbackThe callback.
callbackDataThe callback data.
Returns
The object used to manage the state of the asychronous operation.
byte [] UnifiedAutomation.UaClient.ServerConfigurationClient.CreateSigningRequest ( NodeId  certificateGroupId,
NodeId  certificateTypeId,
string  subjectName,
bool  regeneratePrivateKey,
byte[]  nonce 
)
inline

Create a new certificate request.

Parameters
certificateGroupIdThe id of the certificate group.
certificateTypeIdThe id of the certificate type in the certificate group.
subjectNameName of the subject.
regeneratePrivateKeyif set to true then regenerate the private key.
nonceThe nonce.
void UnifiedAutomation.UaClient.ServerConfigurationClient.EndApplyChanges ( IAsyncResult  result)
inline

Completes an operation to ApplyChanges the server.

Parameters
resultThe object used to manage the state of the asychronous operation.

This method disconnects from the server before returning since the server is supposed to be ApplyChangesing.

byte [] UnifiedAutomation.UaClient.ServerConfigurationClient.EndCreateSigningRequest ( IAsyncResult  result)
inline

Ends the create CSR.

Parameters
resultThe result.
Returns
Exceptions
System.ArgumentNullExceptionresult
ApplicationRecordDataType UnifiedAutomation.UaClient.ServerConfigurationClient.EndReadServerInfo ( IAsyncResult  result)
inline

Completes an operation to read the application metadata from the server.

Parameters
resultThe object used to manage the state of the asychronous operation.
Returns
The application metadata in a structure that can be passed to a GDS.
bool UnifiedAutomation.UaClient.ServerConfigurationClient.EndUpdateCertificate ( IAsyncResult  result)
inline

Completes an operation to update the certificate used by the server.

Parameters
resultThe object used to manage the state of the asychronous operation.
Returns
True if the ApplyChanges method must be called to apply the changes.
bool UnifiedAutomation.UaClient.ServerConfigurationClient.EndUpdateTrustList ( IAsyncResult  result)
inline

Completes an operation to update the application certificate trust list used by the server.

Parameters
resultThe object used to manage the state of the asychronous operation.
Returns
True if the ApplyChanges method must be called to apply the changes.
ApplicationRecordDataType UnifiedAutomation.UaClient.ServerConfigurationClient.ReadServerInfo ( )
inline

Reads the application metadata from the server.

Returns
The application metadata in a structure that can be passed to a GDS.
bool UnifiedAutomation.UaClient.ServerConfigurationClient.UpdateCertificate ( NodeId  certificateGroupId,
NodeId  certificateTypeId,
ICertificate  certificate,
ICertificate[]  issuerCertificates,
string  privateKeyFormat,
byte[]  privateKey 
)
inline

Updates the certificate used by the server.

Parameters
certificateGroupIdThe id of the certificate group.
certificateTypeIdThe id of the certificate type in the certificate group.
certificateThe certificate.
issuerCertificatesThe issuer certificates.
privateKeyFormatThe private key format. Must be one of the formats specified by SupportedPrivateKeyFormats. Set to null if the private key is not provided.
privateKeyThe private key associated with the certificate. If null the server must keep using the private key it already has.
Returns
True if the ApplyChanges method must be called to apply the changes.
bool UnifiedAutomation.UaClient.ServerConfigurationClient.UpdateTrustList ( TrustListDataType  trustList)
inline

Updates the application certificate trust list used by the server.

Parameters
trustListThe trust list.
Returns
True if the ApplyChanges method must be called to apply the changes.

Property Documentation

ApplicationRecordDataType UnifiedAutomation.UaClient.ServerConfigurationClient.ApplicationRecord
get

Gets the application record.

The application record.

This property is updated when ReadServerInfo is called.

EndpointDescription UnifiedAutomation.UaClient.ServerConfigurationClient.Endpoint
get

Gets the endpoint of the server being managed.

The endpoint.

IList<string> UnifiedAutomation.UaClient.ServerConfigurationClient.SupportedPrivateKeyFormats
get

Gets the supported private key formats.

The supported private key formats.

This property is updated when ReadServerInfo is called.


The documentation for this class was generated from the following file: