Interface TurbineModelManager
- All Superinterfaces:
ModelManager
,Serializable
- All Known Implementing Classes:
AbstractTurbineModelManager
public interface TurbineModelManager extends ModelManager
Describes all the relationships between entities in the "Turbine" model.
- Version:
- $Id: TurbineModelManager.java 1845858 2018-11-05 21:14:02Z painter $
- Author:
- Eric Pugh
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
TurbineModelManager.Privilege
may be used in implementations -
Field Summary
Fields Modifier and Type Field Description static String
GLOBAL_GROUP_ATTR_NAME
attribute where global group name could be setstatic String
GLOBAL_GROUP_NAME
The name of the global group, if no global group name is set in model manager -
Method Summary
Modifier and Type Method Description Group
getGlobalGroup()
Provides a reference to the Group object that represents the global group.String
getGlobalGroupName()
void
grant(Role role, Permission permission)
Puts a permission in a role This method is used when adding a permission to a rolevoid
grant(User user, Group group, Role role)
Grant an User a Role in a Group.void
replace(User user, Role oldRole, Role newRole)
Replaces the assigned old Role to new role in the #global group for User user.void
revoke(Role role, Permission permission)
Removes a permission from a rolevoid
revoke(User user, Group group, Role role)
Revoke a Role in a Group from an User.void
revokeAll(Group group)
Revokes all roles and users from a Group.void
revokeAll(Role role)
Revokes all permissions from a Role.void
revokeAll(Role role, boolean cascadeDelete)
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.void
revokeAll(User user)
Revokes all roles from an User.
-
Field Details
-
GLOBAL_GROUP_ATTR_NAME
attribute where global group name could be set- See Also:
- Constant Field Values
-
GLOBAL_GROUP_NAME
The name of the global group, if no global group name is set in model manager- See Also:
- Constant Field Values
-
-
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, UnknownEntityExceptionReplaces 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, UnknownEntityExceptionRevokes 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
- iftrue
removes 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.
-