@Internal public interface

UserApplicationHelper

com.atlassian.jira.bc.user.UserApplicationHelper
Known Indirect Subclasses

@Internal

This interface is an internal implementation detail and will change without notice.

Clients that depend on @Internal classes and interfaces can not expect to be compatible with any version other than the version they were compiled against (even minor version and milestone releases may break binary compatibility with respect to @Internal elements).

Summary

Nested Classes
class UserApplicationHelper.ApplicationSelection  
enum UserApplicationHelper.ValidationScope What should be the validation scope, all type of problems or just the seat count  
Public Methods
boolean canUserLogin(ApplicationUser applicationUser)
Check if given user can login to JIRA.
@Nonnull List<UserApplicationHelper.ApplicationSelection> getApplicationsForSelection(Set<ApplicationKey> selectedApplicationKeys, Optional<Long> directoryId)
Return the ApplicationSelection calculated from the current state of JIRA.
@Nonnull List<UserApplicationHelper.ApplicationSelection> getApplicationsForUser(ApplicationUser user)
Return the ApplicationSelection calculated from the current state of JIRA for given (@code ApplicationUser).
@Nonnull List<GroupView> getUserGroups(ApplicationUser applicationUser)
Return the list of com.atlassian.jira.bc.user.GroupView connected with the given user.
@Nonnull Collection<String> validateApplicationKeys(Optional<Long> directoryId, Set<ApplicationKey> applicationKeys)
Validates if creating a user with given application access in given directory won't exceed license limit
@Nonnull Collection<String> validateApplicationKeys(ApplicationUser user, Set<ApplicationKey> applicationKeys)
Validates if adding a user with given application access to given applications won't exceed license limit
@Nonnull Collection<String> validateApplicationKeys(Optional<Long> directoryId, Set<ApplicationKey> applicationKeys, EnumSet<UserApplicationHelper.ValidationScope> validationScope)
Validates if creating a user with given application access in given directory won't cause issues defined in UserApplicationHelper.ValidationScope
@Nonnull Collection<String> validateDefaultApplications(EnumSet<UserApplicationHelper.ValidationScope> validationScope, Optional<Long> directoryId)
Validates if creating a user with default application access in given directory won't exceed license limit

Public Methods

public boolean canUserLogin (ApplicationUser applicationUser)

Check if given user can login to JIRA. Return true if user has any role or has admin/sysadmin privileges

Parameters
applicationUser given user
Returns
  • true if user has any role or is an admin

@Nonnull public List<UserApplicationHelper.ApplicationSelection> getApplicationsForSelection (Set<ApplicationKey> selectedApplicationKeys, Optional<Long> directoryId)

Return the ApplicationSelection calculated from the current state of JIRA. The passed applications are marked as selected (if they exist). The returned list will be ordered based on the Application name except that JIRA Core will be returned last (if it exists).

Parameters
selectedApplicationKeys the set of application keys to mark as selected.
directoryId optional directoryId to use for application selection
Returns
  • an immutable list of ApplicationSelection ordered by their name except that JIRA Core is always last.

@Nonnull public List<UserApplicationHelper.ApplicationSelection> getApplicationsForUser (ApplicationUser user)

Return the ApplicationSelection calculated from the current state of JIRA for given (@code ApplicationUser).

Parameters
user subject application user to get applications for.
Returns
  • an immutable list of ApplicationSelection ordered by their name except that JIRA Core is always last.

@Nonnull public List<GroupView> getUserGroups (ApplicationUser applicationUser)

Return the list of com.atlassian.jira.bc.user.GroupView connected with the given user. It respects nested groups.

Parameters
applicationUser the user
Returns
  • an immutable list of com.atlassian.jira.bc.user.GroupView

@Nonnull public Collection<String> validateApplicationKeys (Optional<Long> directoryId, Set<ApplicationKey> applicationKeys)

Validates if creating a user with given application access in given directory won't exceed license limit

Parameters
directoryId the Directory ID, or empty() if default directory should be checked
applicationKeys validated application keys
Returns
  • a collection of errors

@Nonnull public Collection<String> validateApplicationKeys (ApplicationUser user, Set<ApplicationKey> applicationKeys)

Validates if adding a user with given application access to given applications won't exceed license limit

Parameters
user validated user
applicationKeys validated application keys
Returns
  • a collection of errors

@Nonnull public Collection<String> validateApplicationKeys (Optional<Long> directoryId, Set<ApplicationKey> applicationKeys, EnumSet<UserApplicationHelper.ValidationScope> validationScope)

Validates if creating a user with given application access in given directory won't cause issues defined in UserApplicationHelper.ValidationScope

Parameters
directoryId the Directory ID, or empty() if default directory should be checked
applicationKeys validated application keys
validationScope required validation scope
Returns
  • a collection of errors

@Nonnull public Collection<String> validateDefaultApplications (EnumSet<UserApplicationHelper.ValidationScope> validationScope, Optional<Long> directoryId)

Validates if creating a user with default application access in given directory won't exceed license limit

Parameters
directoryId the Directory ID, or empty() if default directory should be checked
Returns
  • a collection of errors