com.atlassian.jira.license

Interface LicensedApplications

All Known Implementing Classes:

DefaultLicensedApplications, MockLicensedApplications

public interface LicensedApplications

Encapsulates the application/role information embedded in a license.

Typical usage:

 
     JiraLicenseManager jlm = ...;
     LicenseDetails licenseDetails = jlm.getLicense();
     LicensedApplications applications = licenseDetails.getLicensedApplications();

     Set<ApplicationKey> keys = applications.getKeys();
     for (ApplicationKey key : keys)
     {
         int numSeats = roleDetails.getUserLimit( key );
         ...
     }
 
 

Since:

7.0

See Also:

LicensePropertiesConstants.UNLIMITED_USERS, ApplicationRoleManager, LicenseDetails.getLicensedApplications()

Method Summary

Modifier and Type	Method and Description
String	getDescription() Returns a user-friendly string version of the Applications encoded in the source license, or the empty string if there are no Applications in the source license.
Set<com.atlassian.application.api.ApplicationKey>	getKeys() Returns the ApplicationKeys encoded in the source license.
int	getUserLimit(com.atlassian.application.api.ApplicationKey key) Returns the number of seats for the given ApplicationKey.
boolean	hasNativeRole() Indicates whether the license key has been issued as an JIRA Application license ( role based license ) or whether we have interpreted it as an JIRA Application license.

Method Detail

getKeys

@Nonnull
Set<com.atlassian.application.api.ApplicationKey> getKeys()

Returns the ApplicationKeys encoded in the source license. This may return an empty set, but never returns null.

getUserLimit

int getUserLimit(@Nonnull
                 com.atlassian.application.api.ApplicationKey key)

Returns the number of seats for the given ApplicationKey. It will return:

1. 0 if the passed ApplicationKey is not licensed.
2. LicensePropertiesConstants.UNLIMITED_USERS if the passed ApplicationKey has no limit.
3. positive number when the passed ApplicationKey has that exact limit.

Returns:

the number of users/seats for the given ApplicationKey, 0, or LicensePropertiesConstants.UNLIMITED_USERS.

getDescription

@Nonnull
String getDescription()

Returns a user-friendly string version of the Applications encoded in the source license, or the empty string if there are no Applications in the source license.

hasNativeRole

@Internal
boolean hasNativeRole()

Indicates whether the license key has been issued as an JIRA Application license ( role based license ) or whether we have interpreted it as an JIRA Application license.

Returns:

true if license key was issued as an JIRA Application license ( role based license ), false if we have interpreted license as JIRA Application license or when no interpretation occurred.

Since:

7.0