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

Used to access the CertificateDirectoryClient features of a GDS. More...

Inherits UnifiedAutomation.UaClient.SessionMethodHelper.

Public Member Functions

 CertificateDirectoryClient (ApplicationInstance application)
 Initializes a new instance of the CertificateDirectoryClient class. More...
 
 CertificateDirectoryClient (Session session)
 Initializes a new instance of the CertificateDirectoryClient class. More...
 
ApplicationRecordDataType[] FindApplications (string applicationUri)
 Finds the application records in the GDS with the specified Application URI. More...
 
IAsyncResult BeginFindApplications (string applicationUri, AsyncCallback callback, object callbackData)
 Begins an operation to finds the application records in the GDS with the specified Application URI. More...
 
ApplicationRecordDataType[] EndFindApplications (IAsyncResult result)
 Completes an operation to finds the application records in the GDS with the specified Application URI. More...
 
ApplicationRecordDataType GetApplication (NodeId applicationId)
 Registers an application with the GDS. More...
 
IAsyncResult BeginGetApplication (NodeId applicationId, AsyncCallback callback, object callbackData)
 Begins an operation to register an application with the GDS. More...
 
ApplicationRecordDataType EndGetApplication (IAsyncResult result)
 Completes an operation to register an application with the GDS. More...
 
NodeId RegisterApplication (ApplicationRecordDataType application)
 Registers an application with the GDS. More...
 
IAsyncResult BeginRegisterApplication (ApplicationRecordDataType application, AsyncCallback callback, object callbackData)
 Begins an operation to register an application with the GDS. More...
 
NodeId EndRegisterApplication (IAsyncResult result)
 Completes an operation to register an application with the GDS. More...
 
void UpdateApplication (ApplicationRecordDataType application)
 Updates the application information stored in the GDS. More...
 
IAsyncResult BeginUpdateApplication (ApplicationRecordDataType application, AsyncCallback callback, object callbackData)
 Begins an operation to update the application in the GDS. More...
 
void EndUpdateApplication (IAsyncResult result)
 Completes an operation to update the application in the GDS. More...
 
void UnregisterApplication (NodeId applicationId)
 Unegisters an application with the GDS. More...
 
IAsyncResult BeginUnregisterApplication (NodeId applicationId, AsyncCallback callback, object callbackData)
 Begins an operation to unregister an application with the GDS. More...
 
void EndUnregisterApplication (IAsyncResult result)
 Completes an operation to unregister the application in the GDS. More...
 
NodeId StartSigningRequest (NodeId applicationId, NodeId certificateGroupId, NodeId certificateTypeId, byte[] certificateRequest)
 Requests that the GDS create a new certificate based on the old one which is signed by a CA managed by the GDS. More...
 
IAsyncResult BeginStartSigningRequest (NodeId applicationId, NodeId certificateGroupId, NodeId certificateTypeId, byte[] certificateRequest, AsyncCallback callback, object callbackData)
 Begins a requests that the GDS create a new certificate based on the old one which is signed by a CA managed by the GDS. More...
 
NodeId EndStartSigningRequest (IAsyncResult result)
 Completes a request that the GDS create a new certificate based on the old one which is signed by a CA managed by the GDS. More...
 
NodeId StartNewKeyPairRequest (NodeId applicationId, NodeId certificateGroupId, NodeId certificateTypeId)
 Requests that the GDS create a new certificate. More...
 
NodeId StartNewKeyPairRequest (NodeId applicationId, NodeId certificateGroupId, NodeId certificateTypeId, string subjectName, IList< string > domainNames, string privateKeyFormat, string privateKeyPassword)
 Requests that the GDS create a new certificate. More...
 
IAsyncResult BeginStartNewKeyPairRequest (NodeId applicationId, NodeId certificateGroupId, NodeId certificateTypeId, AsyncCallback callback, object callbackData)
 Begins a request that the GDS create a new certificate. More...
 
