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.getLicense()

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(com.atlassian.extras.api.jira.JiraLicense license, String licenseString, ApplicationProperties applicationProperties, ExternalLinkUtil externalLinkUtil, BuildUtilsInfo buildUtilsInfo, I18nHelper.BeanFactory i18nFactory, DateTimeFormatter dateTimeFormatter, com.atlassian.extras.decoder.api.LicenseDecoder licenseDecoder, ClusterManager clusterManager, com.atlassian.core.util.Clock clock)

Method Summary

Methods

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) Returns an expiry status message; see also getLicenseExpiryStatusMessage(I18nHelper, OutlookDate).
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

getBriefMaintenanceStatusMessage, getContacts, getDaysToLicenseExpiry, getDaysToMaintenanceExpiry, getDescription, getJiraLicense, getLicenseExpiryStatusMessage, getLicenseRoles, getLicenseStatusMessage, getLicenseStatusMessage, getLicenseString, getLicenseVersion, getMaintenanceEndString, getMaximumNumberOfUsers, getOrganisation, getPartnerName, getPurchaseDate, getSupportEntitlementNumber, getSupportRequestMessage, getSupportRequestMessage, hasLicenseTooOldForBuildConfirmationBeenDone, isCommercial, isCommunity, isDataCenter, isDemonstration, isDeveloper, isEnterpriseLicenseAgreement, isEntitledToSupport, isEvaluation, isLicenseSet, isMaintenanceValidForBuildDate, isNonProfit, isOnDemand, isOpenSource, isPersonalLicense, isStarter, isUnlimitedNumberOfUsers

Methods inherited from class java.lang.Object

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

Constructor Detail

SubscriptionLicenseDetails

public SubscriptionLicenseDetails(@Nonnull
                          com.atlassian.extras.api.jira.JiraLicense license,
                          @Nonnull
                          String licenseString,
                          @Nonnull
                          ApplicationProperties applicationProperties,
                          @Nonnull
                          ExternalLinkUtil externalLinkUtil,
                          @Nonnull
                          BuildUtilsInfo buildUtilsInfo,
                          @Nonnull
                          I18nHelper.BeanFactory i18nFactory,
                          @Nonnull
                          DateTimeFormatter dateTimeFormatter,
                          @Nonnull
                          com.atlassian.extras.decoder.api.LicenseDecoder licenseDecoder,
                          @Nonnull
                          ClusterManager clusterManager,
                          @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)

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

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