public interface ApplicationAuthorizationService
ApplicationKey
).ApplicationRoleAdminService
,
JiraLicenseManager
Modifier and Type | Method and Description |
---|---|
boolean |
canUseApplication(ApplicationUser user,
com.atlassian.application.api.ApplicationKey key)
Determines whether the given user is allowed to access the passed application.
|
Set<com.atlassian.application.api.ApplicationAccess.AccessError> |
getAccessErrors(ApplicationUser user,
com.atlassian.application.api.ApplicationKey key)
Gets the errors that would occur if the passed user accessed the passed application.
|
Set<com.atlassian.application.api.ApplicationAccess.AccessError> |
getLicensingAccessErrors(com.atlassian.application.api.ApplicationKey key)
Get any errors that would occur when accessing the passed application.
|
int |
getUserCount(com.atlassian.application.api.ApplicationKey key)
Retrieve the number of active users for an application as identified by the
ApplicationKey . |
boolean |
hasNoLicensingAccessErrors(com.atlassian.application.api.ApplicationKey key)
Determines whether it is possible to access the passed application.
|
boolean |
isAnyRoleLimitExceeded()
Returns
true if any of the licenses in this JIRA instance have exceeded their respective license user
limit. |
boolean |
isApplicationInstalledAndLicensed(com.atlassian.application.api.ApplicationKey key)
Determines whether an application is installed (running in this JIRA instance) and has a backing
(potentially exceeded) license.
|
boolean |
isExceeded(com.atlassian.application.api.ApplicationKey key)
Determines whether an application's license user limit have been exceeded.
|
boolean |
rolesEnabled()
Deprecated.
since 7.0.1 as this always returns true in JIRA 7
|
boolean canUseApplication(@Nullable ApplicationUser user, @Nonnull com.atlassian.application.api.ApplicationKey key)
return getAccessError(user, key).isEmpty()
.
You can get more fine grained control using
getAccessErrors(com.atlassian.jira.user.ApplicationUser, com.atlassian.application.api.ApplicationKey)
user
- the user to check for access rights - if this is null, this method returns falsekey
- the key that uniquely identifies the application.Set<com.atlassian.application.api.ApplicationAccess.AccessError> getAccessErrors(@Nullable ApplicationUser user, @Nonnull com.atlassian.application.api.ApplicationKey key)
user
- the user to check for access rights - if null this will give a AccessError.NO_ACCESS
.key
- the key that uniquely identifies the application.ApplicationAccess.AccessError
. An empty set is returned
if no errors would occur.boolean hasNoLicensingAccessErrors(@Nonnull com.atlassian.application.api.ApplicationKey key)
canUseApplication(com.atlassian.jira.user.ApplicationUser, com.atlassian.application.api.ApplicationKey)
to work out access permission for a particular user.
Note, this simply calls getLicensingAccessErrors(key).isEmpty()
.
You can get more fine grained control using
getLicensingAccessErrors(com.atlassian.application.api.ApplicationKey)
key
- the key that uniquely identifies the application.true
if the application has a license that is not exceeded, expired, or with a version mismatch.
A return of false
indicates that users will not be able to access the application. A return of
true
indicates it might be possible for a user to access the application.Set<com.atlassian.application.api.ApplicationAccess.AccessError> getLicensingAccessErrors(@Nonnull com.atlassian.application.api.ApplicationKey key)
getAccessErrors(com.atlassian.jira.user.ApplicationUser, com.atlassian.application.api.ApplicationKey)
.
Furthermore, this is not a specific licensing check, as long as there is a license that can grant access present
then there will be no access errors. That is, the access may not come from the license of the specific
application you are checking.key
- the key that uniquely identifies the application.ApplicationAccess.AccessError
. An empty set is returned
if no errors would occur.boolean isApplicationInstalledAndLicensed(@Nonnull com.atlassian.application.api.ApplicationKey key)
Note: This method still returns true
if the application's license has expired or has been exceeded.
key
- the key that uniquely identifies the application.true
if the application is installed (running in this JIRA instance) and has a backing
(potentially exceeded) license.canUseApplication(com.atlassian.jira.user.ApplicationUser, com.atlassian.application.api.ApplicationKey)
boolean isAnyRoleLimitExceeded()
true
if any of the licenses in this JIRA instance have exceeded their respective license user
limit.
Note: does NOT check that license is within expiry limits; see LicenseDetails.isExpired()
.
true
if any of the licenses in this JIRA instance have exceeded their respective license user
limit.boolean isExceeded(@Nonnull com.atlassian.application.api.ApplicationKey key)
Note: Does NOT check that license is within expiry limits;
see LicenseDetails.isExpired()
.
Returns false
when the application is not installed.
key
- the key that uniquely identifies the application.true
if the application's license user limit have been exceeded or false
otherwise.int getUserCount(@Nonnull com.atlassian.application.api.ApplicationKey key)
ApplicationKey
.
It will uniquely count all users who are found in the groups associated with the application.
key
- the key that uniquely identifies the application.ApplicationRole
when the application
does not exist (0) would be returned.@Internal @Deprecated boolean rolesEnabled()
ApplicationRole
s are enabled.true
when ApplicationRole
are enabled, false
otherwise.Copyright © 2002-2019 Atlassian. All Rights Reserved.