IAsyncResult BeginStartNewKeyPairRequest (NodeId applicationId, NodeId certificateGroupId, NodeId certificateTypeId, string subjectName, IList< string > domainNames, string privateKeyFormat, string privateKeyPassword, AsyncCallback callback, object callbackData)
 Begins a request that the GDS create a new certificate. More...
 
NodeId EndStartNewKeyPairRequest (IAsyncResult result)
 Completes a request that the GDS create a new certificate. More...
 
ICertificate FinishRequest (NodeId applicationId, NodeId requestId, int pollingInterval, out byte[] privateKey, out ICertificate[] issuerCertificates)
 Checks the status of a request created by StartSigningRequest, StartNewKeyPairRequest or RenewCertificate. More...
 
IAsyncResult BeginFinishRequest (NodeId applicationId, NodeId requestId, int pollingInterval, AsyncCallback callback, object callbackData)
 Begins a check of the status of a request created by StartSigningRequest, StartNewKeyPairRequest or RenewCertificate. More...
 
ICertificate EndFinishRequest (IAsyncResult result, out byte[] privateKey, out ICertificate[] issuerCertificates)
 Completes a check of the status of a request created by StartSigningRequest, StartNewKeyPairRequest or RenewCertificate. More...
 
List< NodeIdGetCertificateGroups (NodeId applicationId)
 Gets the certificate groups assigned to the application by the GDS. More...
 
IAsyncResult BeginGetCertificateGroups (NodeId applicationId, AsyncCallback callback, object callbackData)
 Begins a request to get the id of the trust list assigned to the application by the GDS. More...
 
List< NodeIdEndGetCertificateGroups (IAsyncResult result)
 Completes a request to get the id of the trust list assigned to the application by the GDS. More...
 
NodeId GetTrustListId (NodeId applicationId, NodeId certificateGroupId)
 Gets the id of the trust list assigned to the application by the GDS. More...
 
IAsyncResult BeginGetTrustListId (NodeId applicationId, NodeId certificateGroupId, AsyncCallback callback, object callbackData)
 Begins a request to get the id of the trust list assigned to the application by the GDS. More...
 
NodeId EndGetTrustListId (IAsyncResult result)
 Completes a request to get the id of the trust list assigned to the application by the GDS. More...
 
TrustListDataType GetTrustList (NodeId applicationId, NodeId certificateGroupId, TrustListMasks masks)
 Gets the trust list assigned to the application by the GDS. More...
 
IAsyncResult BeginGetTrustList (NodeId applicationId, NodeId certificateGroupId, TrustListMasks masks, AsyncCallback callback, object callbackData)
 Begins a request to get the trust list assigned to the application by the GDS. More...
 
TrustListDataType EndGetTrustList (IAsyncResult result)
 Completes a request to get the trust list assigned to the application by the GDS. More...
 
bool GetCertificateStatus (NodeId applicationId, NodeId certificateGroupId, NodeId certificateTypeId)
 Gets the status of the certificate. More...
 
IAsyncResult BeginGetCertificateStatus (NodeId applicationId, NodeId certificateGroupId, NodeId certificateTypeId, AsyncCallback callback, object callbackData)
 Begins a request the status of the certificate. More...
 
bool EndGetCertificateStatus (IAsyncResult result)
 Completes a request to get the id of the trust list assigned to the application by the GDS. 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...
 

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...
 
- 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...
 
- 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 CertificateDirectoryClient features of a GDS.

Constructor & Destructor Documentation

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

Initializes a new instance of the CertificateDirectoryClient class.

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

Initializes a new instance of the CertificateDirectoryClient class.

Parameters
sessionThe session to use.

Member Function Documentation

IAsyncResult UnifiedAutomation.UaClient.CertificateDirectoryClient.BeginFindApplications ( string  applicationUri,
AsyncCallback  callback,
object  callbackData 
)
inline

Begins an operation to finds the application records in the GDS with the specified Application URI.

