ERUCES::TEACLInfo

Inheritance

• Inherits ERUCES::TEUpdatableObject

Public Member Functions

Member	Description
TEACLInfo()	The TEACLInfo constructor is the default class constructor.
TEACLInfo(const TEACLInfo &)	The TEACLInfo constructor copies an object.
~TEACLInfo()	The TEACLInfo destructor is the class destructor.
void setHiddenLink(const _TESTD string &hl, bool decode=false)	The setHiddenLink method sets a TTag in a TEACLInfo object.
void getHiddenLink(_TESTD string &hl, bool encode=false) const	The getHiddenLink method gets a TTag from a TEACLInfo object.
void setACLId(te_oid id)	The setACLID method sets a unique identifier for an access control list (ACL).
te_oid getACLId() const	The getACLId method gets an access control list identifier.
void setKeyExpirationFlag(uint32_t flag)	The setKeyExpirationFlag method sets a key expiration status flag.
uint32_t getKeyExpirationFlag() const	The getKeyExpirationFlag method gets a key expiration status flag.
void setCreationTimestamp(time_t t)	The setCreationTimestamp method sets a timestamp indicating when a TEACLInfo object was created.
time_t getCreationTimestamp() const	The getCreationTimestamp method gets the timestamp issued when a TEACLInfo object was created.
uint32_t EntryCount() const	The entryCount method gets the number of ACL entries in a TEACLInfo object.
void getEntries(TEObjectContainer &container) const	The getEntries method gets a copy of all ACL entries in a TEACLInfo object.
bool addEntry(const TEACLEntry &entry)	The addEntry method adds an ACL entry to a TEACLInfo object.
bool removeEntry(const TEACLEntry &entry)	The removeEntry method removes an ACL entry from a TEACLInfo object.
void clearEntry()	The clearEntry method clears all ACL entries from a TEACLInfo object.
TEACLEntry operator[](_TESTD pair< uint32_t, te_oid > pid)	The TEACLEntry operator[] returns a pointer to a TEACLEntry object at the position indicated by the given system ID and principal ID.
const TEACLEntry operator[](_TESTD pair< uint32_t, te_oid > pid) const	The TEACLEntry operator returns a constant pointer to the object at the position indicated by the given index.
TEObject * clone() const	The clone method clones a TEACLInfo object, including all ACL entries in the object.

Member Function Documentation

TEACLInfo()

The TEACLInfo constructor is the default class constructor.

TEACLInfo(const TEACLInfo &)

The TEACLInfo constructor copies an object.

~TEACLInfo()

The TEACLInfo destructor is the class destructor.

void setHiddenLink(const _TESTD string &hl, bool decode=false)

The setHiddenLink method sets a TTag in a TEACLInfo object.

Parameters

Parameter	Description
hl	A string representing the TTag to be set.
decode	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 getHiddenLink(_TESTD string &hl, bool encode=false) const

The getHiddenLink method gets a TTag from a TEACLInfo object.

Parameters

Parameter	Description
hl	A string representing the returned TTag data.
encode	A boolean value flag indicating whether the TTag is Base64 encoded; TRUE = TTag is Base64 encoded, FALSE = TTag is not Base64 encoded.

void setACLId(te_oid id)

The setACLID method sets a unique identifier for an access control list (ACL).

Parameters

Parameter	Description
id	The ACL ID to be set.

te_oid getACLId() const

The getACLId method gets an access control list identifier.

Returns: Returns an ACL ID.

void setKeyExpirationFlag(uint32_t flag)

The setKeyExpirationFlag method sets a key expiration status flag.

Parameters

Parameter	Description
flag	The expiration status flag to be set; 1 = key has expired, 0 = key has not expired.

uint32_t getKeyExpirationFlag() const

The getKeyExpirationFlag method gets a key expiration status flag.

Returns: Returns a key expiration status flag; 1 = key has expired, 0 = key has not expired.

void setCreationTimestamp(time_t t)

The setCreationTimestamp method sets a timestamp indicating when a TEACLInfo object was created.

Parameters

Parameter	Description
t	A timestamp indicating when a TEACLInfo object was created.

time_t getCreationTimestamp() const

The getCreationTimestamp method gets the timestamp issued when a TEACLInfo object was created.

Returns: Returns a TEACLInfo object's creation timestamp.

uint32_t EntryCount() const

The entryCount method gets the number of ACL entries in a TEACLInfo object.

Returns: The number of ACL entries in a TEACLInfo object.

void getEntries(TEObjectContainer &container) const

The getEntries method gets a copy of all ACL entries in a TEACLInfo object.

Parameters

Parameter	Description
container	A container to hold the ACL entries; contents must be TEACLEntry objects.

bool addEntry(const TEACLEntry &entry)

The addEntry method adds an ACL entry to a TEACLInfo object.

Parameters

Parameter	Description
entry	The ACL entry to be added.

Returns: Returns a boolean value indicating if the ACL entry has been added to the ACL object successfully.

bool removeEntry(const TEACLEntry &entry)

The removeEntry method removes an ACL entry from a TEACLInfo object.

Parameters

Parameter	Description
entry	The entry to be removed.

Returns: Returns a boolean value indicating if the entry has been removed from the TEACLInfo object successfully.

void clearEntry()

The clearEntry method clears all ACL entries from a TEACLInfo object.

TEACLEntry operator[](_TESTD pair< uint32_t, te_oid > pid)

The TEACLEntry operator[] returns a pointer to a TEACLEntry object at the position indicated by the given system ID and principal ID.

Parameters

Parameter	Description
pid	A pair consisting of a system ID and a principal ID.

Returns: Returns a pointer to the TEACLEntry object.

const TEACLEntry operator[](_TESTD pair< uint32_t, te_oid > pid) const

The TEACLEntry operator returns a constant pointer to the object at the position indicated by the given index.

Parameters

Parameter	Description
pid	A pair consisting of a system ID and a principal ID.

Returns: Returns a constant pointer to the TEACLEntry object.

TEObject * clone() const

The clone method clones a TEACLInfo object, including all ACL entries in the object.

Returns: Returns a cloned TEACLInfo object.