com.atlassian.jira.license

Class SubscriptionLicenseDetails

java.lang.Object

com.atlassian.jira.license.DefaultLicenseDetails

com.atlassian.jira.license.SubscriptionLicenseDetails

All Implemented Interfaces:

LicenseDetails

public class SubscriptionLicenseDetails
extends DefaultLicenseDetails

Subclass of DefaultLicenseDetails for implementing enterprise license-specific behaviour. There are currently 2 kinds of enterprise license: DataCenter (which enables clustering) and ELA (Enterprise License Agreement, which allows use of all Atlassian products). Both of these are issued on a subscription basis, and behave differently on expiry.

As the name suggests, licenses represented by this class have a finite expiry date, representing the end of the current subscription period.

Since:

v6.3

See Also:

JiraLicenseManager.getLicenses()

Nested Class Summary

Nested classes/interfaces inherited from class com.atlassian.jira.license.DefaultLicenseDetails

DefaultLicenseDetails.Link

Nested classes/interfaces inherited from interface com.atlassian.jira.license.LicenseDetails

LicenseDetails.LicenseContact, LicenseDetails.LicenseStatusMessage

Constructor Summary

Constructors

Constructor and Description
SubscriptionLicenseDetails(JiraProductLicense license, String licenseString, ApplicationProperties applicationProperties, ExternalLinkUtil externalLinkUtil, BuildUtilsInfo buildUtilsInfo, I18nHelper.BeanFactory i18nFactory, DateTimeFormatter dateTimeFormatter, com.atlassian.core.util.Clock clock)

Method Summary

Modifier and Type	Method and Description
String	getLicenseExpiryStatusMessage(I18nHelper i18n, OutlookDate date) Returns a duration-based brief expiry message of form "Expires in XX months, YY days".
LicenseDetails.LicenseStatusMessage	getLicenseStatusMessage(I18nHelper i18n, UserManager ignored) Returns an expiry status message; see also getLicenseExpiryStatusMessage(I18nHelper, OutlookDate).
LicenseDetails.LicenseStatusMessage	getMaintenanceMessage(I18nHelper i18n, String applicationName) Get the maintenance message for this license, this does not evaluate the maintenance date, it only provides the message that should be displayed when license out of maintenance for a given JIRA Application.
boolean	isExpired() Checks whether the license is either expired for Evaluation or Extended Licenses (New Build, Old License).
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.

Methods inherited from class com.atlassian.jira.license.DefaultLicenseDetails

equals, getApplicationDescription, getBriefMaintenanceStatusMessage, getContacts, getDaysToLicenseExpiry, getDaysToMaintenanceExpiry, getDescription, getJiraLicense, getLicensedApplications, getLicenseExpiryStatusMessage, getLicenseStatusMessage, getLicenseStatusMessage, getLicenseString, getLicenseType, getLicenseVersion, getMaintenanceEndString, getMaintenanceExpiryDate, getOrganisation, getPartnerName, getPurchaseDate, getPurchaseDate, getSupportEntitlementNumber, hasApplication, hashCode, isCommercial, isCommunity, isDataCenter, isDemonstration, isDeveloper, isEnterpriseLicenseAgreement, isEntitledToSupport, isEvaluation, isMaintenanceValidForBuildDate, isNonProfit, isOnDemand, isOpenSource, isPaidType, isPersonalLicense, isStarter, isUnlimitedNumberOfUsers

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SubscriptionLicenseDetails

public SubscriptionLicenseDetails(@Nonnull
                                  JiraProductLicense license,
                                  @Nonnull
                                  String licenseString,
                                  @Nonnull
                                  ApplicationProperties applicationProperties,
                                  @Nonnull
                                  ExternalLinkUtil externalLinkUtil,
                                  @Nonnull
                                  BuildUtilsInfo buildUtilsInfo,
                                  @Nonnull
                                  I18nHelper.BeanFactory i18nFactory,
                                  @Nonnull
                                  DateTimeFormatter dateTimeFormatter,
                                  @Nonnull
                                  com.atlassian.core.util.Clock clock)
                           throws IllegalArgumentException

Throws:

IllegalArgumentException - if ProductLicense.getExpiryDate() is null (ie: a perpetual license).

Method Detail

isExpired

public boolean isExpired()

Checks whether the license is either expired for Evaluation or Extended Licenses (New Build, Old License).

This is logically similar to DefaultLicenseDetails, but these kinds of licenses do not have to worry about legacy version 1 licenses so this logic is simpler.

Specified by:

isExpired in interface LicenseDetails

Overrides:

isExpired in class DefaultLicenseDetails

Returns:

true if has; false otherwise.

isLicenseAlmostExpired

public boolean isLicenseAlmostExpired()

Description copied from class: DefaultLicenseDetails

If the license is Evaluation or Extended (New Build, Old License), returns true if we are within 7 days of the expiry date.

Specified by:

isLicenseAlmostExpired in interface LicenseDetails

Overrides:

isLicenseAlmostExpired in class DefaultLicenseDetails

Returns:

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

See Also:

#isExpired()}

getLicenseStatusMessage

public LicenseDetails.LicenseStatusMessage getLicenseStatusMessage(@Nonnull
                                                                   I18nHelper i18n,
                                                                   UserManager ignored)

Returns an expiry status message; see also getLicenseExpiryStatusMessage(I18nHelper, OutlookDate).

Specified by:

getLicenseStatusMessage in interface LicenseDetails

Overrides:

getLicenseStatusMessage in class DefaultLicenseDetails

Parameters:

i18n - i18n bean

ignored - used to get user context if necessary

Returns:

An expiry status message.

getLicenseExpiryStatusMessage

public String getLicenseExpiryStatusMessage(@Nonnull
                                            I18nHelper i18n,
                                            @Nullable
                                            OutlookDate date)

Returns a duration-based brief expiry message of form "Expires in XX months, YY days".

Specified by:

getLicenseExpiryStatusMessage in interface LicenseDetails

Overrides:

getLicenseExpiryStatusMessage in class DefaultLicenseDetails

Parameters:

date - ignored

i18n - i18n bean

Returns:

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

getMaintenanceMessage

public LicenseDetails.LicenseStatusMessage getMaintenanceMessage(@Nonnull
                                                                 I18nHelper i18n,
                                                                 String applicationName)

Description copied from interface: LicenseDetails

Get the maintenance message for this license, this does not evaluate the maintenance date, it only provides the message that should be displayed when license out of maintenance for a given JIRA Application. For subscription license no message would be returned LicenseDetails.LicenseStatusMessage.hasAnyMessages() would return false.

Specified by:

getMaintenanceMessage in interface LicenseDetails

Overrides:

getMaintenanceMessage in class DefaultLicenseDetails

Parameters:

i18n - i18n helper

applicationName - JIRA Application name (trademark for display)

Returns:

the status message, subscription license would return no messages.