Parameters
applicationUriThe application URI.
callbackThe callback.
callbackDataThe callback data.
Returns
The object used to manage the state of the asychronous operation.
Exceptions
System.ArgumentNullExceptionapplicationUri
IAsyncResult UnifiedAutomation.UaClient.CertificateDirectoryClient.BeginFinishRequest ( NodeId  applicationId,
NodeId  requestId,
int  pollingInterval,
AsyncCallback  callback,
object  callbackData 
)
inline

Begins a check of the status of a request created by StartSigningRequest, StartNewKeyPairRequest or RenewCertificate.

Parameters
applicationIdThe application identifier assigned by the GDS to the application.
requestIdThe request identifier return from the StartSigningRequest, StartNewKeyPairRequest or RenewCertificate call.
pollingIntervalHow frequently to check for a response. 0 means no check is done.
callbackThe callback.
callbackDataThe callback data.
Returns
The object used to manage the state of the asychronous operation.

This method returns null if the certificate is not ready. The caller must wait and call this method again.

IAsyncResult UnifiedAutomation.UaClient.CertificateDirectoryClient.BeginGetApplication ( NodeId  applicationId,
AsyncCallback  callback,
object  callbackData 
)
inline

Begins an operation to register an application with the GDS.

Parameters
applicationIdThe application identifier.
callbackThe callback.
callbackDataThe callback data.
Returns
The object used to manage the state of the asychronous operation.
Exceptions
System.ArgumentNullExceptionapplicationId
IAsyncResult UnifiedAutomation.UaClient.CertificateDirectoryClient.BeginGetCertificateGroups ( NodeId  applicationId,
AsyncCallback  callback,
object  callbackData 
)
inline

Begins a request to get the id of the trust list assigned to the application by the GDS.

Parameters
applicationIdThe application identifier assigned by the GDS to the application.
callbackThe callback.
callbackDataThe callback data.
Returns
The object used to manage the state of the asychronous operation.
IAsyncResult UnifiedAutomation.UaClient.CertificateDirectoryClient.BeginGetCertificateStatus ( NodeId  applicationId,
NodeId  certificateGroupId,
NodeId  certificateTypeId,
AsyncCallback  callback,
object  callbackData 
)
inline

Begins a request the status of the certificate.

Parameters
applicationIdThe application identifier assigned by the GDS to the application.
certificateGroupIdThe certificate group used to create the new certificate. If null the DefaultApplicationGroup is used
certificateTypeIdThe subtype of Id which indicates the kind of certificate to create (e.g. Application Instance or HTTPS). If null the default for the certificate group is used.
callbackThe callback.
callbackDataThe callback data.
Returns
The object used to manage the state of the asychronous operation.
IAsyncResult UnifiedAutomation.UaClient.CertificateDirectoryClient.BeginGetTrustList ( NodeId  applicationId,
NodeId  certificateGroupId,
TrustListMasks  masks,
AsyncCallback  callback,
object  callbackData 
)
inline

Begins a request to get the trust list assigned to the application by the GDS.

Parameters
applicationIdThe application identifier assigned by the GDS to the application.
certificateGroupIdThe certificate group which owns the trust list to return. If null the DefaultApplicationGroup is used.
masksThe masks which specify what parts of the trust list should be returned.
callbackThe callback.
callbackDataThe callback data.
Returns
The object used to manage the state of the asychronous operation.
IAsyncResult UnifiedAutomation.UaClient.CertificateDirectoryClient.BeginGetTrustListId ( NodeId  applicationId,
NodeId  certificateGroupId,
AsyncCallback  callback,
object  callbackData 
)
inline

Begins a request to get the id of the trust list assigned to the application by the GDS.

Parameters
applicationIdThe application identifier assigned by the GDS to the application.
certificateGroupIdThe certificate group which owns the trust list to return. If null the DefaultApplicationGroup is used.
callbackThe callback.
callbackDataThe callback data.
Returns
The object used to manage the state of the asychronous operation.
IAsyncResult UnifiedAutomation.UaClient.CertificateDirectoryClient.BeginRegisterApplication ( ApplicationRecordDataType  application,
AsyncCallback  callback,
object  callbackData 
)
inline

