#include <AccessRightsManager.h>
List of all members.
Public Types |
| enum | ERightType { etRightTypeAllowed,
etRightTypeDenied,
etAllRightTypes
} |
| | Enumeration for the type of rights.
More...
|
Static Public Member Functions |
| static Retval | setRightsOnFileSystemItem (const TString &strFileSystemItem, bool bItemIsFolderNotFile, const TSingleLinkedList< TString > &rlstUserGroups, bool bReadAccess, bool bWriteAccess, bool bExecuteAccess, bool bAllAccess, bool bAccessNotDenied) |
| | Set rights on a file system item.
|
| static Retval | removeUserGroupsFromFileSystemItem (const TString &strFileSystemItem, bool bItemIsFolderNotFile, const TSingleLinkedList< TString > &rlstUserGroups, ERightType eRightType) |
| | Remove user groups from a file system item.
|
| static Retval | removeUserGroupsFromFolderRecursively (const TString &strFolder, const TSingleLinkedList< TString > &rlstUserGroups, ERightType eRightType) |
| | Remove user groups from a folder and recursively from all sub folders.
|
Detailed Description
Access Rights Manager Class.
Member Enumeration Documentation
Enumeration for the type of rights.
- Enumerator:
| etRightTypeAllowed |
|
| etRightTypeDenied |
|
| etAllRightTypes |
|
Member Function Documentation
| Retval zeus::TAccessRightsManager::removeUserGroupsFromFileSystemItem |
( |
const TString & |
strFileSystemItem, |
|
|
bool |
bItemIsFolderNotFile, |
|
|
const TSingleLinkedList< TString > & |
rlstUserGroups, |
|
|
ERightType |
eRightType |
|
) |
| [static] |
Remove user groups from a file system item.
Remove user groups from a file system item.
- Parameters:
-
| strFileSystemItem | [IN]: The file system item. |
| bItemIsFolderNotFile | [IN]: The item is a folder, not a file. |
| rlstUserGroups | [IN]: The set of user groups. |
| eRightType | [IN]: The type of rights. |
- Return values:
-
| RET_NOERROR | : Success. |
| RET_REQUEST_FAILED | : The rights could not be cleared due to regular errors, such as: |
- The caller does not have the right to modify access rights.
- Return values:
-
| RET_METHOD_NOT_IMPL | : The method is not implemented for the current platform or file system. |
Remove user groups from a folder and recursively from all sub folders.
Remove user groups from a folder and recursively from all sub folders.
- Parameters:
-
| strFolder | [IN]: Folder. |
| rlstUserGroups | [IN]: The set of user groups. |
| eRightType | [IN]: The type of rights. |
- Return values:
-
| RET_INTERNAL_ERROR,: | An internal error; for instance listing of sub folders failed. |
- Returns:
- : clearAllFolderAccessRights for specific return values.
| Retval zeus::TAccessRightsManager::setRightsOnFileSystemItem |
( |
const TString & |
strFileSystemItem, |
|
|
bool |
bItemIsFolderNotFile, |
|
|
const TSingleLinkedList< TString > & |
rlstUserGroups, |
|
|
bool |
bReadAccess, |
|
|
bool |
bWriteAccess, |
|
|
bool |
bExecuteAccess, |
|
|
bool |
bAllAccess, |
|
|
bool |
bAccessNotDenied |
|
) |
| [static] |
Set rights on a file system item.
Set rights on a file system item.
- Parameters:
-
| strFileSystemItem | [IN]: The file system item. |
| bItemIsFolderNotFile | [IN]: The item is a folder, not a file. |
| rlstUserGroups | [IN]: User groups to add rights for. |
| bReadAccess | [IN]: Set read access. |
| bWriteAccess | [IN]: Set write access. |
| bExecuteAccess | [IN]: Set execute access. |
| bAllAccess | [IN]: Set all access. |
| bAccessNotDenied | [IN]: Set access rights, not denied rights. |
- Return values:
-
| RET_NOERROR | : Success. |
| RET_REQUEST_FAILED | : The right could not be set due to regular errors, such as: |
- The folder did not exist and could not be created.
- One of the user groups does not exist.
- The caller does not have the right to modify access rights.
- Return values:
-
| RET_INVALID_PARAMETER | : rlstUserGroups is empty. |
| RET_INTERNAL_ERROR | : Development error. |
| RET_METHOD_NOT_IMPL | : The method is not implemented for the current platform or file system. |
The documentation for this class was generated from the following files:
