com.atlassian.crucible.spi.services

Interface GlobalPermissionService

@ExperimentalApi
public interface GlobalPermissionService

Service for granting and reading global permissions GlobalPermissionType

Method Summary

Modifier and Type	Method and Description
void	addGroupPermission(java.lang.String group, GlobalPermissionType permission) Adds permission to given group.
boolean	addUserPermission(java.lang.String userName, GlobalPermissionType permission) Adds permission to given userName.
Page<java.lang.String>	getGroupNames(GlobalPermissionSearchCriteria searchCriteria, PageRequest pageRequest) Returns a page of group names, optionally filtered by searchCriteria.
java.util.Map<java.lang.String,java.util.Set<GlobalPermissionType>>	getGroupPermissions(java.lang.Iterable<java.lang.String> groupNames) Returns a map from group name to set of global permissions associated with that group for all groupNames.
Page<java.lang.String>	getUserNames(GlobalPermissionSearchCriteria searchCriteria, PageRequest pageRequest) Returns a page of user names, optionally filtered by searchCriteria.
java.util.Map<java.lang.String,java.util.Set<GlobalPermissionType>>	getUserPermissions(java.lang.Iterable<java.lang.String> userNames) Returns a map from user name to set of global permissions associated with that user for all userNames.
boolean	hasUserPermissions(Principal user, GlobalPermissionType permission)
boolean	hasUserPermissions(java.lang.String userName, GlobalPermissionType permission)
void	removeAllPermissionsForGroup(java.lang.String group) Removes all permissions from group
boolean	removeAllPermissionsForUser(java.lang.String userName) Removes all permissions from userName
void	removeGroupPermission(java.lang.String group, GlobalPermissionType permission) Removes permission from group.
boolean	removeUserPermission(java.lang.String userName, GlobalPermissionType permission) Removes permission from userName.

Method Detail

hasUserPermissions

boolean hasUserPermissions(java.lang.String userName,
                           GlobalPermissionType permission)
                    throws java.lang.IllegalArgumentException

Returns:

true user with given userName exists and has given permissions

Throws:

java.lang.IllegalArgumentException - if no username specified

hasUserPermissions

boolean hasUserPermissions(Principal user,
                           GlobalPermissionType permission)
                    throws java.lang.IllegalArgumentException

Returns:

false if principal is null or anon, true if principal is superuser or has given permissions

Throws:

java.lang.IllegalArgumentException - if user.getUserName() returns null

addGroupPermission

void addGroupPermission(java.lang.String group,
                        GlobalPermissionType permission)
                 throws java.lang.IllegalArgumentException,
                        NotPermittedException

Adds permission to given group. No-op if such a permission already exists.

Throws:

java.lang.IllegalArgumentException - if group doesn't exist

NotPermittedException - if caller does not have admin permissions.

removeGroupPermission

void removeGroupPermission(java.lang.String group,
                           GlobalPermissionType permission)
                    throws java.lang.IllegalArgumentException,
                           NotPermittedException

Removes permission from group. No-op if such a permission does not exist.

Throws:

java.lang.IllegalArgumentException - if group doesn't exist

NotPermittedException - if caller does not have admin permissions.

removeAllPermissionsForGroup

void removeAllPermissionsForGroup(java.lang.String group)
                           throws java.lang.IllegalArgumentException,
                                  NotPermittedException

Removes all permissions from group

Throws:

java.lang.IllegalArgumentException - if group doesn't exist

NotPermittedException - if caller does not have admin permissions.

getGroupNames

Page<java.lang.String> getGroupNames(@Nullable
                                     GlobalPermissionSearchCriteria searchCriteria,
                                     PageRequest pageRequest)
                              throws NotPermittedException

Returns a page of group names, optionally filtered by searchCriteria.

Throws:

NotPermittedException - if caller does not have admin permissions.

getGroupPermissions

java.util.Map<java.lang.String,java.util.Set<GlobalPermissionType>> getGroupPermissions(java.lang.Iterable<java.lang.String> groupNames)
                                                                                 throws java.lang.IllegalArgumentException,
                                                                                        NotPermittedException

Returns a map from group name to set of global permissions associated with that group for all groupNames. If a group has no permissions, the map will still contain an entry, where value is an empty set.

Throws:

NotPermittedException - if caller does not have admin permissions.

java.lang.IllegalArgumentException - if groupNames is null or empty

See Also:

getGroupNames(com.atlassian.crucible.spi.services.GlobalPermissionSearchCriteria, com.atlassian.fecru.page.PageRequest)

addUserPermission

boolean addUserPermission(java.lang.String userName,
                          GlobalPermissionType permission)
                   throws java.lang.IllegalArgumentException,
                          NotPermittedException

Adds permission to given userName. No-op if such a permission already exists.

Throws:

java.lang.IllegalArgumentException - if userName doesn't exist

NotPermittedException - if caller does not have admin permissions.

removeUserPermission

boolean removeUserPermission(java.lang.String userName,
                             GlobalPermissionType permission)
                      throws java.lang.IllegalArgumentException,
                             NotPermittedException

Removes permission from userName. No-op if such a permission does not exist.

Throws:

java.lang.IllegalArgumentException - if userName doesn't exist

NotPermittedException - if caller does not have admin permissions.

removeAllPermissionsForUser

boolean removeAllPermissionsForUser(java.lang.String userName)
                             throws java.lang.IllegalArgumentException,
                                    NotPermittedException

Removes all permissions from userName

Throws:

java.lang.IllegalArgumentException - if userName doesn't exist

NotPermittedException - if caller does not have admin permissions.

getUserNames

Page<java.lang.String> getUserNames(@Nullable
                                    GlobalPermissionSearchCriteria searchCriteria,
                                    PageRequest pageRequest)
                             throws NotPermittedException

Returns a page of user names, optionally filtered by searchCriteria.

Throws:

NotPermittedException - if caller does not have admin permissions.

getUserPermissions

java.util.Map<java.lang.String,java.util.Set<GlobalPermissionType>> getUserPermissions(java.lang.Iterable<java.lang.String> userNames)
                                                                                throws java.lang.IllegalArgumentException,
                                                                                       NotPermittedException

Returns a map from user name to set of global permissions associated with that user for all userNames. If a user has no permissions, the map will still contain an entry, where value is an empty set.

Throws:

NotPermittedException - if caller does not have admin permissions.

java.lang.IllegalArgumentException - if userNames is null or empty

See Also:

getUserNames(com.atlassian.crucible.spi.services.GlobalPermissionSearchCriteria, com.atlassian.fecru.page.PageRequest)