|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RoleManager
Describes the service interface for managing roles.
Role hierarchy elements are being returned as a Role
collection. The backing implementation must appropriately map
the role hierarchy to a preferences sub-tree.
The convention {principal}.{subprincipal} has been chosen to name roles hierachies in order to support declarative security. Implementation follow the conventions enforced by the preferences API.
Method Summary | |
---|---|
void |
addRole(String roleFullPathName)
Add a new role. |
void |
addRoleToGroup(String roleFullPathName,
String groupFullPathName)
Add a role to a group. |
void |
addRoleToUser(String username,
String roleFullPathName)
Add a role to a user. |
Role |
getRole(String roleFullPathName)
Get a role Role for a given role full path name. |
Iterator |
getRoles(String filter)
Get all roles available from all role handlers |
Collection |
getRolesForUser(String username)
A collection of Role for all the roles
associated to a specific user. |
Collection |
getRolesInGroup(String groupFullPathName)
A collection of Role for all the roles
associated to a specific group. |
boolean |
isGroupInRole(String groupFullPathName,
String roleFullPathName)
Whether or not a role is in a group. |
boolean |
isUserInRole(String username,
String roleFullPathName)
Whether or not a user is in a role. |
void |
removeRole(String roleFullPathName)
Remove a given role and all the children of that role. |
void |
removeRoleFromGroup(String roleFullPathName,
String groupFullPathName)
Remove a role from a group. |
void |
removeRoleFromUser(String username,
String roleFullPathName)
Remove a user from a role. |
boolean |
roleExists(String roleFullPathName)
Whether or not a role exists. |
void |
setRoleEnabled(String roleFullPathName,
boolean enabled)
Enable or disable a role. |
Method Detail |
---|
void addRole(String roleFullPathName) throws SecurityException
Add a new role.
Role principal names are expressed as {principal}.{subprincipal} where "." is the separator expressing the hierarchical nature of a role.
Role principal path names are stored leveraging the Preferences
api. Roles will be stored under /role/theGroupName/theGroupNameChild
when given the full path name theRoleName.theRoleNameChild.
roleFullPathName
- The role name full path
(e.g. theRoleName.theRoleNameChild).
Throws
- a security exception if the role already exists.
SecurityException
void removeRole(String roleFullPathName) throws SecurityException
Remove a given role and all the children of that role.
Role principal names are expressed as {principal}.{subprincipal} where "." is the separator expressing the hierarchical nature of a role.
Role principal path names are stored leveraging the Preferences
api. Roles will be stored under /role/theGroupName/theGroupNameChild
when given the full path name theRoleName.theRoleNameChild.
roleFullPathName
- The role name full path
(e.g. theRoleName.theRoleNameChild).
Throws
- a security exception.
SecurityException
boolean roleExists(String roleFullPathName)
Whether or not a role exists.
roleFullPathName
- The role name full path
(e.g. theRoleName.theRoleNameChild).
Role getRole(String roleFullPathName) throws SecurityException
Get a role Role
for a given role full path name.
roleFullPathName
- The role name full path
(e.g. theRoleName.theRoleNameChild).
Preferences
node.
Throws
- a security exception if the role does not exist.
SecurityException
Collection getRolesForUser(String username) throws SecurityException
A collection of Role
for all the roles
associated to a specific user.
username
- The user name.
Role
.
Throws
- a security exception if the user does not exist.
SecurityException
Collection getRolesInGroup(String groupFullPathName) throws SecurityException
A collection of Role
for all the roles
associated to a specific group.
groupFullPathName
- The group full path
(e.g. theGroupName.theGroupChildName).
Role
.
Throws
- a security exception if the group does not exist.
SecurityException
void addRoleToUser(String username, String roleFullPathName) throws SecurityException
Add a role to a user.
username
- The user name.roleFullPathName
- The role name full path
(e.g. theRoleName.theRoleChildName).
Throws
- a security exception if the role or the user do not exist.
SecurityException
void removeRoleFromUser(String username, String roleFullPathName) throws SecurityException
Remove a user from a role.
username
- The user name.roleFullPathName
- The role name full path relative to the
/role node (e.g. /theRoleName/theRoleChildName).
Throws
- a security exception.
SecurityException
boolean isUserInRole(String username, String roleFullPathName) throws SecurityException
Whether or not a user is in a role.
username
- The user name.roleFullPathName
- The role name full path
(e.g. theRoleName.theRoleChildName).
Throws
- a security exception if the role or the user does not exist.
SecurityException
void addRoleToGroup(String roleFullPathName, String groupFullPathName) throws SecurityException
Add a role to a group.
roleFullPathName
- The role name full path
(e.g. theRoleName.theRoleChildName).groupFullPathName
- The group name full path
(e.g. theGroupName.theGroupChildName).
Throws
- a security exception.
SecurityException
void removeRoleFromGroup(String roleFullPathName, String groupFullPathName) throws SecurityException
Remove a role from a group.
roleFullPathName
- The role name full path
(e.g. theRoleName.theRoleChildName).groupFullPathName
- The group name full path
(e.g. theGroupName.theGroupChildName).
Throws
- a security exception.
SecurityException
boolean isGroupInRole(String groupFullPathName, String roleFullPathName) throws SecurityException
Whether or not a role is in a group.
groupFullPathName
- The group name full path
(e.g. theGroupName.theGroupChildName).roleFullPathName
- The role name full path
(e.g. theRoleName.theRoleChildName).
Throws
- a security exception if the role or the group does not exist.
SecurityException
Iterator getRoles(String filter) throws SecurityException
filter
- The filter used to retrieve matching roles.
Principal
SecurityException
void setRoleEnabled(String roleFullPathName, boolean enabled) throws SecurityException
roleFullPathName
- The role name full path
(e.g. theRoleName.theRoleChildName).enabled
- enabled flag for the role
SecurityException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |