Interface TurbineModelManager
- All Superinterfaces:
ModelManager,Serializable
- All Known Implementing Classes:
AbstractTurbineModelManager
Describes all the relationships between entities in the "Turbine" model.
- Version:
- $Id$
- Author:
- Eric Pugh
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic enummay be used in implementations -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringattribute where global group name could be setstatic final StringThe name of the global group, if no global group name is set in model managerFields inherited from interface org.apache.fulcrum.security.ModelManager
ROLE -
Method Summary
Modifier and TypeMethodDescriptionProvides a reference to the Group object that represents the global group.voidgrant(Role role, Permission permission) Puts a permission in a role This method is used when adding a permission to a rolevoidGrant an User a Role in a Group.voidReplaces the assigned old Role to new role in the #global group for User user.voidrevoke(Role role, Permission permission) Removes a permission from a rolevoidRevoke a Role in a Group from an User.voidRevokes all roles and users from a Group.voidRevokes all permissions from a Role.voidRevokes by default all permissions from a Role and if flag is set all groups and users for this role This method is used when deleting a Role.voidRevokes all roles from an User.
-
Field Details
-
GLOBAL_GROUP_ATTR_NAME
attribute where global group name could be set- See Also:
-
GLOBAL_GROUP_NAME
The name of the global group, if no global group name is set in model manager- See Also:
-
-
Method Details
-
getGlobalGroup
Provides a reference to the Group object that represents the global group.- Returns:
- A Group object that represents the global group.
- Throws:
DataBackendException- generic exception
-
getGlobalGroupName
String getGlobalGroupName()- Returns:
- the configured global group name, by default
GLOBAL_GROUP_ATTR_NAME
-
replace
void replace(User user, Role oldRole, Role newRole) throws DataBackendException, UnknownEntityException Replaces the assigned old Role to new role in the #global group for User user.- Parameters:
user- the User.oldRole- the old RolenewRole- the new Role- Throws:
DataBackendException- generic exceptionUnknownEntityException- generic exception
-
grant
Puts a permission in a role This method is used when adding a permission to a role- Parameters:
role- the Role.permission- the Permission- Throws:
DataBackendException- if there was an error accessing the data backend.UnknownEntityException- if the account is not present.
-
revoke
Removes a permission from a role- Parameters:
role- the Role.permission- the Permission- Throws:
DataBackendException- if there was an error accessing the data backend.UnknownEntityException- if the role or permission is not present.
-
revokeAll
Revokes all roles from an User. This method is typically used when deleting an account.- Parameters:
user- the User.- Throws:
DataBackendException- if there was an error accessing the data backend.UnknownEntityException- if the account is not present.
-
revokeAll
Revokes all permissions from a Role. This method is typically used when deleting a Role.- Parameters:
role- the Role- Throws:
DataBackendException- if there was an error accessing the data backend.UnknownEntityException- if the Role is not present.
-
revokeAll
Revokes all roles and users from a Group. This method is typically used when deleting a Group.- Parameters:
group- the Group- Throws:
DataBackendException- if there was an error accessing the data backend.UnknownEntityException- if the Group is not present.
-
grant
Grant an User a Role in a Group.- Parameters:
user- the user.group- the group.role- the role.- Throws:
DataBackendException- if there was an error accessing the data backend.UnknownEntityException- if user account, group or role is not present.
-
revoke
Revoke a Role in a Group from an User.- Parameters:
user- the user.group- the group.role- the role.- Throws:
DataBackendException- if there was an error accessing the data backend.UnknownEntityException- if user account, group or role is not present.
-
revokeAll
void revokeAll(Role role, boolean cascadeDelete) throws DataBackendException, UnknownEntityException Revokes by default all permissions from a Role and if flag is set all groups and users for this role This method is used when deleting a Role.- Parameters:
role- the RolecascadeDelete- iftrueremoves all groups and user for this role.- Throws:
DataBackendException- if there was an error accessing the data backend.UnknownEntityException- if the Role is not present.
-