ERUCES::TEAdminLocal

#include <teadmin_local.h>

The TEAdminLocal class represents Remote Engine administrative tasks and is derived from the TEAdmin class.

The TEAdminLocal class

Inheritance

• Inherits ERUCES::TEAdmin
• Inherited by ERUCES::TEAdminSecureFileExtension

Public Member Functions

Member	Description
TEAdminLocal()	The TEAdminLocal constructor is the default class constructor.
~TEAdminLocal()	The TEAdminLocal destructor is the class destructor.
void goOnLine()	The goOnline method allows Client Engine to work online.
void goOffLine(uint32_t newKey, uint32_t *newKeyRet, uint32_t *markKey, uint32_t *markKeyRet)	The goOffline method allows a Remote Engine (Desktop Server) to work offline.
void getStatus(TEObjectContainer &container, bool bEncode=false) const	The getStatus method gets the status of a checked-out TTag when the Remote Engine is offline. Type of objects returned in container is TESTR2UINT.
void setStatus(const TEObjectContainer &container, bool bEncode=false)	The setStatus method sets the status of a a checked out TTag when the Remote Engine is used offline. Type of objects in container should be TESTR2UINT.
void getConfiguration(const _TESTD string &xpath, _TESTD string &xml) const	The getConfiguration method gets a Remote Engine's configuration information.
void setConfiguration(const TEObjectContainer &xml)	The setConfiguration method sets a Remote Engine's configuration information, which is stored as XML.
void setParameter(const TEParameterRE &parameter)	The setParameter method updates a Remote Engine parameter.
void getParameter(TEParameterRE &parameter) const	The getParameter method gets a Remote Engine parameter.
void removeParameter(const TEParameterRE &parameter) const	The removeParameter method removes a Remote Engine parameter.
void refreshEnginePolicy() const	The refreshEnginePolicy method refreshes a Remote Engine policy.
_TESTD string generateCertificateRequest(unsigned int type, unsigned int kl_curve)	The generateCertificateRequest method generates Remote Engine certificate signing request - transport principal.
void clearCache()	The clearCache method clears the local cache.

Member Function Documentation

TEAdminLocal()

The TEAdminLocal constructor is the default class constructor.

~TEAdminLocal()

The TEAdminLocal destructor is the class destructor.

void goOnLine()

The goOnline method allows Client Engine to work online.

void goOffLine(uint32_t newKey, uint32_t *newKeyRet, uint32_t *markKey, uint32_t *markKeyRet)

The goOffline method allows a Remote Engine (Desktop Server) to work offline.

Parameters

Parameter	Description
newKey	An integer representing the number of new keys to be generated for checkout.
newKeyRet	A pointer to an integer representing the actual number of new keys that have been generated.
markKey	A pointer to an integer representing the number of marked keys to be checked out.
markKeyRet	A pointer to an integer representing the actual number of marked keys that have been checked out.

void getStatus(TEObjectContainer &container, bool bEncode=false) const

The getStatus method gets the status of a checked-out TTag when the Remote Engine is offline. Type of objects returned in container is TESTR2UINT.

Parameters

Parameter	Description
container	A container holding TESTR2UINT objects consisting of a TTag and its status; Input = TTag, Output = status.
bEncode	A boolean value flag indicating whether the TTag is Base64 encoded; TRUE = TTag is Base64 encoded and must be decoded, FALSE = TTag is not Base64 encoded.

void setStatus(const TEObjectContainer &container, bool bEncode=false)

The setStatus method sets the status of a a checked out TTag when the Remote Engine is used offline. Type of objects in container should be TESTR2UINT.

Parameters

Parameter	Description
container	A container holding TESTR2UINT objects consisting of a TTag and its status.
bEncode	A boolean value flag indicating whether the TTag is Base64 encoded; TRUE = TTag is Base64 encoded and must be decoded, FALSE = TTag is not Base64 encoded.

void getConfiguration(const _TESTD string &xpath, _TESTD string &xml) const

The getConfiguration method gets a Remote Engine's configuration information.

Parameters

Parameter	Description
xpath	A string representing an XPath of the node to be retrieved.
xml	A string representing an XML value of the configuration information.

Remark: The Client engine's configuration information is stored in XML format.

void setConfiguration(const TEObjectContainer &xml)

The setConfiguration method sets a Remote Engine's configuration information, which is stored as XML.

Client engine's configuration information is stored in XML format.

Parameters

Parameter	Description
xml	A container holding TESTR2STR objects consisting of XPath and XML value pairs.

void setParameter(const TEParameterRE &parameter)

The setParameter method updates a Remote Engine parameter.

Parameters

Parameter	Description
parameter	A TEParameterRE object parameter to be updated.

void getParameter(TEParameterRE &parameter) const

The getParameter method gets a Remote Engine parameter.

Parameters

Parameter	Description
parameter	A TEParameterRE object parameter to be retrieved.

void removeParameter(const TEParameterRE &parameter) const

The removeParameter method removes a Remote Engine parameter.

Parameters

Parameter	Description
parameter	A TEParameterRE object parameter to be removed.

void refreshEnginePolicy() const

The refreshEnginePolicy method refreshes a Remote Engine policy.

_TESTD string generateCertificateRequest(unsigned int type, unsigned int kl_curve)

The generateCertificateRequest method generates Remote Engine certificate signing request - transport principal.

Parameters

Parameter	Description
type	An integer representing the type of certificate. 0: ECC , 1: RSA
kl_curve	An integer representing the cryptographic curve to use. RSA : default=2048

void clearCache()

The clearCache method clears the local cache.