com.atlassian.jira.license

Interface LicenseDetails

All Known Implementing Classes:

DefaultLicenseDetails, MockLicenseDetails, SubscriptionLicenseDetails

@PublicApi
public interface LicenseDetails

A set of methods which describe the state of the currently installed license.

Since:

v3.13

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	LicenseDetails.LicenseContact Represents a license contact name/email pair.
static interface	LicenseDetails.LicenseStatusMessage Encapsulates a collection of unordered, internationalised license-related status messages.

Method Summary

Methods

Modifier and Type	Method and Description
String	getBriefMaintenanceStatusMessage(I18nHelper i18n) Return the single word description of the maintenance status of the license.
Collection<LicenseDetails.LicenseContact>	getContacts() Gets the contact people for the license (e.g.
int	getDaysToLicenseExpiry() Returns the number of days until the license expires (i.e.
int	getDaysToMaintenanceExpiry() Returns the number of days until the license maintenance expires (i.e.
String	getDescription()
com.atlassian.extras.api.jira.JiraLicense	getJiraLicense() Retrieve the JiraLicense object corresponding to this license.
String	getLicenseExpiryStatusMessage(I18nHelper i18n, OutlookDate ignored) Deprecated. Use getLicenseExpiryStatusMessage(com.atlassian.crowd.embedded.api.User) instead. Since v5.0.
String	getLicenseExpiryStatusMessage(com.atlassian.crowd.embedded.api.User user) Return the HTML message that briefly describes the expiry status of the license.
LicenseRoleDetails	getLicenseRoles() Returns the license role information contained within this license.
LicenseDetails.LicenseStatusMessage	getLicenseStatusMessage(I18nHelper i18n) Return the all messages which contain status message.
String	getLicenseStatusMessage(I18nHelper i18n, OutlookDate ignored, String delimiter) Deprecated. use getLicenseStatusMessage(com.atlassian.jira.util.I18nHelper)
String	getLicenseStatusMessage(com.atlassian.crowd.embedded.api.User user, String delimiter) Deprecated. use getLicenseStatusMessage(com.atlassian.jira.util.I18nHelper)
String	getLicenseString()
int	getLicenseVersion() Gets the version of the current license, 0 if not set.
String	getMaintenanceEndString(OutlookDate outlookDate) Return the date string representing the end of maintenance of the license, whether the license is Evaluation, New Build Old License or otherwise.
int	getMaximumNumberOfUsers() Gets the maximum number of users allowed by the current license
String	getOrganisation() Gets the organisation this license belongs to
String	getPartnerName()
String	getPurchaseDate(OutlookDate outlookDate) Gets a nicely formatted purchase date for the current license
String	getSupportEntitlementNumber() Gets the SEN from the license
String	getSupportRequestMessage(I18nHelper i18n, OutlookDate ignored) Deprecated. HTML messages should not be generated by this class; since v5.0
String	getSupportRequestMessage(com.atlassian.crowd.embedded.api.User user) Deprecated. HTML messages should not be generated by this class; since v6.3
boolean	hasLicenseTooOldForBuildConfirmationBeenDone() Tells whether the admin has acknowledged that the JIRA instance is running on a too old license for its build number.
boolean	isCommercial() Tells whether this is a commercial license or not
boolean	isCommunity() Tells whether this is a community license or not
boolean	isDataCenter() Returns true if this is a DataCenter license.
boolean	isDemonstration() Tells whether this is a demonstration license or not
boolean	isDeveloper() Tells whether this is a developer license or not
boolean	isEnterpriseLicenseAgreement() Indicates whether this licence is a subscription-based Enterprise License Agreement (ELA).
boolean	isEntitledToSupport()
boolean	isEvaluation() Tells whether this is an evaluation license or not
boolean	isExpired() Checks whether the license is either expired or the grace period for an extended license (after upgrade) is over.
boolean	isLicenseAlmostExpired() If the license is Evaluation or Extended (New Build, Old License), returns true if we are within 7 days of the expiry date.
boolean	isLicenseSet() Tells whether a license has been set or not for this JIRA instance.
boolean	isMaintenanceValidForBuildDate(Date currentBuildDate) Tells whether the current build date is within the maintenance of the license
boolean	isNonProfit() Tells whether this is a non profit license or not
boolean	isOnDemand() Tells whether this is an OnDemand license or not
boolean	isOpenSource() Tells whether this is an open source license or not
boolean	isPersonalLicense() Tells whether this is a personal license or not
boolean	isStarter() Tells whether this is a starter license or not
boolean	isUnlimitedNumberOfUsers() Tells whether the current license authorise an unlimited number of users.

Method Detail

isLicenseSet

boolean isLicenseSet()

Tells whether a license has been set or not for this JIRA instance.

Returns:

true if a license has been set, false otherwise.

getLicenseVersion

int getLicenseVersion()

Gets the version of the current license, 0 if not set. This is the version of encoder/decoder that was used with this license.

Returns:

the version of the current license, 0 if not set.

isEntitledToSupport

boolean isEntitledToSupport()

Returns:

true for licenses that are entitled to support and updates of JIRA. This includes everything which is not a Personal License or Non-Commercial-Non-Renewable.

isLicenseAlmostExpired

boolean isLicenseAlmostExpired()

If the license is Evaluation or Extended (New Build, Old License), returns true if we are within 7 days of the expiry date. Otherwise, returns true if within 6 weeks before the supported period end date.

Returns:

true if the license is close to expiry; false otherwise.

getJiraLicense

com.atlassian.extras.api.jira.JiraLicense getJiraLicense()

Retrieve the JiraLicense object corresponding to this license. This will be useful to cross-product code that wants to deal with licenses from different products consistently using the ProductLicense interface (which JiraLicense extends).

Returns:

the JiraLicense object corresponding to this license

getLicenseRoles

@ExperimentalApi
LicenseRoleDetails getLicenseRoles()

Returns the license role information contained within this license.

getLicenseStatusMessage

LicenseDetails.LicenseStatusMessage getLicenseStatusMessage(I18nHelper i18n)

Return the all messages which contain status message.

Parameters:

i18n - i18n bean

Returns:

the status message

getLicenseStatusMessage

@Deprecated
String getLicenseStatusMessage(@Nullable
                                        com.atlassian.crowd.embedded.api.User user,
                                        String delimiter)

Deprecated. use getLicenseStatusMessage(com.atlassian.jira.util.I18nHelper)

Return the HTML message that describes the current status of the license.

Parameters:

user - the user for whom the message should be i18n'ed

delimiter - the line delimiter for the message

Returns:

the status message

getLicenseStatusMessage

@Deprecated
String getLicenseStatusMessage(I18nHelper i18n,
                                        @Nullable
                                        OutlookDate ignored,
                                        String delimiter)

Deprecated. use getLicenseStatusMessage(com.atlassian.jira.util.I18nHelper)

Return the HTML message that describes the current status of the license.

Parameters:

i18n - i18n bean

ignored - ignored

delimiter - the line delimiter for the message

Returns:

the status message

getLicenseExpiryStatusMessage

String getLicenseExpiryStatusMessage(@Nullable
                                   com.atlassian.crowd.embedded.api.User user)

Return the HTML message that briefly describes the expiry status of the license. Intended for use with the Admin Portlet.

Parameters:

user - the user for whom the message should be i18n'ed

Returns:

the status message, null for normal license outside of support period

getLicenseExpiryStatusMessage

@Deprecated
String getLicenseExpiryStatusMessage(I18nHelper i18n,
                                              @Nullable
                                              OutlookDate ignored)

Deprecated. Use getLicenseExpiryStatusMessage(com.atlassian.crowd.embedded.api.User) instead. Since v5.0.

Return the HTML message that briefly describes the expiry status of the license. Intended for use with the Admin Portlet.

Parameters:

i18n - i18n bean

ignored - outlookDate bean

Returns:

the status message, null for normal license outside of support period

getBriefMaintenanceStatusMessage

String getBriefMaintenanceStatusMessage(I18nHelper i18n)

Return the single word description of the maintenance status of the license. Intended for use with the Support Request and System Info pages.

Parameters:

i18n - i18n bean

Returns:

the status message - either "Supported", "Expired" or "Unsupported"

getSupportRequestMessage

@Deprecated
String getSupportRequestMessage(com.atlassian.crowd.embedded.api.User user)

Deprecated. HTML messages should not be generated by this class; since v6.3

Return the HTML message for support request denial or send e-mail success page.

Parameters:

user - a User object for the calling user

Returns:

the support request message

getSupportRequestMessage

@Deprecated
String getSupportRequestMessage(I18nHelper i18n,
                                         @Nullable
                                         OutlookDate ignored)

Deprecated. HTML messages should not be generated by this class; since v5.0

Return the HTML message for support request denial or send e-mail success page.

Parameters:

i18n - i18n bean

ignored - ignored

Returns:

the support request message

getMaintenanceEndString

String getMaintenanceEndString(OutlookDate outlookDate)

Return the date string representing the end of maintenance of the license, whether the license is Evaluation, New Build Old License or otherwise.

Note that the return type here is a String to intentionally signify that this value should not be used in any logic calculations and only for displaying to the user.

Parameters:

outlookDate - outlookDate bean

Returns:

the date as a string (should never be null)

isUnlimitedNumberOfUsers

boolean isUnlimitedNumberOfUsers()

Tells whether the current license authorise an unlimited number of users.

Returns:

true if the license authorise an unlimited number of users, false otherwise.

See Also:

getMaximumNumberOfUsers()

getMaximumNumberOfUsers

int getMaximumNumberOfUsers()

Gets the maximum number of users allowed by the current license

Returns:

the maximum number of user allowed by the license, -1 if unlimited

See Also:

isUnlimitedNumberOfUsers()

getDescription

String getDescription()

Returns:

the description of the current license

getPartnerName

String getPartnerName()

Returns:

the Partner name inside the current license or null if its not set

isExpired

boolean isExpired()

Checks whether the license is either expired or the grace period for an extended license (after upgrade) is over.

Returns:

true if has, false otherwise.

getPurchaseDate

String getPurchaseDate(OutlookDate outlookDate)

Gets a nicely formatted purchase date for the current license

Parameters:

outlookDate - the date formatter

Returns:

a formatted purchased date.

isEvaluation

boolean isEvaluation()

Tells whether this is an evaluation license or not

Returns:

true if this is an evaluation license, false otherwise.

isStarter

boolean isStarter()

Tells whether this is a starter license or not

Returns:

true if this is a starter license, false otherwise.

isCommercial

boolean isCommercial()

Tells whether this is a commercial license or not

Returns:

true if this is a commercial license, false otherwise.

isPersonalLicense

boolean isPersonalLicense()

Tells whether this is a personal license or not

Returns:

true if this is a personal license, false otherwise.

isCommunity

boolean isCommunity()

Tells whether this is a community license or not

Returns:

true if this is a community license, false otherwise.

isOpenSource

boolean isOpenSource()

Tells whether this is an open source license or not

Returns:

true if this is an open source license, false otherwise.

isNonProfit

boolean isNonProfit()

Tells whether this is a non profit license or not

Returns:

true if this is a non profit license, false otherwise.

isDemonstration

boolean isDemonstration()

Tells whether this is a demonstration license or not

Returns:

true if this is a demonstration license, false otherwise.

isOnDemand

boolean isOnDemand()

Tells whether this is an OnDemand license or not

Returns:

true if this is a OnDemand, false otherwise.

isDataCenter

boolean isDataCenter()

Returns true if this is a DataCenter license.

Returns:

true if this is a DataCenter license.

Since:

v6.3

isDeveloper

boolean isDeveloper()

Tells whether this is a developer license or not

Returns:

true if this is a developer license, false otherwise.

getOrganisation

String getOrganisation()

Gets the organisation this license belongs to

Returns:

the organisation this license belongs to

hasLicenseTooOldForBuildConfirmationBeenDone

boolean hasLicenseTooOldForBuildConfirmationBeenDone()

Tells whether the admin has acknowledged that the JIRA instance is running on a too old license for its build number. Typically JIRA allows for a 30 days grace period when doing so.

Returns:

true if the license in use is too old with regards to the build number, false otherwise.

getLicenseString

String getLicenseString()

Returns:

the encoded license string that was was decode to produce the current license. This will return null if it is not set

isMaintenanceValidForBuildDate

boolean isMaintenanceValidForBuildDate(Date currentBuildDate)

Tells whether the current build date is within the maintenance of the license

Parameters:

currentBuildDate - the current build date

Returns:

true if the build date is within the maintenance period, false otherwise.

getSupportEntitlementNumber

String getSupportEntitlementNumber()

Gets the SEN from the license

Returns:

the SEN from the license

getContacts

Collection<LicenseDetails.LicenseContact> getContacts()

Gets the contact people for the license (e.g. Name and Email of whoever first signed up for the OD license)

Returns:

collection of contact people for the license

isEnterpriseLicenseAgreement

boolean isEnterpriseLicenseAgreement()

Indicates whether this licence is a subscription-based Enterprise License Agreement (ELA).

Returns:

true if this licence is a subscription-based Enterprise License Agreement (ELA).

Since:

v6.3

getDaysToLicenseExpiry

int getDaysToLicenseExpiry()

Returns the number of days until the license expires (i.e. JIRA will enter read-only mode).

• A value of 0 indicates that license will expire today (but is still valid).
• A negative value indicates the number of days the license is expired.
• A positive value indicates the number of days the license will be valid for. A value of Integer.MAX_VALUE indicates that the license will never expire.

A partial day will be rounded down. For example, 1.5 days will be reported as 1 while -0.5 days will be reported as -1 days.

Returns:

the number of days until the license expires (i.e. JIRA will enter read-only mode)

getDaysToMaintenanceExpiry

int getDaysToMaintenanceExpiry()

Returns the number of days until the license maintenance expires (i.e. support and upgrades will cease).

• A value of 0 indicates that license maintenance will expire today (but is still valid).
• A negative value indicates the number of days the license maintenance is expired.
• A positive value indicates the number of days the license maintenance will be value for. value of Integer.MAX_VALUE indicates that the license maintenance will never expire.

A partial day will be rounded down. For example, 1.5 days will be reported as 1 while -0.5 days will be reported as -1 days.

Returns:

the number of days until the license maintenance expires (i.e. support and upgrades will cease).