Begins an operation to register an application with the GDS.

Parameters
applicationThe application information to store in the GDS.
callbackThe callback.
callbackDataThe callback data.
Returns
The object used to manage the state of the asychronous operation.
Exceptions
System.ArgumentNullExceptionapplication
IAsyncResult UnifiedAutomation.UaClient.CertificateDirectoryClient.BeginStartNewKeyPairRequest ( NodeId  applicationId,
NodeId  certificateGroupId,
NodeId  certificateTypeId,
AsyncCallback  callback,
object  callbackData 
)
inline

Begins a request that the GDS create a new certificate.

Parameters
applicationIdThe application identifier assigned by the GDS to the application.
certificateGroupIdThe certificate group used to create the new certificate. If null the DefaultApplicationGroup is used
certificateTypeIdThe subtype of Id which indicates the kind of certificate to create (e.g. Application Instance or HTTPS). If null the default for the certificate group is used.
callbackThe callback.
callbackDataThe callback data.
Returns
The object used to manage the state of the asychronous operation.
IAsyncResult UnifiedAutomation.UaClient.CertificateDirectoryClient.BeginStartNewKeyPairRequest ( NodeId  applicationId,
NodeId  certificateGroupId,
NodeId  certificateTypeId,
string  subjectName,
IList< string >  domainNames,
string  privateKeyFormat,
string  privateKeyPassword,
AsyncCallback  callback,
object  callbackData 
)
inline

Begins a request that the GDS create a new certificate.

Parameters
applicationIdThe application identifier assigned by the GDS to the application.
certificateGroupIdThe certificate group used to create the new certificate. If null the DefaultApplicationGroup is used
certificateTypeIdThe subtype of Id which indicates the kind of certificate to create (e.g. Application Instance or HTTPS). If null the default for the certificate group is used.
subjectNameThe subject name for the certificate. The format is a distingushed name with '/' seperating the fields. e.g. 'CN=MyApp/O=MyCompany/DC=MyMachine'. If null a suitable default is created.
domainNamesThe list of domains to embed in the certificate. If null the URL registered with GDS are used.
privateKeyFormatThe format of the private key. Most GDS implementations should support PFX and PEM.
privateKeyPasswordThe password used to encrypt the private key. If null no encryption is done.
callbackThe callback.
callbackDataThe callback data.
Returns
The object used to manage the state of the asychronous operation.
IAsyncResult UnifiedAutomation.UaClient.CertificateDirectoryClient.BeginStartSigningRequest ( NodeId  applicationId,
NodeId  certificateGroupId,
NodeId  certificateTypeId,
byte[]  certificateRequest,
AsyncCallback  callback,
object  callbackData 
)
inline

Begins a requests that the GDS create a new certificate based on the old one which is signed by a CA managed by the GDS.

Parameters
applicationIdThe application identifier assigned by the GDS to the application.
certificateGroupIdThe certificate group used to create the new certificate. If null the DefaultApplicationGroup is used
certificateTypeIdThe subtype of Id which indicates the kind of certificate to create (e.g. Application Instance or HTTPS). If null the default for the certificate group is used.
certificateRequestThe certificate which is used as a template for the new certificate. The public key is copied from this certificate.
callbackThe callback.
callbackDataThe callback data.
Returns
The object used to manage the state of the asychronous operation.
IAsyncResult UnifiedAutomation.UaClient.CertificateDirectoryClient.BeginUnregisterApplication ( NodeId  applicationId,
AsyncCallback  callback,
object  callbackData 
)
inline

Begins an operation to unregister an application with the GDS.

Parameters
applicationIdThe unique identifier assigned by the HDS to the application.
callbackThe callback.
callbackDataThe callback data.
Returns
The object used to manage the state of the asychronous operation.
Exceptions
System.ArgumentNullExceptionapplicationId
IAsyncResult UnifiedAutomation.UaClient.CertificateDirectoryClient.BeginUpdateApplication ( ApplicationRecordDataType  application,
AsyncCallback  callback,
object  callbackData 
)
inline

