ERUCES::TEAdminTrustedServer

#include <teadmin_trustedserver.h>

The TEAdminTrustedServer class represents Trusted Server administrative tasks and is derived from the TEAdmin class.

Inheritance

• Inherits ERUCES::TEAdmin

Public Member Functions

Member	Description
TEAdminTrustedServer()	The TEAdminTrustedServer constructor is the default class constructor.
~TEAdminTrustedServer()	The TEAdminTrustedServer destructor is the class destructor.
TETrustedServerInfo addTrustedServer(const _TESTD string &fname, const _TESTD string &desc, const _TESTD string &data)	The addTrustedServer method adds a new Trusted Server to the list of Trusted Servers.
void removeTrustedServer(const TEObjectContainer &servers)	The removeTrustedServer method removes one or more Trusted Servers from the list of Trusted Servers.
void updateTrustedServer(const TEObjectContainer &servers)	The updateTrustedServer method changes Trusted Server information.
void getTrustedServerList(TEObjectContainer &servers)	The getTrustedServerList method gets a list of Trusted Servers.
_TESTD string getTrustInformation(_TESTD string &server)	The getTrustInformation method gets detailed information about a Trusted Server.
void acceptTrustCertificate(_TESTD string &cert, TECertObjectInfo &certObj)	The acceptTrustCertificate method imports a trusted certificate authority certificate.
void getExternalCertificateInfo(TECertObjectInfo &certObj)	The getExternalCertificateInfo method gets information about a trusted CA certificate.
void getPrincipalTrustMatrix(TEPrincipalTrustMatrix &matrix)	The getPrincipalTrustMatrix method retrieves the TEPrincipalTrustMatrix's object ID.
void getPrincipalTrustMatrix(te_oid pid, te_oid tsid, TEPrincipalTrustMatrix &matrix)	The getPrincipalTrustMatrix method retrieves the PrincipalTrustMatrix object by PrincipalTrustMatrix's principal ID and trusted server ID.
void getPrincipalTrustMatricesByPrincipalId(te_oid pid, TEObjectContainer &matrices)	The getPrincipalTrustMatricesByPrincipalId method retrieves all PrincipalTrustMatrix objects by principal ID.
void getPrincipalTrustMatricesByTrustedServerId(te_oid tsid, TEObjectContainer &matrices)	The getPrincipalTrustMatricesByTrustedServerId method retrieves all PrincipalTrustMatrix objects by trusted server ID.
void getAllPrincipalTrustMatrices(TEObjectContainer &matrices)	The getAllPrincipalTrustMatrices method retrieves all PrincipalTrustMatrix objects.
void addPrincipalTrustMatrix(const TEPrincipalTrustMatrix &matrix)	The addPrincipalTrustMatrix method adds a PrincipalTrustMatrix object.
void addPrincipalTrustMatrix(const TEObjectContainer &matrices)	The addPrincipalTrustMatrix method adds PrincipalTrustMatrix objects.
void updatePrincipalTrustMatrix(const TEPrincipalTrustMatrix &matrix)	The updatePrincipalTrustMatrix method updates a PrincipalTrustMatrix object.
void updatePrincipalTrustMatrix(const TEObjectContainer &matrices)	The updatePrincipalTrustMatrix method updates the PrincipalTrustMatrix objects.
void removePrincipalTrustMatrix(const TEPrincipalTrustMatrix &matrix)	The removePrincipalTrustMatrix method remove a PrincipalTrustMatrix object.

Member Function Documentation

TEAdminTrustedServer()

The TEAdminTrustedServer constructor is the default class constructor.

~TEAdminTrustedServer()

The TEAdminTrustedServer destructor is the class destructor.

TETrustedServerInfo addTrustedServer(const _TESTD string &fname, const _TESTD string &desc, const _TESTD string &data)

The addTrustedServer method adds a new Trusted Server to the list of Trusted Servers.

Parameters

Parameter	Description
fname	A string representing the Trusted Server's common name.
desc	A string representing a Trusted Server's description.
data	A string representing detailed data about a Trusted Server.

Returns: Returns a value indicating whether the TETrustedServerInfo object has been added successfully.

void removeTrustedServer(const TEObjectContainer &servers)

The removeTrustedServer method removes one or more Trusted Servers from the list of Trusted Servers.

Parameters

Parameter	Description
servers	A container holding one or more Trusted Server objects to be removed; must be TETrustedServerInfo objects.

See also: TETrustedServerInfo

