Package com.atlassian.crowd.dao.permission

Class NoopInternalUserPermissionDAO

java.lang.Object

com.atlassian.crowd.dao.permission.NoopInternalUserPermissionDAO

All Implemented Interfaces:

InternalUserPermissionDAO

public class NoopInternalUserPermissionDAO
extends Object
implements InternalUserPermissionDAO

A no-op implementation of InternalUserPermissionDAO, to be used by products embedding Crowd - these don't use Crowd's permission infrastructure. Most operation behave as if no permissions were granted. Trying to grant permissions throws.

Since:

2.11

Constructor Summary

Constructors

Constructor	Description
NoopInternalUserPermissionDAO()

Method Summary

Modifier and Type	Method	Description
boolean	exists(InternalGrantedPermission permission)	Return true if the InternalGrantedPermission has been explicitly granted.
List<InternalGrantedPermission>	findAllPermissionsForGroup(String groupName, long directoryId)	Find all permission entries for this group.
List<PermittedGroup>	findHighestPermissionPerGroup(int start, int limit)	Find all groups with an explicit permission, and return their highest permission
List<PermittedGroup>	findHighestPermissionPerGroupByPrefix(String prefix, int start, int limit)	Find all groups with an explicit permission, and return their highest permission
Collection<PermittedGroup>	getGrantedPermissions(UserPermission permission)	Find all groups that have been explicitly (not implicitly) granted the provided permission
Collection<PermittedGroup>	getGrantedPermissions(UserPermission permission, Application application)	Find all groups that have been explicitly (not implicitly) granted the provided permission
void	grant(InternalGrantedPermission permission)	Grant the explicit permission to the group.
boolean	revoke(InternalGrantedPermission permission)	Remove the explicit permission from the group.
int	revokeAll(DirectoryMapping directoryMapping)	Revokes all permissions associated with the specified directory mapping

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

NoopInternalUserPermissionDAO

public NoopInternalUserPermissionDAO()

Method Details

exists

public boolean exists(InternalGrantedPermission permission)

Description copied from interface: InternalUserPermissionDAO

Return true if the InternalGrantedPermission has been explicitly granted. Ie. there is a row matching the group and permission specified by the permission param

Specified by:

exists in interface InternalUserPermissionDAO

Parameters:

permission - the group/permission pair to search for

Returns:

true if the permission has been explicitly granted (not implicitly)

revoke

public boolean revoke(InternalGrantedPermission permission)

Description copied from interface: InternalUserPermissionDAO

Remove the explicit permission from the group.

Specified by:

revoke in interface InternalUserPermissionDAO

Parameters:

permission - the group/permission pair to remove

Returns:

true if the permission existed and was removed

revokeAll

public int revokeAll(DirectoryMapping directoryMapping)

Description copied from interface: InternalUserPermissionDAO

Revokes all permissions associated with the specified directory mapping

Specified by:

revokeAll in interface InternalUserPermissionDAO

Parameters:

directoryMapping - the directory mapping to revoke permissions for

Returns:

the number of permissions removed

grant

public void grant(InternalGrantedPermission permission)

Description copied from interface: InternalUserPermissionDAO

Grant the explicit permission to the group. If the permission already explicitly exists, do nothing.

Specified by:

grant in interface InternalUserPermissionDAO

Parameters:

permission - the group/permission pair to create

getGrantedPermissions

public Collection<PermittedGroup> getGrantedPermissions(UserPermission permission)

Description copied from interface: InternalUserPermissionDAO

Find all groups that have been explicitly (not implicitly) granted the provided permission

Specified by:

getGrantedPermissions in interface InternalUserPermissionDAO

Parameters:

permission - permission to search for

Returns:

all groups with this permission

getGrantedPermissions

public Collection<PermittedGroup> getGrantedPermissions(UserPermission permission,
 Application application)

Description copied from interface: InternalUserPermissionDAO

Find all groups that have been explicitly (not implicitly) granted the provided permission

Specified by:

getGrantedPermissions in interface InternalUserPermissionDAO

Parameters:

permission - permission to search for

application - application the permission should apply to

Returns:

all groups with this permission

findHighestPermissionPerGroupByPrefix

public List<PermittedGroup> findHighestPermissionPerGroupByPrefix(String prefix,
 int start,
 int limit)

Description copied from interface: InternalUserPermissionDAO

Find all groups with an explicit permission, and return their highest permission

Specified by:

findHighestPermissionPerGroupByPrefix in interface InternalUserPermissionDAO

Parameters:

prefix - prefix return only groups whose names start with this prefix

start - index to start page at

limit - max number of results to return, 0 for all results

Returns:

the highest permission for each group with an explicit permission ordered by groupName. If a group has ADMIN and SYS_ADMIN, only return SYS_ADMIN

findHighestPermissionPerGroup

public List<PermittedGroup> findHighestPermissionPerGroup(int start,
 int limit)

Description copied from interface: InternalUserPermissionDAO

Find all groups with an explicit permission, and return their highest permission

Specified by:

findHighestPermissionPerGroup in interface InternalUserPermissionDAO

Parameters:

start - index to start page at

limit - max number of results to return, 0 for all results

Returns:

the highest permission for each group with an explicit permission ordered by groupName. If a group has ADMIN and SYS_ADMIN, only return SYS_ADMIN

findAllPermissionsForGroup

public List<InternalGrantedPermission> findAllPermissionsForGroup(String groupName,
 long directoryId)

Description copied from interface: InternalUserPermissionDAO

Find all permission entries for this group. Used for eg. cleaning up when deleting the group.

Specified by:

findAllPermissionsForGroup in interface InternalUserPermissionDAO

Parameters:

groupName - name of group to search

Returns:

database entries ordered by groupName