Begins an operation to update the application in the GDS.

Parameters
applicationThe application information to store in the GDS.
callbackThe callback.
callbackDataThe callback data.
Returns
The object used to manage the state of the asychronous operation.
Exceptions
System.ArgumentNullExceptionapplication
ApplicationRecordDataType [] UnifiedAutomation.UaClient.CertificateDirectoryClient.EndFindApplications ( IAsyncResult  result)
inline

Completes an operation to finds the application records in the GDS with the specified Application URI.

Parameters
resultThe object used to manage the state of the asychronous operation.
Returns
All records in the GDS which have the specified Application URI.
Exceptions
System.ArgumentNullExceptionresult
ICertificate UnifiedAutomation.UaClient.CertificateDirectoryClient.EndFinishRequest ( IAsyncResult  result,
out byte[]  privateKey,
out ICertificate[]  issuerCertificates 
)
inline

Completes a check of the status of a request created by StartSigningRequest, StartNewKeyPairRequest or RenewCertificate.

Parameters
resultThe object used to manage the state of the asychronous operation.
privateKeyThe private key associated with the certificate (if one was requested).
issuerCertificatesThe CA certificates necessary to validate the new certificate.
Returns
The new certificate.

This method returns null if the certificate is not ready. The caller must wait and call the BeginFinishRequest method again.

ApplicationRecordDataType UnifiedAutomation.UaClient.CertificateDirectoryClient.EndGetApplication ( IAsyncResult  result)
inline

Completes an operation to register an application with the GDS.

Parameters
resultThe object used to manage the state of the asychronous operation..
Returns
The unique identifier assigned by the GDS to the application.
Exceptions
System.ArgumentNullExceptionresult
List<NodeId> UnifiedAutomation.UaClient.CertificateDirectoryClient.EndGetCertificateGroups ( IAsyncResult  result)
inline

Completes a request to get the id of the trust list assigned to the application by the GDS.

Parameters
resultThe object used to manage the state of the asychronous operation.
Returns
The trust list id.
bool UnifiedAutomation.UaClient.CertificateDirectoryClient.EndGetCertificateStatus ( IAsyncResult  result)
inline

Completes a request to get the id of the trust list assigned to the application by the GDS.

Parameters
resultThe object used to manage the state of the asychronous operation.
Returns
TRUE if the certificate needs to be updated; FALSE otherwise.
TrustListDataType UnifiedAutomation.UaClient.CertificateDirectoryClient.EndGetTrustList ( IAsyncResult  result)
inline

Completes a request to get the trust list assigned to the application by the GDS.

Parameters
resultThe object used to manage the state of the asychronous operation.
Returns
The trust list.
NodeId UnifiedAutomation.UaClient.CertificateDirectoryClient.EndGetTrustListId ( IAsyncResult  result)
inline

Completes a request to get the id of the trust list assigned to the application by the GDS.

Parameters
resultThe object used to manage the state of the asychronous operation.
Returns
The trust list id.
NodeId UnifiedAutomation.UaClient.CertificateDirectoryClient.EndRegisterApplication ( IAsyncResult  result)
inline

Completes an operation to register an application with the GDS.

Parameters
resultThe object used to manage the state of the asychronous operation..
Returns
The unique identifier assigned by the GDS to the application.
Exceptions
System.ArgumentNullExceptionresult
NodeId UnifiedAutomation.UaClient.CertificateDirectoryClient.EndStartNewKeyPairRequest ( IAsyncResult  result)
inline

Completes a request that the GDS create a new certificate.

Parameters
resultThe object used to manage the state of the asychronous operation.
Returns
The NodeId assigned to the request. It must be passed to FinishRequest method to retrieve the Certificate.

This overload must be called if the PollingInterval passed to the begin method is 0.

NodeId UnifiedAutomation.UaClient.CertificateDirectoryClient.EndStartSigningRequest ( IAsyncResult  result)
inline

Completes a request that the GDS create a new certificate based on the old one which is signed by a CA managed by the GDS.

