com.atlassian.jira.bc.license

Interface LicenseRoleAuthorizationService

All Known Implementing Classes:

LicenseRoleAuthorizationServiceImpl

public interface LicenseRoleAuthorizationService

A utility service to determine if a user has access to a specific LicenseRole (as identified by its LicenseRoleId), or if a license role is available.

Since:

6.4

See Also:

com.atlassian.jira.license.JiraLicenseManager}, com.atlassian.jira.bc.license.LicenseRoleAdminService}, LicenseRoleId, LicenseRole

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canUseRole(ApplicationUser user, LicenseRoleId role) Returns true if the given user has been assigned to the given role and the role is backed by a license that grants that role.
int	getUserCount(LicenseRoleId roleId) Retrieve the number of active users for a specific license role (product).
boolean	isAuthenticated(ApplicationUser user, LicenseRoleId licenseRoleId) Deprecated. use canUseRole(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.license.LicenseRoleId).
boolean	isAuthenticated(LicenseRoleId role) Deprecated. use isLicenseRoleInstalled(com.atlassian.jira.license.LicenseRoleId).
boolean	isLicenseRoleInstalled(LicenseRoleId role) Deprecated.

Method Detail

canUseRole

boolean canUseRole(@Nullable
                 ApplicationUser user,
                 @Nonnull
                 LicenseRoleId role)

Returns true if the given user has been assigned to the given role and the role is backed by a license that grants that role. Note that this method still returns true for expired or exceeded as well as current licenses.

Parameters:

user - the user to check for access rights - if this is null, this method returns false

role - the license role to check

Returns:

true if the user has the specified role and the role is correctly licensed

Since:

6.4

See Also:

LicenseRoleService#userHasRole(ApplicationUser, LicenseRoleId)} for a method which does not check the license

isLicenseRoleInstalled

@Deprecated
boolean isLicenseRoleInstalled(@Nonnull
                                        LicenseRoleId role)

Deprecated.

Returns true if the given license role has been defined by a product, plugin or the platform, and there is a license present for the role. Note that this method still returns true for expired or exceeded as well as current licenses.

Parameters:

role - a license role identifier

Returns:

true if the given license role is defined and has a (not necessarily current) license.

Since:

6.4

See Also:

com.atlassian.jira.license.JiraLicenseManager#isLicensed(LicenseRoleId)} which provides this functionality from 6.3

isAuthenticated

@Deprecated
boolean isAuthenticated(@Nullable
                                 ApplicationUser user,
                                 @Nonnull
                                 LicenseRoleId licenseRoleId)

Deprecated. use canUseRole(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.license.LicenseRoleId).

isAuthenticated

@Deprecated
boolean isAuthenticated(@Nonnull
                                 LicenseRoleId role)

Deprecated. use isLicenseRoleInstalled(com.atlassian.jira.license.LicenseRoleId).

getUserCount

int getUserCount(@Nonnull
               LicenseRoleId roleId)

Retrieve the number of active users for a specific license role (product). It will uniquely count all users who are found in the groups associated with the product.

Parameters:

roleId - is the license role ID used to identify the product.

Returns:

the number of active users for the product identified by roleId

Since:

6.4