|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RoleFolder
A RoleFolder is a collection of child Roles and RoleFolders that serves as a organizing element for the space of global roles. It is not a Principal; no security permissions may be assigned to a RoleFolder.
Some directory implementations may not support the creation of any folders but the root folder.
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
|
Method Summary | |
---|---|
Role |
createGlobalRole(java.lang.String pRolePath)
Create an assignable global role in the directory in this RoleFolder. |
RoleFolder |
createRoleFolder(java.lang.String pFolderPath)
Create a new role folder within this RoleFolder. |
java.lang.String |
getName()
|
RoleFolder |
getParentFolder()
Get the parent RoleFolder of this Role, if it belongs to one. |
java.lang.String |
getPathName()
|
Role |
getRole(java.lang.String pRolePath)
Given the folder-relative pathname of a role, obtain the corresponding global role within this folder if it exists, otherwise return null. |
RoleFolder |
getRoleFolder(java.lang.String pFolderPath)
Given the folder-relative pathname of a child folder, obtain the corresponding child folder if it exists, otherwise return null. |
java.util.Collection |
getRoleFolders()
Obtain the set of child RoleFolders of this folder. |
java.util.Collection |
getRoles()
Obtain a set of global roles in this folder. |
java.util.Collection |
getRolesSortOnName(int pStartIndex,
int pEndIndex,
int pSortOrder)
Obtain a set of global roles in this folder, sorted on the name of the role, with index control of the roles returned. |
void |
remove()
Remove this folder and all of its descendant folders and roles from the user directory, and from its parent folder. |
void |
setName(java.lang.String folderName)
Rename the RoleFolder |
void |
setParentFolder(RoleFolder parent)
Make this RoleFolder the child of another RoleFolder. |
Field Detail |
---|
static final java.lang.String CLASS_VERSION
Method Detail |
---|
java.util.Collection getRoles()
java.util.Collection getRolesSortOnName(int pStartIndex, int pEndIndex, int pSortOrder)
pStartIndex
- starting index of roles in returned Collection of roles.pEndIndex
- ending index of roles in returned Collection of roles.pSortOrder
- sort order of return Collection of roles. values =
{ UserDirectory.SORT_ASCENDING, UserDirectory.SORT_DESCENDING )
java.lang.String getName()
void setName(java.lang.String folderName) throws DirectoryModificationException
folderName
- The name of the folder within the parent folder. It must
have no "/" characters.
DirectoryModificationException
java.lang.String getPathName()
void setParentFolder(RoleFolder parent) throws DirectoryModificationException
parent
- The new parent RoleFolder.
DirectoryModificationException
java.util.Collection getRoleFolders()
Role getRole(java.lang.String pRolePath)
pRolePath
- the pathname of a role relative to this folder
Role createGlobalRole(java.lang.String pRolePath) throws DirectoryModificationException
If the specified global role already exists, it is simply returned, without any modification to the directory having taken place.
pRolePath
- the pathname of the new role relative to this
folder. The role will be assigned a full name that is unique
within the namespace of all global roles. No path delimiters may
be included; the role must be a direct child of this folder.
DirectoryModificationException
- occurs if the operation fails
unexpectedly; a nested exception provides details.
RoleNotAssignableException
- occurs if the role already exists
but is not assignable.RoleFolder getRoleFolder(java.lang.String pFolderPath)
pFolderPath
- the pathname of a child folder relative to this folder
RoleFolder createRoleFolder(java.lang.String pFolderPath) throws DirectoryModificationException
If the specified folder already exists, it is simply returned, without any modification to the directory having taken place.
pFolderPath
- the pathname of the new folder relative to this
folder.
DirectoryModificationException
- occurs if the operation fails
unexpectedly; a nested exception provides details.RoleFolder getParentFolder()
void remove() throws DirectoryModificationException
DirectoryModificationException
- occurs if the operation fails
unexpectedly; a nested exception provides details.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |