com.atlassian.jira.security
Interface GlobalPermissionManager

All Known Implementing Classes:

DefaultGlobalPermissionManager

public interface GlobalPermissionManager

Use this manager to add/remove or check global permissions.

The system global permissions are:

• GlobalPermissionType.SYSTEM_ADMIN
• GlobalPermissionType.ADMINISTER
• GlobalPermissionType.USE
• GlobalPermissionType.USER_PICKER
• GlobalPermissionType.CREATE_SHARED_OBJECTS
• GlobalPermissionType.MANAGE_GROUP_FILTER_SUBSCRIPTIONS
• GlobalPermissionType.BULK_CHANGE

Use getAllGlobalPermissions() in order to get the collection of all global permissions, which includes plugin global permissions. For all other project specific permissions use PermissionManager.

To check programmatically if a permission is global use isGlobalPermission(int).

Method Summary

boolean	addPermission(GlobalPermissionType globalPermissionType, String group) Grants a user group a global permission.
boolean	addPermission(int permissionType, String group) Deprecated. Use addPermission(com.atlassian.jira.permission.GlobalPermissionType, String) instead.
void	clearCache()
Collection<GlobalPermissionType>	getAllGlobalPermissions()
com.atlassian.fugue.Option<GlobalPermissionType>	getGlobalPermission(int permissionId) Deprecated. use getGlobalPermission(String) to get global permission by key. Eventually, we want to stop referring to Global Permission's by ID.
com.atlassian.fugue.Option<GlobalPermissionType>	getGlobalPermission(String permissionKey)
Collection<String>	getGroupNames(GlobalPermissionType globalPermissionType) Retrieve all the group names with this permission.
Collection<String>	getGroupNames(int permissionId) Deprecated. Use getGroupNames(com.atlassian.jira.permission.GlobalPermissionType)
Collection<com.atlassian.crowd.embedded.api.Group>	getGroupsWithPermission(GlobalPermissionType globalPermissionType) Retrieve all the groups with this permission.
Collection<com.atlassian.crowd.embedded.api.Group>	getGroupsWithPermission(int permissionId) Deprecated. Use getGroupsWithPermission(com.atlassian.jira.permission.GlobalPermissionType)
Collection<GlobalPermissionEntry>	getPermissions(GlobalPermissionType globalPermissionType) Retrieve a list of user groups which have been granted a specified permission.
Collection<JiraPermission>	getPermissions(int permissionType) Deprecated. Use getPermissions(com.atlassian.jira.permission.GlobalPermissionType) instead.
boolean	hasPermission(GlobalPermissionType globalPermissionType) Check if a global permission is granted for an anonymous user.
boolean	hasPermission(GlobalPermissionType globalPermissionType, ApplicationUser user) Check if a pluggable global permission for one of the users groups exists.
boolean	hasPermission(int permissionType) Deprecated. Use hasPermission(com.atlassian.jira.permission.GlobalPermissionType) instead.
boolean	hasPermission(int permissionType, ApplicationUser user) Deprecated. Use hasPermission(com.atlassian.jira.permission.GlobalPermissionType, com.atlassian.jira.user.ApplicationUser) instead.
boolean	hasPermission(int permissionType, com.atlassian.crowd.embedded.api.User user) Deprecated. Use hasPermission(com.atlassian.jira.permission.GlobalPermissionType, com.atlassian.jira.user.ApplicationUser) instead.
boolean	isGlobalPermission(int permissionId)
boolean	removePermission(GlobalPermissionType globalPermissionType, String group) Revokes a global permission for a user group
boolean	removePermission(int permissionType, String group) Deprecated. Use removePermission(com.atlassian.jira.permission.GlobalPermissionType, String) instead.
boolean	removePermissions(String group) Revoke all global permissions for a user group.

Method Detail

getAllGlobalPermissions

@ExperimentalApi
Collection<GlobalPermissionType> getAllGlobalPermissions()

Returns:

the collection with all global permissions. This includes all the systems global permissions and all the plugin global permissions.

getGlobalPermission

@ExperimentalApi
com.atlassian.fugue.Option<GlobalPermissionType> getGlobalPermission(int permissionId)

Deprecated. use getGlobalPermission(String) to get global permission by key. Eventually, we want to stop referring to Global Permission's by ID.

Parameters:

permissionId - id of the permission.

Returns:

a global permission (system and pluggable) for the given permission id.

getGlobalPermission

@ExperimentalApi
com.atlassian.fugue.Option<GlobalPermissionType> getGlobalPermission(@NotNull
                                                                                     String permissionKey)

Parameters:

permissionKey - the key of the permission declared by global permission module.

Returns:

a global permission for the given permission key.

addPermission

boolean addPermission(int permissionType,
                      String group)

Deprecated. Use addPermission(com.atlassian.jira.permission.GlobalPermissionType, String) instead.

Grants a user group a global permission.

Parameters:

permissionType - the global permission id.

group - the name of the group. Null means "anyone" group. The JIRA use, admin and sysadmin permission cannot be granted to anyone.

Returns:

true if the permission was added.

addPermission

@ExperimentalApi
boolean addPermission(GlobalPermissionType globalPermissionType,
                                      String group)

Grants a user group a global permission.

Parameters:

globalPermissionType - global permission, must not be null.

group - the name of the group. Null means "anyone" group. The JIRA use, admin and sysadmin permission cannot be granted to anyone.

Returns:

true if permission was added.

getPermissions

Collection<JiraPermission> getPermissions(int permissionType)

Deprecated. Use getPermissions(com.atlassian.jira.permission.GlobalPermissionType) instead.

Retrieve a list of user groups which have been granted a specified permission. The returned JiraPermission contains a reference to the user group. JiraPermission.getScheme() is always NULL, because Global permission are not configured using schemes. JiraPermission.getType() will always return "group", because global permissions can only be granted to groups.

Parameters:

permissionType - The key of pluggable global permission. Must be a global permission.

Returns:

Collection of JiraPermission.getPermType(), must never return null.

getPermissions

@ExperimentalApi
Collection<GlobalPermissionEntry> getPermissions(GlobalPermissionType globalPermissionType)

Retrieve a list of user groups which have been granted a specified permission. The returned JiraPermission contains a reference to the user group. JiraPermission.getScheme() is always NULL, because Global permission are not configured using schemes. JiraPermission.getType() will always return "group", because global permissions can only be granted to groups.

Parameters:

globalPermissionType - global permission, must not be null.

Returns:

Collection of JiraPermission.getPermType(), must never return null.

removePermission

boolean removePermission(int permissionType,
                         String group)

Deprecated. Use removePermission(com.atlassian.jira.permission.GlobalPermissionType, String) instead.

Revokes a global permission for a user group

Parameters:

permissionType - the global permission.

group - the group name. NULL means the anyone group.

Returns:

true if the permission was revoked, false if not (e.g. the group does not have this permission)

removePermission

@ExperimentalApi
boolean removePermission(GlobalPermissionType globalPermissionType,
                                         String group)

Revokes a global permission for a user group

Parameters:

globalPermissionType - global permission, must not be null.

group - the group name. NULL means the anyone group.

Returns:

true if the permission was revoked, false if not (e.g. the group does not have this permission)

removePermissions

boolean removePermissions(String group)

Revoke all global permissions for a user group.

Parameters:

group - cannot NOT be null and the group must exist.

Returns:

true, if this group does not have any global permissions

hasPermission

boolean hasPermission(int permissionType)

Deprecated. Use hasPermission(com.atlassian.jira.permission.GlobalPermissionType) instead.

Check if a global permission is granted for an anonymous user.

If the permission is Permissions.ADMINISTER and the lookup is false then the same query will be executed for the Permissions.SYSTEM_ADMIN permission type, since it is implied that having a Permissions.SYSTEM_ADMIN permission grants Permissions.ADMINISTER rights.

Note: Use hasPermission(int, User) method is you have the user object, i.e. user is not anonymous.

If you are using this method directly, consider using PermissionManager.hasPermission(int, User) instead as it handles logged in and anonymous users as well.

Parameters:

permissionType - must be global permission

Returns:

true the anonymous user has the permission of given type, false otherwise

See Also:

hasPermission(int, User)

hasPermission

@ExperimentalApi
boolean hasPermission(@NotNull
                                      GlobalPermissionType globalPermissionType)

Check if a global permission is granted for an anonymous user.

If the permission is Permissions.ADMINISTER and the lookup is false then the same query will be executed for the Permissions.SYSTEM_ADMIN permission type, since it is implied that having a Permissions.SYSTEM_ADMIN permission grants Permissions.ADMINISTER rights.

Note: Use hasPermission(com.atlassian.jira.permission.GlobalPermissionType, com.atlassian.jira.user.ApplicationUser) method is you have the user object, i.e. user is not anonymous.

Use getGlobalPermission(String) or getGlobalPermission(int) in order to get the global permission using the permission key or id.

Parameters:

globalPermissionType - global permission, must not be null.

Returns:

true the anonymous user has the permission of given type, false otherwise

See Also:

hasPermission(com.atlassian.jira.permission.GlobalPermissionType, ApplicationUser)

hasPermission

boolean hasPermission(int permissionType,
                      com.atlassian.crowd.embedded.api.User user)

Deprecated. Use hasPermission(com.atlassian.jira.permission.GlobalPermissionType, com.atlassian.jira.user.ApplicationUser) instead.

Check if a global permission for one of the users groups exists.

If the permission type is Permissions.ADMINISTER and the lookup is false then the same query will be executed for the Permissions.SYSTEM_ADMIN permission type, since it is implied that having a Permissions.SYSTEM_ADMIN permission grants Permissions.ADMINISTER rights.

Note: Use hasPermission(int) method is you do not have the user object, i.e. user is anonymous.

If you are using this method directly, consider using PermissionManager.hasPermission(int, User) instead as it handles logged in and anonymous users as well.

Parameters:

permissionType - must be a global permission

user - must not be null

Returns:

true if the given user has the permission of given type, otherwise false

See Also:

hasPermission(int), PermissionManager.hasPermission(int, User)

hasPermission

boolean hasPermission(int permissionType,
                      ApplicationUser user)

Deprecated. Use hasPermission(com.atlassian.jira.permission.GlobalPermissionType, com.atlassian.jira.user.ApplicationUser) instead.

Check if a global permission for one of the users groups exists.

If the permission type is Permissions.ADMINISTER and the lookup is false then the same query will be executed for the Permissions.SYSTEM_ADMIN permission type, since it is implied that having a Permissions.SYSTEM_ADMIN permission grants Permissions.ADMINISTER rights.

Note: Use hasPermission(int) method is you do not have the user object, i.e. user is anonymous.

If you are using this method directly, consider using PermissionManager.hasPermission(int, User) instead as it handles logged in and anonymous users as well.

Parameters:

permissionType - must be a global permission

user - must not be null

Returns:

true if the given user has the permission of given type, otherwise false

See Also:

hasPermission(int), PermissionManager.hasPermission(int, User)

hasPermission

@ExperimentalApi
boolean hasPermission(@NotNull
                                      GlobalPermissionType globalPermissionType,
                                      @NotNull
                                      ApplicationUser user)

Check if a pluggable global permission for one of the users groups exists.

If the permission type is Permissions.ADMINISTER and the lookup is false then the same query will be executed for the Permissions.SYSTEM_ADMIN permission type, since it is implied that having a Permissions.SYSTEM_ADMIN permission grants Permissions.ADMINISTER rights.

Note: Use hasPermission(com.atlassian.jira.permission.GlobalPermissionType) method is you do not have the user object, i.e. user is anonymous.

Parameters:

globalPermissionType - global permission, must not be null.

user - must not be null.

Returns:

true if the given user has the permission of given type, otherwise false.

See Also:

hasPermission(com.atlassian.jira.permission.GlobalPermissionType)

getGroupsWithPermission

Collection<com.atlassian.crowd.embedded.api.Group> getGroupsWithPermission(int permissionId)

Deprecated. Use getGroupsWithPermission(com.atlassian.jira.permission.GlobalPermissionType)

Retrieve all the groups with this permission. Only groups directly associated with the permission will be returned.

Parameters:

permissionId - must be a global permission

Returns:

a Collection of Group's, will never be null.

getGroupsWithPermission

@ExperimentalApi
Collection<com.atlassian.crowd.embedded.api.Group> getGroupsWithPermission(@NotNull
                                                                                           GlobalPermissionType globalPermissionType)

Retrieve all the groups with this permission. Only groups directly associated with the permission will be returned.

Parameters:

globalPermissionType - global permission, must not be null.

Returns:

a Collection of Group's, will never be null.

getGroupNames

Collection<String> getGroupNames(int permissionId)

Deprecated. Use getGroupNames(com.atlassian.jira.permission.GlobalPermissionType)

Retrieve all the group names with this permission. Only group names directly associated with the permission will be returned.

Parameters:

permissionId - must be a global permission

Returns:

a Collection of String, group names, will never be null.

getGroupNames

@ExperimentalApi
Collection<String> getGroupNames(@NotNull
                                                 GlobalPermissionType globalPermissionType)

Retrieve all the group names with this permission. Only group names directly associated with the permission will be returned.

Parameters:

globalPermissionType - global permission, must not be null.

Returns:

a Collection of String, group names, will never be null.

isGlobalPermission

@ExperimentalApi
boolean isGlobalPermission(int permissionId)

Parameters:

permissionId - id of the permission to check.

Returns:

true if provided id is the id of a global permission.

clearCache

@Internal
void clearCache()