.NET Based OPC UA Client/Server SDK  2.6.1.422
UnifiedAutomation.UaClient.TrustListManagement Class Reference

Used to access a TrustList object in an OPC UA Server. More...

Inherits UnifiedAutomation.UaClient.SessionMethodHelper.

Public Member Functions

 TrustListManagement (ApplicationInstance application)
 Initializes a new instance of the TrustListManagement class. More...
 
 TrustListManagement (Session session)
 Initializes a new instance of the TrustListManagement class. More...
 
TrustListDataType Read (TrustListMasks masks, int blockSize)
 Reads the trust list from the server. More...
 
IAsyncResult BeginRead (TrustListMasks masks, int blockSize, AsyncCallback callback, object callbackData)
 Begins an operation to read the trust list from the server. More...
 
TrustListDataType EndRead (IAsyncResult result)
 Completes an operation to read the trust list from the server. More...
 
bool Write (TrustListDataType trustList, int blockSize)
 Writes the trust list to the server. More...
 
IAsyncResult BeginWrite (TrustListDataType trustList, int blockSize, AsyncCallback callback, object callbackData)
 Begins an operation to write the trust list to the server. More...
 
bool EndWrite (IAsyncResult result)
 Completes an operation to write the trust list to the server. More...
 
void AddCertificate (byte[] certificate, bool isTrustedCertificate)
 Adds a certificate to the trust list. More...
 
IAsyncResult BeginAddCertificate (byte[] certificate, bool isTrustedCertificate, AsyncCallback callback, object callbackData)
 Begins an operation to add a certificate to the trust list. More...
 
void EndAddCertificate (IAsyncResult result)
 Completes an operation to add a certificate to the trust list. More...
 
void RemoveCertificate (string thumbprint, bool isTrustedCertificate)
 Removes a certificate from the trust list. More...
 
IAsyncResult BeginRemoveCertificate (string thumbprint, bool isTrustedCertificate, AsyncCallback callback, object callbackData)
 Begins an operation to remove a certificate to the trust list. More...
 
void EndRemoveCertificate (IAsyncResult result)
 Completes an operation to remove a certificate from the trust list. 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

NodeId TrustListId [get, set]
 Gets or sets the NodeId of the trust list object. More...
 
int DefaultBlockSize [get, set]
 Gets or sets the default size of the block. 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 a TrustList object in an OPC UA Server.

Constructor & Destructor Documentation

UnifiedAutomation.UaClient.TrustListManagement.TrustListManagement ( ApplicationInstance  application)
inline

Initializes a new instance of the TrustListManagement class.

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

Initializes a new instance of the TrustListManagement class.

Parameters
sessionThe session to use.

Member Function Documentation

void UnifiedAutomation.UaClient.TrustListManagement.AddCertificate ( byte[]  certificate,
bool  isTrustedCertificate 
)
inline

Adds a certificate to the trust list.

Parameters
certificateThe certificate to add.
isTrustedCertificateif set to true the certificate is placed in the trusted certificate store.
IAsyncResult UnifiedAutomation.UaClient.TrustListManagement.BeginAddCertificate ( byte[]  certificate,
bool  isTrustedCertificate,
AsyncCallback  callback,
object  callbackData 
)
inline

Begins an operation to add a certificate to the trust list.

Parameters
certificateThe certificate to add.
isTrustedCertificateif set to true the certificate is placed in the trusted certificate store.
callbackThe callback.
callbackDataThe callback data.
Returns
The object used to manage the state of the asychronous operation.
IAsyncResult UnifiedAutomation.UaClient.TrustListManagement.BeginRead ( TrustListMasks  masks,
int  blockSize,
AsyncCallback  callback,
object  callbackData 
)
inline

Begins an operation to read the trust list from the server.

Parameters
masksThe masks which specify the components of the trust list to return.
blockSizeSize of the block to use when reading the the trust list. If 0 then the DefaultBlockSize is used.
callbackThe callback.
callbackDataThe callback data.
Returns
The object used to manage the state of the asychronous operation.
IAsyncResult UnifiedAutomation.UaClient.TrustListManagement.BeginRemoveCertificate ( string  thumbprint,
bool  isTrustedCertificate,
AsyncCallback  callback,
object  callbackData 
)
inline

Begins an operation to remove a certificate to the trust list.

Parameters
thumbprintThe thumbprint of the certificate to remove.
isTrustedCertificateif set to true the certificate is removed from the trusted certificate store.
callbackThe callback.
callbackDataThe callback data.
Returns
The object used to manage the state of the asychronous operation.
IAsyncResult UnifiedAutomation.UaClient.TrustListManagement.BeginWrite ( TrustListDataType  trustList,
int  blockSize,
AsyncCallback  callback,
object  callbackData 
)
inline

Begins an operation to write the trust list to the server.

Parameters
trustListThe trust list.
blockSizeSize of the block to use when writing the the trust list. If 0 then the DefaultBlockSize is used.
callbackThe callback.
callbackDataThe callback data.
Returns
The object used to manage the state of the asychronous operation.
void UnifiedAutomation.UaClient.TrustListManagement.EndAddCertificate ( IAsyncResult  result)
inline

Completes an operation to add a certificate to the trust list.

Parameters
resultThe object used to manage the state of the asychronous operation.
TrustListDataType UnifiedAutomation.UaClient.TrustListManagement.EndRead ( IAsyncResult  result)
inline

Completes an operation to read the trust list from the server.

Parameters
resultThe object used to manage the state of the asychronous operation.
Returns
The trust list.
void UnifiedAutomation.UaClient.TrustListManagement.EndRemoveCertificate ( IAsyncResult  result)
inline

Completes an operation to remove a certificate from the trust list.

Parameters
resultThe object used to manage the state of the asychronous operation.
bool UnifiedAutomation.UaClient.TrustListManagement.EndWrite ( IAsyncResult  result)
inline

Completes an operation to write the trust list to the server.

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

The trust list.

True if the ApplyChanges method must be called to apply the changes.

TrustListDataType UnifiedAutomation.UaClient.TrustListManagement.Read ( TrustListMasks  masks,
int  blockSize 
)
inline

Reads the trust list from the server.

Parameters
masksThe masks which specify the components of the trust list to return.
blockSizeSize of the block to use when reading the the trust list. If 0 then the DefaultBlockSize is used.
Returns
The trust list.
void UnifiedAutomation.UaClient.TrustListManagement.RemoveCertificate ( string  thumbprint,
bool  isTrustedCertificate 
)
inline

Removes a certificate from the trust list.

Parameters
thumbprintThe thumbprint of the certificate to remove.
isTrustedCertificateif set to true the certificate is removed from the trusted certificate store.
bool UnifiedAutomation.UaClient.TrustListManagement.Write ( TrustListDataType  trustList,
int  blockSize 
)
inline

Writes the trust list to the server.

Parameters
trustListThe trust list.
blockSizeSize of the block to use when writing the the trust list. If 0 then the DefaultBlockSize is used.
Returns
True if the ApplyChanges method must be called to apply the changes.

Property Documentation

int UnifiedAutomation.UaClient.TrustListManagement.DefaultBlockSize
getset

Gets or sets the default size of the block.

The default size of the block.

NodeId UnifiedAutomation.UaClient.TrustListManagement.TrustListId
getset

Gets or sets the NodeId of the trust list object.

The NodeId of the trust list object.


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