UA Bundle SDK .NET
2.4.0.361
|
Used to access the ServerConfigurationClient features of an OPC UA Server. More...
Inherits UnifiedAutomation.UaClient.SessionMethodHelper.
Public Member Functions | |
ServerConfigurationClient (ApplicationInstance 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 (ApplicationInstance 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< NodeId > | SupportedCertificateTypes [get] |
Gets the supported certificate types. 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... | |
Used to access the ServerConfigurationClient features of an OPC UA Server.
|
inline |
Initializes a new instance of the ServerConfigurationClient class.
application | The application to use. |
|
inline |
Initializes a new instance of the ServerConfigurationClient class.
session | The session to use. |
|
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.
|
inline |
Begins an operation to ApplyChanges the server.
callback | The callback. |
callbackData | The callback data. |
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.
|
inline |
Begins an operation to CreateSigningRequest the server.
certificateGroupId | The id of the certificate group. |
certificateTypeId | The id of the certificate type in the certificate group. |
subjectName | Name of the subject. |
regeneratePrivateKey | if set to true then regenerate the private key. |
nonce | The nonce. |
callback | The callback. |
callbackData | The callback data. |
|
inline |
Begins an operation to read the application metadata from the server.
callback | The callback. |
callbackData | The callback data. |
|
inline |
Begins an operation to update the certificate used by the server.
certificateGroupId | The id of the certificate group. |
certificateTypeId | The id of the certificate type in the certificate group. |
certificate | The certificate. |
issuerCertificates | The issuer certificates. |
privateKeyFormat | The private key format. Must be one of the formats specified by SupportedPrivateKeyFormats. Set to null if the private key is not provided. |
privateKey | The private key associated with the certificate. If null the server must keep using the private key it already has. |
callback | The callback. |
callbackData | The callback data. |
System.ArgumentNullException | certificate |
|
inline |
Begins an operation to update the application certificate trust list used by the server.
trustList | The trust list. |
callback | The callback. |
callbackData | The callback data. |
|
inline |
Create a new certificate request.
certificateGroupId | The id of the certificate group. |
certificateTypeId | The id of the certificate type in the certificate group. |
subjectName | Name of the subject. |
regeneratePrivateKey | if set to true then regenerate the private key. |
nonce | The nonce. |
|
inline |
Completes an operation to ApplyChanges the server.
result | The 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.
|
inline |
Ends the create CSR.
result | The result. |
System.ArgumentNullException | result |
|
inline |
Completes an operation to read the application metadata from the server.
result | The object used to manage the state of the asychronous operation. |
|
inline |
Completes an operation to update the certificate used by the server.
result | The object used to manage the state of the asychronous operation. |
|
inline |
Completes an operation to update the application certificate trust list used by the server.
result | The object used to manage the state of the asychronous operation. |
|
inline |
Reads the application metadata from the server.
|
inline |
Updates the certificate used by the server.
certificateGroupId | The id of the certificate group. |
certificateTypeId | The id of the certificate type in the certificate group. |
certificate | The certificate. |
issuerCertificates | The issuer certificates. |
privateKeyFormat | The private key format. Must be one of the formats specified by SupportedPrivateKeyFormats. Set to null if the private key is not provided. |
privateKey | The private key associated with the certificate. If null the server must keep using the private key it already has. |
|
inline |
Updates the application certificate trust list used by the server.
trustList | The trust list. |
|
get |
Gets the application record.
The application record.
This property is updated when ReadServerInfo is called.
|
get |
Gets the endpoint of the server being managed.
The endpoint.
|
get |
Gets the supported certificate types.
The supported certificate types.
This property is updated when ReadServerInfo is called.
|
get |
Gets the supported private key formats.
The supported private key formats.
This property is updated when ReadServerInfo is called.