.NET Based OPC UA Client/Server SDK
2.6.2.427
|
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< NodeId > | GetCertificateGroups (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< NodeId > | EndGetCertificateGroups (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... | |
Used to access the CertificateDirectoryClient features of a GDS.
|
inline |
Initializes a new instance of the CertificateDirectoryClient class.
application | The application to use. |
|
inline |
Initializes a new instance of the CertificateDirectoryClient class.
session | The session to use. |
|
inline |
Begins an operation to finds the application records in the GDS with the specified Application URI.
applicationUri | The application URI. |
callback | The callback. |
callbackData | The callback data. |
System.ArgumentNullException | applicationUri |
|
inline |
Begins a check of the status of a request created by StartSigningRequest, StartNewKeyPairRequest or RenewCertificate.
applicationId | The application identifier assigned by the GDS to the application. |
requestId | The request identifier return from the StartSigningRequest, StartNewKeyPairRequest or RenewCertificate call. |
pollingInterval | How frequently to check for a response. 0 means no check is done. |
callback | The callback. |
callbackData | The callback data. |
This method returns null if the certificate is not ready. The caller must wait and call this method again.
|
inline |
Begins an operation to register an application with the GDS.
applicationId | The application identifier. |
callback | The callback. |
callbackData | The callback data. |
System.ArgumentNullException | applicationId |
|
inline |
Begins a request to get the id of the trust list assigned to the application by the GDS.
applicationId | The application identifier assigned by the GDS to the application. |
callback | The callback. |
callbackData | The callback data. |
|
inline |
Begins a request the status of the certificate.
applicationId | The application identifier assigned by the GDS to the application. |
certificateGroupId | The certificate group used to create the new certificate. If null the DefaultApplicationGroup is used |
certificateTypeId | The 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. |
callback | The callback. |
callbackData | The callback data. |
|
inline |
Begins a request to get the trust list assigned to the application by the GDS.
applicationId | The application identifier assigned by the GDS to the application. |
certificateGroupId | The certificate group which owns the trust list to return. If null the DefaultApplicationGroup is used. |
masks | The masks which specify what parts of the trust list should be returned. |
callback | The callback. |
callbackData | The callback data. |
|
inline |
Begins a request to get the id of the trust list assigned to the application by the GDS.
applicationId | The application identifier assigned by the GDS to the application. |
certificateGroupId | The certificate group which owns the trust list to return. If null the DefaultApplicationGroup is used. |
callback | The callback. |
callbackData | The callback data. |
|
inline |
Begins an operation to register an application with the GDS.
application | The application information to store in the GDS. |
callback | The callback. |
callbackData | The callback data. |
System.ArgumentNullException | application |
|
inline |
Begins a request that the GDS create a new certificate.
applicationId | The application identifier assigned by the GDS to the application. |
certificateGroupId | The certificate group used to create the new certificate. If null the DefaultApplicationGroup is used |
certificateTypeId | The 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. |
callback | The callback. |
callbackData | The callback data. |
|
inline |
Begins a request that the GDS create a new certificate.
applicationId | The application identifier assigned by the GDS to the application. |
certificateGroupId | The certificate group used to create the new certificate. If null the DefaultApplicationGroup is used |
certificateTypeId | The 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. |
subjectName | The 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. |
domainNames | The list of domains to embed in the certificate. If null the URL registered with GDS are used. |
privateKeyFormat | The format of the private key. Most GDS implementations should support PFX and PEM. |
privateKeyPassword | The password used to encrypt the private key. If null no encryption is done. |
callback | The callback. |
callbackData | The callback data. |
|
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.
applicationId | The application identifier assigned by the GDS to the application. |
certificateGroupId | The certificate group used to create the new certificate. If null the DefaultApplicationGroup is used |
certificateTypeId | The 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. |
certificateRequest | The certificate which is used as a template for the new certificate. The public key is copied from this certificate. |
callback | The callback. |
callbackData | The callback data. |
|
inline |
Begins an operation to unregister an application with the GDS.
applicationId | The unique identifier assigned by the HDS to the application. |
callback | The callback. |
callbackData | The callback data. |
System.ArgumentNullException | applicationId |
|
inline |
Begins an operation to update the application in the GDS.
application | The application information to store in the GDS. |
callback | The callback. |
callbackData | The callback data. |
System.ArgumentNullException | application |
|
inline |
Completes an operation to finds the application records in the GDS with the specified Application URI.
result | The object used to manage the state of the asychronous operation. |
System.ArgumentNullException | result |
|
inline |
Completes a check of the status of a request created by StartSigningRequest, StartNewKeyPairRequest or RenewCertificate.
result | The object used to manage the state of the asychronous operation. |
privateKey | The private key associated with the certificate (if one was requested). |
issuerCertificates | The CA certificates necessary to validate the new certificate. |
This method returns null if the certificate is not ready. The caller must wait and call the BeginFinishRequest method again.
|
inline |
Completes an operation to register an application with the GDS.
result | The object used to manage the state of the asychronous operation.. |
System.ArgumentNullException | result |
|
inline |
Completes a request to get the id of the trust list assigned to the application by the GDS.
result | The object used to manage the state of the asychronous operation. |
|
inline |
Completes a request to get the id of the trust list assigned to the application by the GDS.
result | The object used to manage the state of the asychronous operation. |
|
inline |
Completes a request to get the trust list assigned to the application by the GDS.
result | The object used to manage the state of the asychronous operation. |
|
inline |
Completes a request to get the id of the trust list assigned to the application by the GDS.
result | The object used to manage the state of the asychronous operation. |
|
inline |
Completes an operation to register an application with the GDS.
result | The object used to manage the state of the asychronous operation.. |
System.ArgumentNullException | result |
|
inline |
Completes a request that the GDS create a new certificate.
result | The object used to manage the state of the asychronous operation. |
This overload must be called if the PollingInterval passed to the begin method is 0.
|
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.
result | The object used to manage the state of the asychronous operation. |
This overload must be called if the PollingInterval passed to the begin method is 0.
|
inline |
Completes an operation to unregister the application in the GDS.
result | The object used to manage the state of the asychronous operation.. |
System.ArgumentNullException | result |
|
inline |
Completes an operation to update the application in the GDS.
result | The object used to manage the state of the asychronous operation.. |
System.ArgumentNullException | result |
|
inline |
Finds the application records in the GDS with the specified Application URI.
applicationUri | The application URI. |
System.ArgumentNullException | applicationUri |
|
inline |
Checks the status of a request created by StartSigningRequest, StartNewKeyPairRequest or RenewCertificate.
applicationId | The application identifier assigned by the GDS to the application. |
requestId | The request identifier return from the StartSigningRequest, StartNewKeyPairRequest or RenewCertificate call. |
pollingInterval | How frequently to check for a response. 0 means no check is done. |
privateKey | The private key associated with the certificate (if one was requested). |
issuerCertificates | The CA certificates necessary to validate the new certificate. |
This method returns null if the certificate is not ready. The caller must wait and call this method again.
|
inline |
Registers an application with the GDS.
applicationId | The application identifier. |
System.ArgumentNullException | applicationId |
|
inline |
Gets the certificate groups assigned to the application by the GDS.
applicationId | The application identifier assigned by the GDS to the application. |
|
inline |
Gets the status of the certificate.
applicationId | The application identifier assigned by the GDS to the application. |
certificateGroupId | The certificate group used to create the new certificate. If null the DefaultApplicationGroup is used |
certificateTypeId | The 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. |
|
inline |
Gets the trust list assigned to the application by the GDS.
applicationId | The application identifier assigned by the GDS to the application. |
certificateGroupId | The certificate group which owns the trust list to return. If null the DefaultApplicationGroup is used. |
masks | The masks which specify what parts of the trust list should be returned. |
|
inline |
Gets the id of the trust list assigned to the application by the GDS.
applicationId | The application identifier assigned by the GDS to the application. |
certificateGroupId | The certificate group which owns the trust list to return. If null the DefaultApplicationGroup is used. |
|
inline |
Registers an application with the GDS.
application | The application information to store in the GDS. |
System.ArgumentNullException | application |
|
inline |
Requests that the GDS create a new certificate.
applicationId | The application identifier assigned by the GDS to the application. |
certificateGroupId | The certificate group used to create the new certificate. If null the DefaultApplicationGroup is used |
certificateTypeId | The 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. |
|
inline |
Requests that the GDS create a new certificate.
applicationId | The application identifier assigned by the GDS to the application. |
certificateGroupId | The certificate group used to create the new certificate. If null the DefaultApplicationGroup is used |
certificateTypeId | The 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. |
subjectName | The 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. |
domainNames | The list of domains to embed in the certificate. If null the URL registered with GDS are used. |
privateKeyFormat | The format of the private key. Most GDS implementations should support PFX and PEM. |
privateKeyPassword | The password used to encrypt the private key. If null no encryption is done. |
|
inline |
Requests that the GDS create a new certificate based on the old one which is signed by a CA managed by the GDS.
applicationId | The application identifier assigned by the GDS to the application. |
certificateGroupId | The certificate group used to create the new certificate. If null the DefaultApplicationGroup is used |
certificateTypeId | The 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. |
certificateRequest | The certificate signing request (a PKCS#10 blob). |
|
inline |
Unegisters an application with the GDS.
applicationId | The unique identifier assigned by the HDS to the application. |
System.ArgumentNullException | applicationId |
|
inline |
Updates the application information stored in the GDS.
application | The application information to store in the GDS. |
System.ArgumentNullException | application |