UnifiedAutomation.UaServer.ITrustListMethods Interface Reference

The interface for methods implemented on the TrustListModel object. More...

Inherits UnifiedAutomation.UaServer.IFileMethods.

Inherited by UnifiedAutomation.UaServer.TrustListModel.

Public Member Functions
StatusCode	AddCertificate (RequestContext context, TrustListModel model, byte[] Certificate, bool IsTrustedCertificate)
StatusCode	CloseAndUpdate (RequestContext context, TrustListModel model, uint FileHandle, out bool ApplyChangesRequired)
	Closes the file and applies the changes to the trust list. More...
StatusCode	OpenWithMasks (RequestContext context, TrustListModel model, uint Masks, out uint FileHandle)
	Allows a Client to read only a portion of the trust list. More...
StatusCode	RemoveCertificate (RequestContext context, TrustListModel model, string Thumbprint, bool IsTrustedCertificate)
	Allows a Client to remove a single certificate from the trust list. More...
Public Member Functions inherited from UnifiedAutomation.UaServer.IFileMethods
StatusCode	Close (RequestContext context, FileModel model, uint FileHandle)
	Close is used to close a file represented by a FileType. When a client closes a file, the handle becomes invalid. More...
StatusCode	GetPosition (RequestContext context, FileModel model, uint FileHandle, out ulong Position)
	GetPosition is used to provide the current position of the FileHandle. More...
StatusCode	Open (RequestContext context, FileModel model, byte Mode, out uint FileHandle)
	Used to open a file represented by an Object of FileType. More...
StatusCode	Read (RequestContext context, FileModel model, uint FileHandle, int Length, out byte[] Data)
	Read is used to read a part of the file starting from the current file position. More...
StatusCode	SetPosition (RequestContext context, FileModel model, uint FileHandle, ulong Position)
	Used to set the current position of the FileHandle. More...
StatusCode	Write (RequestContext context, FileModel model, uint FileHandle, byte[] Data)
	Write is used to write a part of the file starting from the current file position. More...

Detailed Description

The interface for methods implemented on the TrustListModel object.

Member Function Documentation

StatusCode UnifiedAutomation.UaServer.ITrustListMethods.AddCertificate	(	RequestContext	context,
		TrustListModel	model,
		byte[]	Certificate,
		bool	IsTrustedCertificate
	)

Allows a Client to add a single certificate to the trust list. The Server always validates the certificate before adding it and returns the appropriate error code on failure.

This method cannot be called if the file object is open.

Parameters

context
model
Certificate	The DER encoded certificate to add.
IsTrustedCertificate	Flag indicating whether the certificate is not an issuer certificate. If TRUE, the certificate is added to the trusted certificates list. If FALSE, the certificate is added to the issuer certificates list.

Returns

Implemented in UnifiedAutomation.UaServer.TrustListModel.

StatusCode UnifiedAutomation.UaServer.ITrustListMethods.CloseAndUpdate	(	RequestContext	context,
		TrustListModel	model,
		uint	FileHandle,
		out bool	ApplyChangesRequired
	)

Closes the file and applies the changes to the trust list.

It can only be called if the file was opened for writing.

If the file cannot be processed, this method still closes the file and discards the data before returning an error. This method is required if the Server supports writes.

The structure uploaded includes a mask which specifies which fields are updated. If a bit is not set, the associated field is not changed.

Parameters

context
model
FileHandle	Handle of the previously opened file.
ApplyChangesRequired	A flag indicating whether a the UnifiedAutomation.UaServer.IServerConfigurationMethods.ApplyChanges method must be called before the new trust list will be used by the Server.

Returns

Implemented in UnifiedAutomation.UaServer.TrustListModel.

StatusCode UnifiedAutomation.UaServer.ITrustListMethods.OpenWithMasks	(	RequestContext	context,
		TrustListModel	model,
		uint	Masks,
		out uint	FileHandle
	)

Allows a Client to read only a portion of the trust list.

This method can only be used to read the trust list.

Parameters

context
model
Masks	The parts of the trust list that are include in the file to read.
FileHandle	The handle of the newly opened file.

Returns

Implemented in UnifiedAutomation.UaServer.TrustListModel.

StatusCode UnifiedAutomation.UaServer.ITrustListMethods.RemoveCertificate	(	RequestContext	context,
		TrustListModel	model,
		string	Thumbprint,
		bool	IsTrustedCertificate
	)

Allows a Client to remove a single certificate from the trust list.

It returns Bad_InvalidArgument if the thumbprint does not match a certificate in the trust list. This method cannot be called if the file object is open.

Parameters

context
model
Thumbprint	The SHA1 hash of the certificate to remove.
IsTrustedCertificate	Flag indicating whether the certificate is not an issuer certificate. If TRUE, the certificate is removed from the trusted certificates list. If FALSE, the certificate is removed from the issuer certificates list.

Returns

Implemented in UnifiedAutomation.UaServer.TrustListModel.

---

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

• C:/work/uasdknet/src/UaServer/Models/UaBaseClasses.cs