|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.jetspeed.security.impl.RoleManagerImpl
public class RoleManagerImpl
Implementation 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.
Constructor Summary | |
---|---|
RoleManagerImpl(SecurityProvider securityProvider)
|
Method Summary | |
---|---|
void |
addRole(java.lang.String roleFullPathName)
Add a new role. |
void |
addRoleToGroup(java.lang.String roleFullPathName,
java.lang.String groupFullPathName)
Add a role to a group. |
void |
addRoleToUser(java.lang.String username,
java.lang.String roleFullPathName)
Add a role to a user. |
Role |
getRole(java.lang.String roleFullPathName)
Get a role Role for a given role full path name. |
java.util.Iterator |
getRoles(java.lang.String filter)
Get all roles available from all role handlers |
java.util.Collection |
getRolesForUser(java.lang.String username)
A collection of Role for all the roles
associated to a specific user. |
java.util.Collection |
getRolesInGroup(java.lang.String groupFullPathName)
A collection of Role for all the roles
associated to a specific group. |
boolean |
isGroupInRole(java.lang.String groupFullPathName,
java.lang.String roleFullPathName)
Whether or not a role is in a group. |
boolean |
isUserInRole(java.lang.String username,
java.lang.String roleFullPathName)
Whether or not a user is in a role. |
void |
removeRole(java.lang.String roleFullPathName)
Remove a given role and all the children of that role. |
void |
removeRoleFromGroup(java.lang.String roleFullPathName,
java.lang.String groupFullPathName)
Remove a role from a group. |
void |
removeRoleFromUser(java.lang.String username,
java.lang.String roleFullPathName)
Remove a user from a role. |
boolean |
roleExists(java.lang.String roleFullPathName)
Whether or not a role exists. |
void |
setRoleEnabled(java.lang.String roleFullPathName,
boolean enabled)
Enable or disable a role. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public RoleManagerImpl(SecurityProvider securityProvider)
securityProvider
- The security provider.Method Detail |
---|
public void addRole(java.lang.String roleFullPathName) throws SecurityException
RoleManager
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.
addRole
in interface RoleManager
roleFullPathName
- The role name full path
(e.g. theRoleName.theRoleNameChild).
SecurityException
RoleManager.addRole(java.lang.String)
public void removeRole(java.lang.String roleFullPathName) throws SecurityException
RoleManager
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.
removeRole
in interface RoleManager
roleFullPathName
- The role name full path
(e.g. theRoleName.theRoleNameChild).
SecurityException
RoleManager.removeRole(java.lang.String)
public boolean roleExists(java.lang.String roleFullPathName)
RoleManager
Whether or not a role exists.
roleExists
in interface RoleManager
roleFullPathName
- The role name full path
(e.g. theRoleName.theRoleNameChild).
RoleManager.roleExists(java.lang.String)
public Role getRole(java.lang.String roleFullPathName) throws SecurityException
RoleManager
Get a role Role
for a given role full path name.
getRole
in interface RoleManager
roleFullPathName
- The role name full path
(e.g. theRoleName.theRoleNameChild).
Preferences
node.
SecurityException
RoleManager.getRole(java.lang.String)
public java.util.Collection getRolesForUser(java.lang.String username) throws SecurityException
RoleManager
A collection of Role
for all the roles
associated to a specific user.
getRolesForUser
in interface RoleManager
username
- The user name.
Role
.
SecurityException
RoleManager.getRolesForUser(java.lang.String)
public java.util.Collection getRolesInGroup(java.lang.String groupFullPathName) throws SecurityException
RoleManager
A collection of Role
for all the roles
associated to a specific group.
getRolesInGroup
in interface RoleManager
groupFullPathName
- The group full path
(e.g. theGroupName.theGroupChildName).
Role
.
SecurityException
RoleManager.getRolesInGroup(java.lang.String)
public void addRoleToUser(java.lang.String username, java.lang.String roleFullPathName) throws SecurityException
RoleManager
Add a role to a user.
addRoleToUser
in interface RoleManager
username
- The user name.roleFullPathName
- The role name full path
(e.g. theRoleName.theRoleChildName).
SecurityException
RoleManager.addRoleToUser(java.lang.String,
java.lang.String)
public void removeRoleFromUser(java.lang.String username, java.lang.String roleFullPathName) throws SecurityException
RoleManager
Remove a user from a role.
removeRoleFromUser
in interface RoleManager
username
- The user name.roleFullPathName
- The role name full path relative to the
/role node (e.g. /theRoleName/theRoleChildName).
SecurityException
RoleManager.removeRoleFromUser(java.lang.String,
java.lang.String)
public boolean isUserInRole(java.lang.String username, java.lang.String roleFullPathName) throws SecurityException
RoleManager
Whether or not a user is in a role.
isUserInRole
in interface RoleManager
username
- The user name.roleFullPathName
- The role name full path
(e.g. theRoleName.theRoleChildName).
SecurityException
RoleManager.isUserInRole(java.lang.String,
java.lang.String)
public void addRoleToGroup(java.lang.String roleFullPathName, java.lang.String groupFullPathName) throws SecurityException
RoleManager
Add a role to a group.
addRoleToGroup
in interface RoleManager
roleFullPathName
- The role name full path
(e.g. theRoleName.theRoleChildName).groupFullPathName
- The group name full path
(e.g. theGroupName.theGroupChildName).
SecurityException
RoleManager.addRoleToGroup(java.lang.String,
java.lang.String)
public void removeRoleFromGroup(java.lang.String roleFullPathName, java.lang.String groupFullPathName) throws SecurityException
RoleManager
Remove a role from a group.
removeRoleFromGroup
in interface RoleManager
roleFullPathName
- The role name full path
(e.g. theRoleName.theRoleChildName).groupFullPathName
- The group name full path
(e.g. theGroupName.theGroupChildName).
SecurityException
RoleManager.removeRoleFromGroup(java.lang.String,
java.lang.String)
public boolean isGroupInRole(java.lang.String groupFullPathName, java.lang.String roleFullPathName) throws SecurityException
RoleManager
Whether or not a role is in a group.
isGroupInRole
in interface RoleManager
groupFullPathName
- The group name full path
(e.g. theGroupName.theGroupChildName).roleFullPathName
- The role name full path
(e.g. theRoleName.theRoleChildName).
SecurityException
RoleManager.isGroupInRole(java.lang.String,
java.lang.String)
public java.util.Iterator getRoles(java.lang.String filter) throws SecurityException
RoleManager
getRoles
in interface RoleManager
filter
- The filter used to retrieve matching roles.
Principal
SecurityException
RoleManager.getRoles(java.lang.String)
public void setRoleEnabled(java.lang.String roleFullPathName, boolean enabled) throws SecurityException
RoleManager
setRoleEnabled
in interface RoleManager
roleFullPathName
- The role name full path
(e.g. theRoleName.theRoleChildName).enabled
- enabled flag for the role
SecurityException
RoleManager.setRoleEnabled(java.lang.String, boolean)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |