Package org.apache.fulcrum.security.model.dynamic

Interface DynamicAccessControlList

All Superinterfaces:

AccessControlList, Serializable

All Known Implementing Classes:

DynamicAccessControlListImpl

public interface DynamicAccessControlList
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$

Author:

Eric Pugh, Brett McLaughlin, Greg Ritter, Rafal Krzewski, Henning P. Schmiedehausen, Marco Knüttel

Method Summary

Modifier and Type	Method	Description
PermissionSet	getPermissions()	Retrieves a set of Permissions an user is assigned
PermissionSet	getPermissions(Group group)	Retrieves a set of Permissions an user is assigned in a Group.
RoleSet	getRoles()	Retrieves all roles for a user
RoleSet	getRoles(Group 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 Groups
boolean	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 Groups
boolean	hasRole(String role)	Checks if the user is assigned a specific Role.
boolean	hasRole(String role, String group)	Checks if the user is assigned a specific Role in the Group.
boolean	hasRole(String rolename, GroupSet groupset)	Checks if the user is assigned a specifie Role in any of the given Groups
boolean	hasRole(Role role)	Checks if the user is assigned a specific Role in the global Group.
boolean	hasRole(Role role, Group group)	Checks if the user is assigned a specific Role in the Group.
boolean	hasRole(Role role, GroupSet groupset)	Checks if the user is assigned a specific Role in any of the given Groups

Method Detail

getRoles

RoleSet getRoles(Group group)

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 all roles for a user

Returns:

the set of Roles this user has

getPermissions

PermissionSet getPermissions(Group group)

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

Returns:

the set of Permissions this user has.

hasRole

boolean hasRole(Role role,
                Group group)

Checks if the user is assigned a specific Role in the Group.

Parameters:

role - the Role

group - the Group

Returns:

true if the user is assigned the Role in the Group.

hasRole

boolean hasRole(Role role,
                GroupSet groupset)

Checks if the user is assigned a specific Role in any of the given Groups

Parameters:

role - the Role

groupset - a Groupset

Returns:

true if the user is assigned the Role in any of the given Groups.

hasRole

boolean hasRole(String role,
                String group)

Checks if the user is assigned a specific Role in the Group.

Parameters:

role - the Role

group - the Group

Returns:

true if the user is assigned the Role in the Group.

hasRole

boolean hasRole(String rolename,
                GroupSet groupset)

Checks if the user is assigned a specifie Role in any of the given Groups

Parameters:

rolename - the name of the Role

groupset - a Groupset

Returns:

true if the user is assigned the Role in any of the given Groups.

hasRole

boolean hasRole(Role role)

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

boolean hasRole(String role)

Checks if the user is assigned a specific Role.

Parameters:

role - the Role

Returns:

true if the user is assigned the Role.

hasPermission

boolean hasPermission(Permission permission,
                      Group group)

Checks if the user is assigned a specific Permission in the Group.

Parameters:

permission - the Permission

group - the Group

Returns:

true if the user is assigned the Permission in the Group.

hasPermission

boolean hasPermission(Permission permission,
                      GroupSet groupset)

Checks if the user is assigned a specific Permission in any of the given Groups

Parameters:

permission - the Permission

groupset - a Groupset

Returns:

true if the user is assigned the Permission in any of the given Groups.

hasPermission

boolean hasPermission(String permission,
                      String group)

Checks if the user is assigned a specific Permission in the Group.

Parameters:

permission - the Permission

group - the Group

Returns:

true if the user is assigned the Permission in the Group.

hasPermission

boolean hasPermission(String permission,
                      Group group)

Checks if the user is assigned a specific Permission in the Group.

Parameters:

permission - the Permission

group - the Group

Returns:

true if the user is assigned the Permission in the Group.

hasPermission

boolean hasPermission(String permissionName,
                      GroupSet groupset)

Checks if the user is assigned a specifie Permission in any of the given Groups

Parameters:

permissionName - the name of the Permission

groupset - a Groupset

Returns:

true if the user is assigned the Permission in any of the given Groups.

hasPermission

boolean hasPermission(Permission permission)

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

boolean hasPermission(String permission)

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.