Parameters
resultThe object used to manage the state of the asychronous operation.
Returns
The NodeId assigned to the request. It must be passed to FinishRequest method to retrieve the Certificate.

This overload must be called if the PollingInterval passed to the begin method is 0.

void UnifiedAutomation.UaClient.CertificateDirectoryClient.EndUnregisterApplication ( IAsyncResult  result)
inline

Completes an operation to unregister the application in the GDS.

Parameters
resultThe object used to manage the state of the asychronous operation..
Exceptions
System.ArgumentNullExceptionresult
void UnifiedAutomation.UaClient.CertificateDirectoryClient.EndUpdateApplication ( IAsyncResult  result)
inline

Completes an operation to update the application in the GDS.

Parameters
resultThe object used to manage the state of the asychronous operation..
Exceptions
System.ArgumentNullExceptionresult
ApplicationRecordDataType [] UnifiedAutomation.UaClient.CertificateDirectoryClient.FindApplications ( string  applicationUri)
inline

Finds the application records in the GDS with the specified Application URI.

Parameters
applicationUriThe application URI.
Returns
All records in the GDS which have the specified Application URI.
Exceptions
System.ArgumentNullExceptionapplicationUri
ICertificate UnifiedAutomation.UaClient.CertificateDirectoryClient.FinishRequest ( NodeId  applicationId,
NodeId  requestId,
int  pollingInterval,
out byte[]  privateKey,
out ICertificate[]  issuerCertificates 
)
inline

Checks the status of a request created by StartSigningRequest, StartNewKeyPairRequest or RenewCertificate.

Parameters
applicationIdThe application identifier assigned by the GDS to the application.
requestIdThe request identifier return from the StartSigningRequest, StartNewKeyPairRequest or RenewCertificate call.
pollingIntervalHow frequently to check for a response. 0 means no check is done.
privateKeyThe private key associated with the certificate (if one was requested).
issuerCertificatesThe CA certificates necessary to validate the new certificate.
Returns
The new certificate.

This method returns null if the certificate is not ready. The caller must wait and call this method again.

ApplicationRecordDataType UnifiedAutomation.UaClient.CertificateDirectoryClient.GetApplication ( NodeId  applicationId)
inline

Registers an application with the GDS.

Parameters
applicationIdThe application identifier.
Returns
The unique identifier for the record.
Exceptions
System.ArgumentNullExceptionapplicationId
List<NodeId> UnifiedAutomation.UaClient.CertificateDirectoryClient.GetCertificateGroups ( NodeId  applicationId)
inline

Gets the certificate groups assigned to the application by the GDS.

Parameters
applicationIdThe application identifier assigned by the GDS to the application.
Returns
The list of certificate group ids.
bool UnifiedAutomation.UaClient.CertificateDirectoryClient.GetCertificateStatus ( NodeId  applicationId,
NodeId  certificateGroupId,
NodeId  certificateTypeId 
)
inline

Gets the status of the certificate.

Parameters
applicationIdThe application identifier assigned by the GDS to the application.
certificateGroupIdThe certificate group used to create the new certificate. If null the DefaultApplicationGroup is used
certificateTypeIdThe subtype of Id which indicates the kind of certificate to create (e.g. Application Instance or HTTPS). If null the default for the certificate group is used.
Returns
TRUE if the certificate needs to be updated; FALSE otherwise.
TrustListDataType UnifiedAutomation.UaClient.CertificateDirectoryClient.GetTrustList ( NodeId  applicationId,
NodeId  certificateGroupId,
TrustListMasks  masks 
)
inline

Gets the trust list assigned to the application by the GDS.

Parameters
applicationIdThe application identifier assigned by the GDS to the application.
certificateGroupIdThe certificate group which owns the trust list to return. If null the DefaultApplicationGroup is used.
masksThe masks which specify what parts of the trust list should be returned.
Returns
The trust list.
NodeId UnifiedAutomation.UaClient.CertificateDirectoryClient.GetTrustListId ( NodeId  applicationId,
NodeId  certificateGroupId 
)
inline

