Interface TurbineAccessControlList<T extends TurbineAccessControlList<T>>
- All Superinterfaces:
AccessControlList
,Serializable
- All Known Implementing Classes:
TurbineAccessControlListImpl
public interface TurbineAccessControlList<T extends TurbineAccessControlList<T>>
extends Serializable, AccessControlList
This interface describes a control class that makes it
easy to find out if a particular User has a given Permission.
It also determines if a User has a a particular Role.
- Version:
- $Id: AccessControlList.java 615328 2008-01-25 20:25:05Z tv $
- Author:
- John D. McNally, Brett McLaughlin, Greg Ritter, Rafal Krzewski, Marco Knüttel, Henning P. Schmiedehausen
-
Method Summary
Modifier and TypeMethodDescriptionGroup[]
Returns all groups defined in the system.Retrieves a set of Groups an user is assigned to.Retrieves a set of Permissions an user is assigned in the global Group.getPermissions
(Group group) Retrieves a set of Permissions an user is assigned in a Group.getRoles()
Retrieves a set of Roles an user is assigned in the global Group.Retrieves a set of Roles an user is assigned in a Group.boolean
hasPermission
(String permission) Checks if the user is assigned a specific Permission in the global Group.boolean
hasPermission
(String permission, String group) Checks if the user is assigned a specific Permission in the Group.boolean
hasPermission
(String permission, Group group) Checks if the user is assigned a specific Permission in the Group.boolean
hasPermission
(String permissionName, GroupSet groupset) Checks if the user is assigned a specifie Permission in any of the given Groupsboolean
hasPermission
(Permission permission) Checks if the user is assigned a specific Permission in the global Group.boolean
hasPermission
(Permission permission, Group group) Checks if the user is assigned a specific Permission in the Group.boolean
hasPermission
(Permission permission, GroupSet groupset) Checks if the user is assigned a specific Permission in any of the given Groupsboolean
Checks if the user is assigned a specific Role in the global Group.boolean
Checks if the user is assigned a specific Role in the Group.boolean
Checks if the user is assigned a specifie Role in any of the given Groupsboolean
Checks if the user is assigned a specific Role in the global Group.boolean
Checks if the user is assigned a specific Role in the Group.boolean
Checks if the user is assigned a specific Role in any of the given Groups
-
Method Details
-
getRoles
Retrieves a set of Roles an user is assigned in a Group.- Parameters:
group
- the Group- Returns:
- the set of Roles this user has within the Group.
-
getRoles
RoleSet getRoles()Retrieves a set of Roles an user is assigned in the global Group.- Returns:
- the set of Roles this user has within the global Group or null.
-
getPermissions
Retrieves a set of Permissions an user is assigned in a Group.- Parameters:
group
- the Group- Returns:
- the set of Permissions this user has within the Group.
-
getPermissions
PermissionSet getPermissions()Retrieves a set of Permissions an user is assigned in the global Group.- Returns:
- the set of Permissions this user has within the global Group.
-
hasRole
Checks if the user is assigned a specific Role in the Group.- Parameters:
role
- the Rolegroup
- the Group- Returns:
true
if the user is assigned the Role in the Group.
-
hasRole
Checks if the user is assigned a specific Role in any of the given Groups- Parameters:
role
- the Rolegroupset
- a Groupset- Returns:
true
if the user is assigned the Role in any of the given Groups.
-
hasRole
Checks if the user is assigned a specific Role in the Group.- Parameters:
role
- the Rolegroup
- the Group- Returns:
true
if the user is assigned the Role in the Group.
-
hasRole
Checks if the user is assigned a specifie Role in any of the given Groups- Parameters:
rolename
- the name of the Rolegroupset
- a Groupset- Returns:
true
if the user is assigned the Role in any of the given Groups.
-
hasRole
Checks if the user is assigned a specific Role in the global Group.- Parameters:
role
- the Role- Returns:
true
if the user is assigned the Role in the global Group.
-
hasRole
Checks if the user is assigned a specific Role in the global Group.- Parameters:
role
- the Role- Returns:
true
if the user is assigned the Role in the global Group.
-
hasPermission
Checks if the user is assigned a specific Permission in the Group.- Parameters:
permission
- the Permissiongroup
- the Group- Returns:
true
if the user is assigned the Permission in the Group.
-
hasPermission
Checks if the user is assigned a specific Permission in any of the given Groups- Parameters:
permission
- the Permissiongroupset
- a Groupset- Returns:
true
if the user is assigned the Permission in any of the given Groups.
-
hasPermission
Checks if the user is assigned a specific Permission in the Group.- Parameters:
permission
- the Permissiongroup
- the Group- Returns:
true
if the user is assigned the Permission in the Group.
-
hasPermission
Checks if the user is assigned a specific Permission in the Group.- Parameters:
permission
- the Permissiongroup
- the Group- Returns:
true
if the user is assigned the Permission in the Group.
-
hasPermission
Checks if the user is assigned a specifie Permission in any of the given Groups- Parameters:
permissionName
- the name of the Permissiongroupset
- a Groupset- Returns:
true
if the user is assigned the Permission in any of the given Groups.
-
hasPermission
Checks if the user is assigned a specific Permission in the global Group.- Parameters:
permission
- the Permission- Returns:
true
if the user is assigned the Permission in the global Group.
-
hasPermission
Checks if the user is assigned a specific Permission in the global Group.- Parameters:
permission
- the Permission- Returns:
true
if the user is assigned the Permission in the global Group.
-
getAllGroups
Group[] getAllGroups()Returns all groups defined in the system.- Returns:
- An Array of all defined Groups This is useful for debugging, when you want to display all roles and permissions an user is assigned. This method is needed because you can't call static methods of TurbineSecurity class from within WebMacro/Velocity template
-
getGroupSet
GroupSet getGroupSet()Retrieves a set of Groups an user is assigned to.- Returns:
- the set of Groups this user is assigned to.
-