Class MockLicenseDetails
- All Implemented Interfaces:
LicenseDetails
- Since:
- v6.2.3
-
Nested Class Summary
Nested classes/interfaces inherited from interface com.atlassian.jira.license.LicenseDetails
LicenseDetails.LicenseContact, LicenseDetails.LicenseStatusMessage
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns a user-friendlyString
description of theApplication
(s) granted by this license.Return the single word description of the maintenance status of the license.Gets the contact people for the license (e.g.int
Returns the number of days until the license expires (i.e.int
Returns the number of days until the license maintenance expires (i.e.Returns the literal description of the current license as given in the license itself.com.atlassian.extras.api.jira.JiraLicense
Retrieve the JiraLicense object corresponding to this license.Returns all the application/role information contained within this license, even if they are non active.Return the HTML message that briefly describes the expiry status of the license.getLicenseExpiryStatusMessage
(I18nHelper i18n, OutlookDate ignored) Return the HTML message that briefly describes the expiry status of the license.getLicenseStatusMessage
(I18nHelper i18n, UserManager userManager) Return the all messages which contain status message.com.atlassian.extras.api.LicenseType
int
Gets the version of the current license, 0 if not set.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.Returns the maintenance expiryDate
of this license, or null if the maintenance period of this license is unlimited.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.Gets the organisation this license belongs togetPurchaseDate
(OutlookDate outlookDate) Gets a nicely formatted purchase date for the current licenseGets the SEN from the licenseboolean
hasApplication
(com.atlassian.application.api.ApplicationKey application) Returns true if the givenapplication
is contained within this license.boolean
Tells whether this is a commercial license or notboolean
Tells whether this is a community license or notboolean
Returns true if this is a DataCenter license.boolean
Tells whether this is a demonstration license or notboolean
Tells whether this is a developer license or notboolean
Indicates whether this licence is a subscription-based Enterprise License Agreement (ELA).boolean
boolean
Tells whether this is an evaluation license or notboolean
Checks whether the license is either expired or the grace period for an extended license (after upgrade) is over.boolean
isMaintenanceValidForBuildDate
(Date currentBuildDate) Tells whether the current build date is within the maintenance of the licenseboolean
Tells whether this is a non profit license or notboolean
Tells whether this is an OnDemand license or notboolean
Tells whether this is an open source license or notboolean
Checks whether the license type is a paid type.boolean
Tells whether this is a personal license or notboolean
Tells whether this is a starter license or notboolean
Tells whether the current license authorise an unlimited number of users.setBriefDescription
(String description) setDaysToLicenseExpiry
(int days) setDaysToMaintenanceExpiry
(int days) setDeveloper
(boolean developer) setEvaluation
(boolean eval) setLicensedApplications
(com.atlassian.application.api.ApplicationKey... keys) setLicensedApplications
(LicensedApplications licensedApplications) setLicenseString
(String licensString) setMaintenanceDate
(Date maintenanceDate) toString()
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.atlassian.jira.license.LicenseDetails
getPurchaseDate
-
Constructor Details
-
MockLicenseDetails
public MockLicenseDetails()
-
-
Method Details
-
getLicenseVersion
public int getLicenseVersion()Description copied from interface:LicenseDetails
Gets the version of the current license, 0 if not set. This is the version of encoder/decoder that was used with this license.- Specified by:
getLicenseVersion
in interfaceLicenseDetails
- Returns:
- the version of the current license, 0 if not set.
-
isEntitledToSupport
public boolean isEntitledToSupport()- Specified by:
isEntitledToSupport
in interfaceLicenseDetails
- 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.
-
getJiraLicense
public com.atlassian.extras.api.jira.JiraLicense getJiraLicense()Description copied from interface:LicenseDetails
Retrieve the JiraLicense object corresponding to this license.Jira 7.0 introduced a new licensing model where a license can contain multiple applications. This method will return the JiraLicense object and has no knowledge of the applications contained within the license.
To find the user limit for a specific application, use
LicenseDetails.getLicensedApplications()
andLicensedApplications.getUserLimit(ApplicationKey)
.The values returned by
ProductLicense.getMaximumNumberOfUsers()
andProductLicense.isUnlimitedNumberOfUsers()
should not be used.- Specified by:
getJiraLicense
in interfaceLicenseDetails
- Returns:
- the JiraLicense object corresponding to this license
-
getLicensedApplications
Description copied from interface:LicenseDetails
Returns all the application/role information contained within this license, even if they are non active.- Specified by:
getLicensedApplications
in interfaceLicenseDetails
- Returns:
- the application/role information contained within this license.
-
hasApplication
public boolean hasApplication(@Nonnull com.atlassian.application.api.ApplicationKey application) Description copied from interface:LicenseDetails
Returns true if the givenapplication
is contained within this license.- Specified by:
hasApplication
in interfaceLicenseDetails
- Parameters:
application
- the application to query- Returns:
- true if the application is found in this license
-
setLicensedApplications
-
getLicenseStatusMessage
public LicenseDetails.LicenseStatusMessage getLicenseStatusMessage(I18nHelper i18n, UserManager userManager) Description copied from interface:LicenseDetails
Return the all messages which contain status message.- Specified by:
getLicenseStatusMessage
in interfaceLicenseDetails
- Parameters:
i18n
- i18n beanuserManager
- used to get user context if necessary- Returns:
- the status message
-
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 returnedLicenseDetails.LicenseStatusMessage.hasAnyMessages()
would return false.- Specified by:
getMaintenanceMessage
in interfaceLicenseDetails
- Parameters:
i18n
- i18n helperapplicationName
- JIRA Application name (trademark for display)- Returns:
- the status message, subscription license would return no messages.
-
getLicenseExpiryStatusMessage
Description copied from interface:LicenseDetails
Return the HTML message that briefly describes the expiry status of the license. Intended for use with the Admin Portlet.- Specified by:
getLicenseExpiryStatusMessage
in interfaceLicenseDetails
- 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
Description copied from interface:LicenseDetails
Return the HTML message that briefly describes the expiry status of the license. Intended for use with the Admin Portlet.- Specified by:
getLicenseExpiryStatusMessage
in interfaceLicenseDetails
- Parameters:
i18n
- i18n beanignored
- outlookDate bean- Returns:
- the status message, null for normal license outside of support period
-
getBriefMaintenanceStatusMessage
Description copied from interface:LicenseDetails
Return the single word description of the maintenance status of the license. Intended for use with the Support Request and System Info pages.- Specified by:
getBriefMaintenanceStatusMessage
in interfaceLicenseDetails
- Parameters:
i18n
- i18n bean- Returns:
- the status message - either "Supported", "Expired" or "Unsupported"
-
getMaintenanceExpiryDate
Description copied from interface:LicenseDetails
Returns the maintenance expiryDate
of this license, or null if the maintenance period of this license is unlimited.- Specified by:
getMaintenanceExpiryDate
in interfaceLicenseDetails
- Returns:
- the maintenance expiry
Date
of this license, or null if the maintenance period of this license is unlimited.
-
getMaintenanceEndString
Description copied from interface:LicenseDetails
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.
- Specified by:
getMaintenanceEndString
in interfaceLicenseDetails
- Parameters:
outlookDate
- outlookDate bean- Returns:
- the date as a string (should never be null)
-
isUnlimitedNumberOfUsers
public boolean isUnlimitedNumberOfUsers()Description copied from interface:LicenseDetails
Tells whether the current license authorise an unlimited number of users.- Specified by:
isUnlimitedNumberOfUsers
in interfaceLicenseDetails
- Returns:
true
if the license authorise an unlimited number of users,false
otherwise.
-
getDescription
Description copied from interface:LicenseDetails
Returns the literal description of the current license as given in the license itself.- Specified by:
getDescription
in interfaceLicenseDetails
- Returns:
- the literal description of the current license as given in the license itself.
-
getPartnerName
- Specified by:
getPartnerName
in interfaceLicenseDetails
- Returns:
- the Partner name inside the current license or null if its not set
-
isExpired
public boolean isExpired()Description copied from interface:LicenseDetails
Checks whether the license is either expired or the grace period for an extended license (after upgrade) is over.- Specified by:
isExpired
in interfaceLicenseDetails
- Returns:
- true if has, false otherwise.
-
getPurchaseDate
Description copied from interface:LicenseDetails
Gets a nicely formatted purchase date for the current license- Specified by:
getPurchaseDate
in interfaceLicenseDetails
- Parameters:
outlookDate
- the date formatter- Returns:
- a formatted purchased date.
-
setEvaluation
-
isEvaluation
public boolean isEvaluation()Description copied from interface:LicenseDetails
Tells whether this is an evaluation license or not- Specified by:
isEvaluation
in interfaceLicenseDetails
- Returns:
true
if this is an evaluation license,false
otherwise.
-
isStarter
public boolean isStarter()Description copied from interface:LicenseDetails
Tells whether this is a starter license or not- Specified by:
isStarter
in interfaceLicenseDetails
- Returns:
true
if this is a starter license,false
otherwise.
-
isPaidType
public boolean isPaidType()Description copied from interface:LicenseDetails
Checks whether the license type is a paid type. The paid types are ACADEMIC, COMMERCIAL, and STARTER.- Specified by:
isPaidType
in interfaceLicenseDetails
- Returns:
true
if the license is a paid type,false
otherwise.
-
isCommercial
public boolean isCommercial()Description copied from interface:LicenseDetails
Tells whether this is a commercial license or not- Specified by:
isCommercial
in interfaceLicenseDetails
- Returns:
true
if this is a commercial license,false
otherwise.
-
isPersonalLicense
public boolean isPersonalLicense()Description copied from interface:LicenseDetails
Tells whether this is a personal license or not- Specified by:
isPersonalLicense
in interfaceLicenseDetails
- Returns:
true
if this is a personal license,false
otherwise.
-
isCommunity
public boolean isCommunity()Description copied from interface:LicenseDetails
Tells whether this is a community license or not- Specified by:
isCommunity
in interfaceLicenseDetails
- Returns:
true
if this is a community license,false
otherwise.
-
isOpenSource
public boolean isOpenSource()Description copied from interface:LicenseDetails
Tells whether this is an open source license or not- Specified by:
isOpenSource
in interfaceLicenseDetails
- Returns:
true
if this is an open source license,false
otherwise.
-
isNonProfit
public boolean isNonProfit()Description copied from interface:LicenseDetails
Tells whether this is a non profit license or not- Specified by:
isNonProfit
in interfaceLicenseDetails
- Returns:
true
if this is a non profit license,false
otherwise.
-
isDemonstration
public boolean isDemonstration()Description copied from interface:LicenseDetails
Tells whether this is a demonstration license or not- Specified by:
isDemonstration
in interfaceLicenseDetails
- Returns:
true
if this is a demonstration license,false
otherwise.
-
isOnDemand
public boolean isOnDemand()Description copied from interface:LicenseDetails
Tells whether this is an OnDemand license or not- Specified by:
isOnDemand
in interfaceLicenseDetails
- Returns:
true
if this is a OnDemand,false
otherwise.
-
isDataCenter
public boolean isDataCenter()Description copied from interface:LicenseDetails
Returns true if this is a DataCenter license.- Specified by:
isDataCenter
in interfaceLicenseDetails
- Returns:
- true if this is a DataCenter license.
-
isEnterpriseLicenseAgreement
public boolean isEnterpriseLicenseAgreement()Description copied from interface:LicenseDetails
Indicates whether this licence is a subscription-based Enterprise License Agreement (ELA).- Specified by:
isEnterpriseLicenseAgreement
in interfaceLicenseDetails
- Returns:
- true if this licence is a subscription-based Enterprise License Agreement (ELA).
-
isDeveloper
public boolean isDeveloper()Description copied from interface:LicenseDetails
Tells whether this is a developer license or not- Specified by:
isDeveloper
in interfaceLicenseDetails
- Returns:
true
if this is a developer license,false
otherwise.
-
setDeveloper
-
getOrganisation
Description copied from interface:LicenseDetails
Gets the organisation this license belongs to- Specified by:
getOrganisation
in interfaceLicenseDetails
- Returns:
- the organisation this license belongs to
-
getLicenseString
- Specified by:
getLicenseString
in interfaceLicenseDetails
- Returns:
- the encoded license string that was was decode to produce the current license. This will return null if it is not set
-
isMaintenanceValidForBuildDate
Description copied from interface:LicenseDetails
Tells whether the current build date is within the maintenance of the license- Specified by:
isMaintenanceValidForBuildDate
in interfaceLicenseDetails
- Parameters:
currentBuildDate
- the current build date- Returns:
true
if the build date is within the maintenance period,false
otherwise.
-
getSupportEntitlementNumber
Description copied from interface:LicenseDetails
Gets the SEN from the license- Specified by:
getSupportEntitlementNumber
in interfaceLicenseDetails
- Returns:
- the SEN from the license
-
getContacts
Description copied from interface:LicenseDetails
Gets the contact people for the license (e.g. Name and Email of whoever first signed up for the OD license)- Specified by:
getContacts
in interfaceLicenseDetails
- Returns:
- collection of contact people for the license
-
getDaysToLicenseExpiry
public int getDaysToLicenseExpiry()Description copied from interface:LicenseDetails
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 as1
while-0.5
days will be reported as-1
days.- Specified by:
getDaysToLicenseExpiry
in interfaceLicenseDetails
- Returns:
- the number of days until the license expires (i.e. JIRA will enter read-only mode)
- A value of
-
setDaysToLicenseExpiry
-
getDaysToMaintenanceExpiry
public int getDaysToMaintenanceExpiry()Description copied from interface:LicenseDetails
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 as1
while-0.5
days will be reported as-1
days.- Specified by:
getDaysToMaintenanceExpiry
in interfaceLicenseDetails
- Returns:
- the number of days until the license maintenance expires (i.e. support and upgrades will cease).
- A value of
-
getLicenseType
public com.atlassian.extras.api.LicenseType getLicenseType()- Specified by:
getLicenseType
in interfaceLicenseDetails
-
getApplicationDescription
Description copied from interface:LicenseDetails
Returns a user-friendlyString
description of theApplication
(s) granted by this license. This method differs fromLicenseDetails.getDescription()
in that the returned String isApplication
-focused and heuristically determined, and does not include license type information, number of seats etc.If there are no
Application
s in the current license, then this method returns the String"JIRA"
.- Specified by:
getApplicationDescription
in interfaceLicenseDetails
-
setBriefDescription
-
setDaysToMaintenanceExpiry
-
setSupportEntitlementNumber
-
setMaintenanceDate
-
toString
-
setLicenseString
-
setLicensedApplications
public MockLicenseDetails setLicensedApplications(com.atlassian.application.api.ApplicationKey... keys)
-