public interface

ApplicationRoleAdminService

com.atlassian.jira.application.ApplicationRoleAdminService
Known Indirect Subclasses

Class Overview

Provides access to ApplicationRole management functionality.

Summary

Constants
String ERROR_DEFAULT_GROUPS The key for any defaultGroup related errors reported.
String ERROR_GROUPS The key for any group related errors reported.
Public Methods
@Nonnull ServiceOutcome<ApplicationRole> getRole(ApplicationKey key)
Return the ApplicationRole backed by a (potentially exceeded) license.
@Nonnull ServiceOutcome<Set<ApplicationRole>> getRoles()
Returns an immutable Set of all ApplicationRoles that are backed by a (potentially exceeded) license.
@Nonnull ServiceOutcome<ApplicationRole> setRole(ApplicationRole role)
Save the passed ApplicationRole information to the database.
ServiceOutcome<Set<ApplicationRole>> setRoles(Collection<ApplicationRole> roles)
Save the passed list of ApplicationRole information to the database.

Constants

public static final String ERROR_DEFAULT_GROUPS

The key for any defaultGroup related errors reported.

Constant Value: "defaultGroups"

public static final String ERROR_GROUPS

The key for any group related errors reported.

Constant Value: "groups"

Public Methods

@Nonnull public ServiceOutcome<ApplicationRole> getRole (ApplicationKey key)

Return the ApplicationRole backed by a (potentially exceeded) license.

Parameters
key the key that identifies the ApplicationRole.
Returns
  • the ApplicationRole that is backed by a (potentially exceeded) license or an error if not possible.

@Nonnull public ServiceOutcome<Set<ApplicationRole>> getRoles ()

Returns an immutable Set of all ApplicationRoles that are backed by a (potentially exceeded) license.

Returns
  • the Set of all ApplicationRoles that are backed by a (potentially exceeded) license or an error.

@Nonnull public ServiceOutcome<ApplicationRole> setRole (ApplicationRole role)

Save the passed ApplicationRole information to the database. This method will only accept the passed role if:

  1. The role is backed by a (potentially exceeded) license.
  2. The role only contains currently valid groups.
  3. The default groups are contained within the role.

Parameters
role the role to save.
Returns
  • the role as persisted to the database or an error.

public ServiceOutcome<Set<ApplicationRole>> setRoles (Collection<ApplicationRole> roles)

Save the passed list of ApplicationRole information to the database. This method will only accept the passed role if:

  1. Each role is backed by a (potentially exceeded) license.
  2. Each roles only contains currently valid groups.
  3. The default groups are contained within each role

Parameters
roles the roles to save
Returns
  • the roles as persisted to the database or an error