Interface PermissionManager

All Known Implementing Classes:
ApplicationRequiredPermissionManager, DefaultPermissionManager, MockPermissionManager, PublicAccessPermissionManager, SubvertedPermissionManager, ThreadLocalCachingPermissionManager, WorkflowBasedPermissionManager

@PublicApi public interface PermissionManager
PermissionManager responsible for all project specific permissions.

See JIRA Permissions.

For all global Permissions it is recommended to use GlobalPermissionManager.

  • Method Details

    • getAllProjectPermissions

      Collection<ProjectPermission> getAllProjectPermissions()
      Returns:
      all project permissions.
      Since:
      v6.3
    • getProjectPermissions

      Collection<ProjectPermission> getProjectPermissions(@Nonnull ProjectPermissionCategory category)
      Parameters:
      category - project permission category.
      Returns:
      all project permissions of the specified category.
      Since:
      v6.3
    • getProjectPermission

      io.atlassian.fugue.Option<ProjectPermission> getProjectPermission(@Nonnull ProjectPermissionKey permissionKey)
      Returns a project permission matching the specified key.
      Parameters:
      permissionKey - A project permission key.
      Returns:
      a project permission for the given permission key. Option.none() if there is no permission with this key.
      Since:
      v6.3
    • hasPermission

      @Deprecated boolean hasPermission(int permissionsId, ApplicationUser user)
      Checks to see if this user has the specified permission. It will check only global permissions as there are no other permissions to check.
      Parameters:
      permissionsId - permission id
      user - user, can be null - anonymous user
      Returns:
      true if user is granted given permission, false otherwise
      See Also:
    • hasPermission

      @Deprecated boolean hasPermission(int permissionsId, Issue issue, ApplicationUser user)
      Checks to see if this user has permission to see the specified issue.

      Note that if the issue's generic value is null, it is assumed that the issue is currently being created, and so the permission check call is deferred to the issue's project object, with the issueCreation flag set to true. See JRA-14788 for more info.

      Parameters:
      permissionsId - Not a global permission
      issue - The Issue (cannot be null)
      user - User object, possibly null if JIRA is accessed anonymously
      Returns:
      True if there are sufficient rights to access the entity supplied
    • hasPermission

      boolean hasPermission(@Nonnull ProjectPermissionKey permissionKey, @Nonnull Issue issue, @Nullable ApplicationUser user)
      Checks to see if this user has permission to see the specified issue.

      Note that if the issue's generic value is null, it is assumed that the issue is currently being created, and so the permission check call is deferred to the issue's project object, with the issueCreation flag set to true. See JRA-14788 for more info.

      Parameters:
      permissionKey - Not a global permission key
      issue - The Issue (cannot be null)
      user - User object, possibly null if JIRA is accessed anonymously
      Returns:
      True if there are sufficient rights to access the entity supplied
      Since:
      v6.3
    • hasPermission

      @Internal boolean hasPermission(@Nonnull ProjectPermissionKey permissionKey, @Nonnull Issue issue, @Nullable ApplicationUser user, @Nullable com.opensymphony.workflow.loader.ActionDescriptor actionDescriptor)
      Checks to see if this user has the given permission to the specified issue after the given workflow transition takes effect.
      Parameters:
      permissionKey - The project permission key.
      issue - The Issue (cannot be null)
      user - User object, possibly null if JIRA is accessed anonymously
      actionDescriptor - Represents the current workflow transition
      Returns:
      True if there are sufficient rights to access the entity supplied
      Since:
      v7.0.1
    • hasPermission

      boolean hasPermission(@Nonnull ProjectPermissionKey permissionKey, @Nonnull Issue issue, @Nullable ApplicationUser user, @Nonnull Status status)
      Checks to see if this user has the given permission to the specified issue if the issue was in the given status.

      This method is useful during a workflow transition to check what the permissions will be in the new status, or (after the status is updated in the Issue object) to check what the permission would have been in the old status.

      Parameters:
      permissionKey - The project permission key.
      issue - The Issue (cannot be null)
      user - User object, possibly null if JIRA is accessed anonymously
      status - Represents the state we are checking permissions against
      Returns:
      True if there are sufficient rights to access the entity supplied
      Since:
      v7.0.3
    • hasPermission

      @Deprecated boolean hasPermission(int permissionsId, Project project, ApplicationUser user)
      Checks whether the specified user has a specified permission within the context of a specified project.
      Parameters:
      permissionsId - A non-global permission, i.e. a permission that is granted via a project context
      project - The project that is the context of the permission check.
      user - The person to perform the permission check for
      Returns:
      true if the user has the specified permission in the context of the supplied project
    • hasPermission

      boolean hasPermission(@Nonnull ProjectPermissionKey permissionKey, @Nonnull Project project, @Nullable ApplicationUser user)
      Checks whether the specified user has a specified permission within the context of a specified project.
      Parameters:
      permissionKey - A non-global permission, i.e. a permission that is granted via a project context
      project - The project that is the context of the permission check.
      user - The person to perform the permission check for
      Returns:
      true if the user has the specified permission in the context of the supplied project
      Since:
      v6.3
      See Also:
    • hasProjectWidePermission

      @ExperimentalApi @Nonnull ProjectWidePermission hasProjectWidePermission(@Nonnull ProjectPermissionKey permissionKey, @Nonnull Project project, @Nullable ApplicationUser user)
      Checks whether a user has a particular permission in the given project.

      This method returns a tri-state enum in order to convey information about permissions that are granted on a per-issue basis.

      • ALL_ISSUES : this user has the given permission for all issues in this project
      • NO_ISSUES : this user definitely does not have the given permission for any issues in this project
      • ISSUE_SPECIFIC : the user may have this permission on some issues, but not others
      Note that even if this method returns ISSUE_SPECIFIC, it may be that there are no issues for which the user has the permission granted.

      Parameters:
      permissionKey - A project permission
      project - The project that is the context of the permission check.
      user - The person to perform the permission check for (null means anonymous)
      Returns:
      ALL_ISSUES, NO_ISSUES, or ISSUE_SPECIFIC
      Since:
      v6.4.8
      See Also:
    • hasPermission

      @Deprecated boolean hasPermission(int permissionsId, Project project, ApplicationUser user, boolean issueCreation)
      Checks whether the specified user has a specified permission within the context of a specified project.
      Parameters:
      permissionsId - A non-global permission, i.e. a permission that is granted via a project context
      project - The project that is the context of the permission check.
      user - The person to perform the permission check for
      issueCreation - Whether this permission is being checked during issue creation
      Returns:
      true if the user has the specified permission in the context of the supplied project
    • hasPermission

      boolean hasPermission(@Nonnull ProjectPermissionKey permissionKey, @Nonnull Project project, @Nullable ApplicationUser user, boolean issueCreation)
      Checks whether the specified user has a specified permission within the context of a specified project.
      Parameters:
      permissionKey - A non-global permission, i.e. a permission that is granted via a project context
      project - The project that is the context of the permission check.
      user - The person to perform the permission check for
      issueCreation - Whether this permission is being checked during issue creation
      Returns:
      true if the user has the specified permission in the context of the supplied project
      Since:
      v6.3
    • removeGroupPermissions

      void removeGroupPermissions(String group) throws RemoveException
      Remove all permissions that have used this group
      Parameters:
      group - The name of the group that needs to be removed, must NOT be null and must be a real group
      Throws:
      RemoveException - if permission removal fails
    • removeUserPermissions

      void removeUserPermissions(ApplicationUser user) throws RemoveException
      Remove all permissions that have been assigned to this user
      Parameters:
      user - the user whose permissions are to be removed
      Throws:
      RemoveException
      Since:
      v6.0
    • hasProjects

      @Deprecated boolean hasProjects(int permissionId, ApplicationUser user)
      Deprecated.
      Can this user see at least one project with this permission
      Parameters:
      permissionId - must NOT be a global permission
      user - user being checked
      Returns:
      true the given user can see at least one project with the given permission, false otherwise
    • hasProjects

      boolean hasProjects(@Nonnull ProjectPermissionKey permissionKey, @Nullable ApplicationUser user)
      Can this user see at least one project with this permission
      Parameters:
      permissionKey - must NOT be a global permission
      user - user being checked
      Returns:
      true the given user can see at least one project with the given permission, false otherwise
      Since:
      v6.3
    • getProjects

      Collection<Project> getProjects(@Nonnull ProjectPermissionKey permissionKey, @Nullable ApplicationUser user)
      Retrieve a list of project objects this user has the permission for
      Parameters:
      permissionKey - must NOT be a global permission
      user - user
      Returns:
      a collection of Project objects
      Since:
      v6.3
    • getProjects

      Collection<Project> getProjects(@Nonnull ProjectPermissionKey permissionKey, @Nullable ApplicationUser user, @Nullable ProjectCategory projectCategory)
      Returns the list of projects associated with the specified category, that this user has the permissions for.
      Parameters:
      permissionKey - permission key
      user - user
      projectCategory - the ProjectCategory - null means find projects with no category.
      Returns:
      the list of projects associated with the specified category, that this user has the permissions for.
      Since:
      v6.3
    • getArchivedProjects

      @ExperimentalApi Collection<Project> getArchivedProjects(@Nonnull ProjectPermissionKey permissionKey, @Nullable ApplicationUser user)
      Retrieve a list of archived project objects this user has the permission for
      Parameters:
      permissionKey - must NOT be a global permission
      user - user
      Returns:
      a collection of Project objects
      Since:
      v7.9
    • flushCache

      @ExperimentalApi void flushCache()
      Flushes any cached project permissions for all users.
      Since:
      v7.1
    • getAllGroups

      Collection<com.atlassian.crowd.embedded.api.Group> getAllGroups(int permissionId, Project project)
      Retrieve all groups that are used in the permission globally and in the project.
      Parameters:
      permissionId - permission id
      project - project from which to retrieve groups
      Returns:
      a collection of Groups
    • hasPublicAccess

      default boolean hasPublicAccess(@Nullable ApplicationUser applicationUser)
      Verifies if anonymous user has public access to JIRA
      Parameters:
      applicationUser - user being checked
      Returns:
      true if anonymous user has public access to JIRA, false otherwise
      Since:
      v7.2.10