void updateTrustedServer(const TEObjectContainer &servers)

The updateTrustedServer method changes Trusted Server information.

Parameters

Parameter	Description
servers	A container holding one or more Trusted Server objects to be updated; must be TETrustedServerInfo objects.

See also: TETrustedServerInfo

void getTrustedServerList(TEObjectContainer &servers)

The getTrustedServerList method gets a list of Trusted Servers.

Parameters

Parameter	Description
servers	A container to hold the returned Trusted Server list; must be TETrustedServerInfo objects.

See also: TETrustedServerInfo

_TESTD string getTrustInformation(_TESTD string &server)

The getTrustInformation method gets detailed information about a Trusted Server.

Parameters

Parameter	Description
server	A string representing the name of a Trusted Server.

Returns: Returns a string representing Trusted Server profile information.

void acceptTrustCertificate(_TESTD string &cert, TECertObjectInfo &certObj)

The acceptTrustCertificate method imports a trusted certificate authority certificate.

Parameters

Parameter	Description
cert	A string representing a trusted certificate authority certificate.
certObj	A TECertObjectInfo object returned when the certificate is accepted.

See also: TECertObjectInfo

void getExternalCertificateInfo(TECertObjectInfo &certObj)

The getExternalCertificateInfo method gets information about a trusted CA certificate.

Parameters

Parameter	Description
certObj	A TECertObjectInfo object.

void getPrincipalTrustMatrix(TEPrincipalTrustMatrix &matrix)

The getPrincipalTrustMatrix method retrieves the TEPrincipalTrustMatrix's object ID.

Parameters

Parameter	Description
matrix	PrincipalTrustMatrix object. Object id should be filled before calling the method.

void getPrincipalTrustMatrix(te_oid pid, te_oid tsid, TEPrincipalTrustMatrix &matrix)

The getPrincipalTrustMatrix method retrieves the PrincipalTrustMatrix object by PrincipalTrustMatrix's principal ID and trusted server ID.

Parameters

Parameter	Description
pid	An object representing the principal ID.
tsid	An object representing the trusted server ID.
matrix	PrincipalTrustMatrix object.

void getPrincipalTrustMatricesByPrincipalId(te_oid pid, TEObjectContainer &matrices)

The getPrincipalTrustMatricesByPrincipalId method retrieves all PrincipalTrustMatrix objects by principal ID.

Parameters

Parameter	Description
pid	An object representing the principal ID.
matrices	A container of PrincipalTrustMatrix objects to be returned.

void getPrincipalTrustMatricesByTrustedServerId(te_oid tsid, TEObjectContainer &matrices)

The getPrincipalTrustMatricesByTrustedServerId method retrieves all PrincipalTrustMatrix objects by trusted server ID.

Parameters

Parameter	Description
tsid	An object representing the trusted server ID.
matrices	A container of PrincipalTrustMatrix objects to be returned

void getAllPrincipalTrustMatrices(TEObjectContainer &matrices)

The getAllPrincipalTrustMatrices method retrieves all PrincipalTrustMatrix objects.

Parameters

Parameter	Description
matrices	A container of PrincipalTrustMatrix objects to be returned.

void addPrincipalTrustMatrix(const TEPrincipalTrustMatrix &matrix)

The addPrincipalTrustMatrix method adds a PrincipalTrustMatrix object.

Parameters

Parameter	Description
matrix	PrincipalTrustMatrix object to be added.

void addPrincipalTrustMatrix(const TEObjectContainer &matrices)

The addPrincipalTrustMatrix method adds PrincipalTrustMatrix objects.

Parameters

Parameter	Description
matrices	A container of PrincipalTrustMatrix objects to be added.

void updatePrincipalTrustMatrix(const TEPrincipalTrustMatrix &matrix)

The updatePrincipalTrustMatrix method updates a PrincipalTrustMatrix object.

Parameters

Parameter	Description
matrix	A PrincipalTrustMatrix object to be updated.

void updatePrincipalTrustMatrix(const TEObjectContainer &matrices)

The updatePrincipalTrustMatrix method updates the PrincipalTrustMatrix objects.

Parameters

Parameter	Description
matrices	A container of PrincipalTrustMatrix objects to be updated.

void removePrincipalTrustMatrix(const TEPrincipalTrustMatrix &matrix)

The removePrincipalTrustMatrix method remove a PrincipalTrustMatrix object.

Parameters

Parameter	Description
matrix	A PrincipalTrustMatrix object to be removed.