ERUCES::TEAdminACL
#include <teadmin_acl.h>
The TEAdminACL class administrates access control list (ACL) Templates.
The TEAdminACL class
© Pi Soft, 2018-2026 · Tricryption Engine 8.1
Inheritance
- Inherits ERUCES::TEAdmin
Public Types
enum ACL_TEMPLATE_MEMBER_UPDATE_OPERATION
| Value | Description |
|---|---|
ACL_TEMPLATE_MEMBER_ADD | Add new ACL Template Member to ACLTemplate |
ACL_TEMPLATE_MEMBER_UPDATE | Update ACL Template Member in ACLTemplate |
ACL_TEMPLATE_MEMBER_REMOVE | Remove ACL Template Member from ACLTemplate |
ACL_TEMPLATE_UPDATE | Update ACL Template |
Public Member Functions
| Member | Description |
|---|---|
TEAdminACL() | The TEAdminACL constructor is the default class constructor. |
~TEAdminACL() | The TEAdminACL constructor is the class destructor. |
void addACLTemplate(TEACLTemplate &acltemplate) | The addACLTemplate method adds a new ACLTemplate object. |
void removeACLTemplate(const TEACLTemplate &acltemplate) | The removeACLTemplate method removes an ACLTemplate object. |
void getACLTemplate(TEACLTemplate &acltemplate) | The getACLTemplate method gets an ACLTemplate object. |
void getACLTemplate(TEObjectContainer &container) | The getACLTemplate method gets all ACLTemplates. |
void updateACLTemplate(TEACLTemplate &aclt) | The updateACLTemplate method updates an ACLTemplate. |
void updateACLTemplateMember(TEACLTemplateMember &acltm, ACL_TEMPLATE_MEMBER_UPDATE_OPERATION op) | The updateACLTemplateMember method updates an ACLTemplateMember. |
void updateACLTemplateMember(TEObjectContainer &container, ACL_TEMPLATE_MEMBER_UPDATE_OPERATION op) | The updateACLTemplateMember method updates multiple ACLTemplateMembers. |
void addTemplatedDirectory(TETemplatedDirectory &dir) | The addTemplatedDirectory method adds a new templated directory. |
void removeTemplatedDirectory(const TETemplatedDirectory &dir) | The removeTemplatedDirectory method removes a templated directory. |
void getTemplatedDirectory(TETemplatedDirectory &dir) | The getTemplatedDirectory method gets a templated directory. |
void getTemplatedDirectory(TEObjectContainer &container) | The getTemplatedDirectory method gets all templated directories. |
void updateTemplatedDirectory(const TETemplatedDirectory &dir) | The updateTemplatedDirectory method updates a templated directory. |
void authorizePrincipal(const _TESTD string &hiddenlink, const _TESTD string &filename, bool decode=true) | The authorizePrincipal method asks the Key Service whether the principal on this connection is authorized to use a TTag, optionally in the context of a named file. It returns normally when access is granted and raises a TEAdminException when it is refused. |
Member Function Documentation
TEAdminACL()
The TEAdminACL constructor is the default class constructor.
~TEAdminACL()
The TEAdminACL constructor is the class destructor.
void addACLTemplate(TEACLTemplate &acltemplate)
The addACLTemplate method adds a new ACLTemplate object.
Parameters
| Parameter | Description |
|---|---|
acltemplate | An TEACLTemplate object representing the ACL template to be added. |
void removeACLTemplate(const TEACLTemplate &acltemplate)
The removeACLTemplate method removes an ACLTemplate object.
Parameters
| Parameter | Description |
|---|---|
acltemplate | An TEACLTemplate object representing the ACL template to be removed. |
void getACLTemplate(TEACLTemplate &acltemplate)
The getACLTemplate method gets an ACLTemplate object.
Parameters
| Parameter | Description |
|---|---|
acltemplate | An TEACLTemplate object representing the ACL template to be retrieved. |
void getACLTemplate(TEObjectContainer &container)
The getACLTemplate method gets all ACLTemplates.
Parameters
| Parameter | Description |
|---|---|
container | A TEObjectContainer object for all ACLtemplates to be retrieved. |
void updateACLTemplate(TEACLTemplate &aclt)
The updateACLTemplate method updates an ACLTemplate.
Parameters
| Parameter | Description |
|---|---|
aclt | An TEACLTemplate object to be updated. |
void updateACLTemplateMember(TEACLTemplateMember &acltm, ACL_TEMPLATE_MEMBER_UPDATE_OPERATION op)
The updateACLTemplateMember method updates an ACLTemplateMember.
Parameters
| Parameter | Description |
|---|---|
acltm | ACL template member to be updated. |
op | An update flag. See ACL_TEMPLATE_MEMBER_UPDATE_OPERATION |
void updateACLTemplateMember(TEObjectContainer &container, ACL_TEMPLATE_MEMBER_UPDATE_OPERATION op)
The updateACLTemplateMember method updates multiple ACLTemplateMembers.
Parameters
| Parameter | Description |
|---|---|
container | ACL template members to be updated. |
op | An update flag. See ACL_TEMPLATE_MEMBER_UPDATE_OPERATION |
void addTemplatedDirectory(TETemplatedDirectory &dir)
The addTemplatedDirectory method adds a new templated directory.
Parameters
| Parameter | Description |
|---|---|
dir | The templated directory to be added. |
void removeTemplatedDirectory(const TETemplatedDirectory &dir)
The removeTemplatedDirectory method removes a templated directory.
Parameters
| Parameter | Description |
|---|---|
dir | The templated directory to be removed. |
void getTemplatedDirectory(TETemplatedDirectory &dir)
The getTemplatedDirectory method gets a templated directory.
Parameters
| Parameter | Description |
|---|---|
dir | The templated directory to be retrieved. |
void getTemplatedDirectory(TEObjectContainer &container)
The getTemplatedDirectory method gets all templated directories.
Parameters
| Parameter | Description |
|---|---|
container | A container for all templated directory to be retrieved. |
void updateTemplatedDirectory(const TETemplatedDirectory &dir)
The updateTemplatedDirectory method updates a templated directory.
Parameters
| Parameter | Description |
|---|---|
dir | The templated directory to be updated. |
void authorizePrincipal(const _TESTD string &hiddenlink, const _TESTD string &filename, bool decode=true)
The authorizePrincipal method asks the Key Service whether the principal on this connection is authorized to use a TTag, optionally in the context of a named file. It returns normally when access is granted and raises a TEAdminException when it is refused.
Parameters
| Parameter | Description |
|---|---|
hiddenlink | The TTag to be verified. |
filename | A string representing the file name. |
decode | TRUE- TTag is in encoded format, FALSE- TTag is in raw format |
Examples
- cpp_admin_principal_acltemplate_set.cpp
- cpp_adminacl_acltemplate_add.cpp
- cpp_adminacl_acltemplate_get.cpp
- cpp_adminacl_acltemplate_remove.cpp
- cpp_adminacl_acltemplate_update.cpp
- cpp_adminacl_templatedir_add.cpp
- cpp_adminacl_templatedir_get.cpp
- cpp_adminacl_templatedir_remove.cpp
- cpp_adminacl_templatedir_update.cpp