com.atlassian.jira.license
Interface LicenseDetails

public interface LicenseDetails

A set of methods which describe the state of the currently installed license. This class was introduced to try get away from the nasty static monster that is JiraLicenseUtils

Since:

v3.13

Method Summary

String	getBriefMaintenanceStatusMessage(I18nHelper i18n) Return the single word description of the maintenance status of the license.
String	getLicenseExpiryStatusMessage(I18nHelper i18n, OutlookDate outlookDate) Return the HTML message that briefly describes the expiry status of the license.
String	getLicenseStatusMessage(I18nHelper i18n, OutlookDate outlookDate, String delimiter) Return the HTML message that describes the current status of the license.
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.
String	getSupportRequestMessage(I18nHelper i18n, OutlookDate outlookDate) Return the HTML message for support request denial or send e-mail success page.
boolean	isAcademicLicense()
boolean	isCommercialLicense() Returns true for commercial licenses.
boolean	isCommunityLicense()
boolean	isDemonstrationLicense()
boolean	isDeveloperLicense()
boolean	isEntitledToSupport()
boolean	isEvaluationLicense()
boolean	isFullLicense()
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	isMaintenanceEnded() Returns true if the support period end date has passed; false otherwise.
boolean	isNewBuildWithOldLicense() Determines whether the build date of this version of JIRA is newer than the end of the support period for the installed license, and the license has been extended under evaluation terms.
boolean	isNonCommercialNonRenewable() Returns true for licenses that cannot be purchased, nor renewed by users.
boolean	isNonProfitLicense()
boolean	isOpenSourceLicense()
boolean	isSelfRenewable() Returns true for license that can be renewed on http://my.atlassian.com by the user.

Method Detail

isFullLicense

boolean isFullLicense()

isEvaluationLicense

boolean isEvaluationLicense()

isAcademicLicense

boolean isAcademicLicense()

isNonProfitLicense

boolean isNonProfitLicense()

isCommunityLicense

boolean isCommunityLicense()

isOpenSourceLicense

boolean isOpenSourceLicense()

isDeveloperLicense

boolean isDeveloperLicense()

isDemonstrationLicense

boolean isDemonstrationLicense()

isCommercialLicense

boolean isCommercialLicense()

Returns true for commercial licenses.

Those licenses are:

• evaluation
• full (commercial)
• academic
• hosted

Returns:

true if commercial, false otherwise or if cannot determine

isSelfRenewable

boolean isSelfRenewable()

Returns true for license that can be renewed on http://my.atlassian.com by the user.

Those licenses are:

• community
• open-source
• developer
• personal

Returns:

true for user renewable licenses, false otherwise or is cannot determine

isNonCommercialNonRenewable

boolean isNonCommercialNonRenewable()

Returns true for licenses that cannot be purchased, nor renewed by users.

Those licenses are:

• non-profit (deprecated)
• demonstration
• enterprise for testing

Returns:

true if commercial, false otherwise or if cannot determine

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.

isNewBuildWithOldLicense

boolean isNewBuildWithOldLicense()

Determines whether the build date of this version of JIRA is newer than the end of the support period for the installed license, and the license has been extended under evaluation terms.

Returns:

true if the build is newer than the end of the supported period; false otherwise.

getLicenseStatusMessage

String getLicenseStatusMessage(I18nHelper i18n,
                               OutlookDate outlookDate,
                               String delimiter)

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

Parameters:

i18n - i18n bean

outlookDate - outlookDate bean

delimiter - the line delimiter for the message

Returns:

the status message

getLicenseExpiryStatusMessage

String getLicenseExpiryStatusMessage(I18nHelper i18n,
                                     OutlookDate outlookDate)

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

Parameters:

i18n - i18n bean

outlookDate - 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

String getSupportRequestMessage(I18nHelper i18n,
                                OutlookDate outlookDate)

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

Parameters:

i18n - i18n bean

outlookDate - outlookDate bean

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)

isMaintenanceEnded

boolean isMaintenanceEnded()

Returns true if the support period end date has passed; false otherwise.

Returns:

true if the support period end date has passed; false otherwise.