Gets the id of the trust list assigned to the application by the GDS.

Parameters
applicationIdThe application identifier assigned by the GDS to the application.
certificateGroupIdThe certificate group which owns the trust list to return. If null the DefaultApplicationGroup is used.
Returns
The trust list id.
NodeId UnifiedAutomation.UaClient.CertificateDirectoryClient.RegisterApplication ( ApplicationRecordDataType  application)
inline

Registers an application with the GDS.

Parameters
applicationThe application information to store in the GDS.
Returns
The unique identifier assigned by the GDS to the application.
Exceptions
System.ArgumentNullExceptionapplication
NodeId UnifiedAutomation.UaClient.CertificateDirectoryClient.StartNewKeyPairRequest ( NodeId  applicationId,
NodeId  certificateGroupId,
NodeId  certificateTypeId 
)
inline

Requests that the GDS create a new certificate.

Parameters
applicationIdThe application identifier assigned by the GDS to the application.
certificateGroupIdThe certificate group used to create the new certificate. If null the DefaultApplicationGroup is used
certificateTypeIdThe subtype of Id which indicates the kind of certificate to create (e.g. Application Instance or HTTPS). If null the default for the certificate group is used.
Returns
The NodeId assigned to the request. It must be passed to FinishRequest method to retrieve the Certificate.
NodeId UnifiedAutomation.UaClient.CertificateDirectoryClient.StartNewKeyPairRequest ( NodeId  applicationId,
NodeId  certificateGroupId,
NodeId  certificateTypeId,
string  subjectName,
IList< string >  domainNames,
string  privateKeyFormat,
string  privateKeyPassword 
)
inline

Requests that the GDS create a new certificate.

Parameters
applicationIdThe application identifier assigned by the GDS to the application.
certificateGroupIdThe certificate group used to create the new certificate. If null the DefaultApplicationGroup is used
certificateTypeIdThe subtype of Id which indicates the kind of certificate to create (e.g. Application Instance or HTTPS). If null the default for the certificate group is used.
subjectNameThe subject name for the certificate. The format is a distingushed name with '/' seperating the fields. e.g. 'CN=MyApp/O=MyCompany/DC=MyMachine'. If null a suitable default is created.
domainNamesThe list of domains to embed in the certificate. If null the URL registered with GDS are used.
privateKeyFormatThe format of the private key. Most GDS implementations should support PFX and PEM.
privateKeyPasswordThe password used to encrypt the private key. If null no encryption is done.
Returns
The NodeId assigned to the request. It must be passed to FinishRequest method to retrieve the Certificate.
NodeId UnifiedAutomation.UaClient.CertificateDirectoryClient.StartSigningRequest ( NodeId  applicationId,
NodeId  certificateGroupId,
NodeId  certificateTypeId,
byte[]  certificateRequest 
)
inline

Requests that the GDS create a new certificate based on the old one which is signed by a CA managed by the GDS.

Parameters
applicationIdThe application identifier assigned by the GDS to the application.
certificateGroupIdThe certificate group used to create the new certificate. If null the DefaultApplicationGroup is used
certificateTypeIdThe subtype of Id which indicates the kind of certificate to create (e.g. Application Instance or HTTPS). If null the default for the certificate group is used.
certificateRequestThe certificate signing request (a PKCS#10 blob).
Returns
The NodeId assigned to the request. It must be passed to FinishRequest method to retrieve the Certificate.
void UnifiedAutomation.UaClient.CertificateDirectoryClient.UnregisterApplication ( NodeId  applicationId)
inline

Unegisters an application with the GDS.

Parameters
applicationIdThe unique identifier assigned by the HDS to the application.
Exceptions
System.ArgumentNullExceptionapplicationId
void UnifiedAutomation.UaClient.CertificateDirectoryClient.UpdateApplication ( ApplicationRecordDataType  application)
inline

Updates the application information stored in the GDS.

Parameters
applicationThe application information to store in the GDS.
Exceptions
System.ArgumentNullExceptionapplication

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