com.atlassian.jira.license

Class JiraLicenseManagerImpl

java.lang.Object

com.atlassian.jira.license.JiraLicenseManagerImpl

All Implemented Interfaces:

CachingComponent, JiraLicenseManager

public class JiraLicenseManagerImpl
extends Object
implements JiraLicenseManager, CachingComponent

Since:

v4.0

Constructor Summary

Constructors

Constructor and Description
JiraLicenseManagerImpl(com.atlassian.license.SIDManager sidManager, com.atlassian.event.api.EventPublisher eventPublisher, MultiLicenseStore multiLicenseStore, LicenseDetailsFactory licenseDetailsFactory, ApplicationProperties applicationProperties, com.atlassian.cache.CacheManager cacheManager)

Method Summary

Modifier and Type	Method and Description
void	clearAndSetLicense(String licenseString) Removes all licenses from JIRA and replace them with the new license.
LicenseDetails	clearAndSetLicenseNoEvent(String licenseString) Removes all licenses from JIRA and replace them with the new license without raising an event.
void	clearCache() Clear the cache within the component.
void	confirmProceedUnderEvaluationTerms(String userName) Records that the user has acknowledged that one or more of their licenses is out of maintenance.
Set<com.atlassian.application.api.ApplicationKey>	getAllLicensedApplicationKeys() Retrieve a Set of all installed product license's keys in this instance.
io.atlassian.fugue.Option<LicenseDetails>	getLicense(com.atlassian.application.api.ApplicationKey application) Return the LicenseDetails associated with the passed ApplicationKey.
LicenseDetails	getLicense(String licenseString) Returns the LicenseDetails corresponding to the given license string after decoding, or throws an exception if the license string is invalid or cannot be decoded.
List<LicenseDetails>	getLicenses() Retrieve a collection of all product licenses installed in this instance.
String	getServerId() Returns the server ID of this JIRA instance, creating it if necessary.
SortedSet<String>	getSupportEntitlementNumbers() Retrieves the SEN (Support Entitlement Number) of all installed licenses and orders them in a consistent manner.
boolean	hasLicenseTooOldForBuildConfirmationBeenDone() Returns true if the support/maintenance period for this JIRA instance has been exceeded and an instance admin has acknowledged this fact.
boolean	isDecodeable(String licenseString) This returns true if the provided licence string can be decoded into a valid licence
boolean	isLicensed(com.atlassian.application.api.ApplicationKey application) Returns true if the given application is licensed.
boolean	isLicenseSet() Returns true if at least one license has been set.
void	onCacheClear(ClearCacheEvent clearEvent)
void	removeLicense(com.atlassian.application.api.ApplicationKey application) Removes the license that grants access to the passed application.
void	removeLicenses(Iterable<? extends LicenseDetails> licenses) Removes passed licenses.
LicenseDetails	setLicense(String licenseString) Sets the current license of this instance.
LicenseDetails	setLicenseNoEvent(String licenseString) Sets the current license of this instance.
Set<LicenseDetails>	setLicenses(Collection<String> licenseStrings) Sets the current licenses of this instance.
void	subscribeToClearCache(java.util.function.Consumer<Void> consumer) Subscribe a Consumer to be called after this manager's cache has been cleared.
void	unSubscribeFromClearCache(java.util.function.Consumer<Void> consumer) Un-subscribe a Consumer from being called after clearing of this manager's cache.

Methods inherited from class java.lang.Object

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

Constructor Detail

JiraLicenseManagerImpl

public JiraLicenseManagerImpl(com.atlassian.license.SIDManager sidManager,
                              com.atlassian.event.api.EventPublisher eventPublisher,
                              MultiLicenseStore multiLicenseStore,
                              LicenseDetailsFactory licenseDetailsFactory,
                              ApplicationProperties applicationProperties,
                              com.atlassian.cache.CacheManager cacheManager)

Method Detail

getServerId

@Nonnull
public String getServerId()

Description copied from interface: JiraLicenseManager

Returns the server ID of this JIRA instance, creating it if necessary.

Specified by:

getServerId in interface JiraLicenseManager

Returns:

see above

getLicense

@Nonnull
public LicenseDetails getLicense(@Nonnull
                                          String licenseString)

Description copied from interface: JiraLicenseManager

Returns the LicenseDetails corresponding to the given license string after decoding, or throws an exception if the license string is invalid or cannot be decoded.

Specified by:

getLicense in interface JiraLicenseManager

Parameters:

licenseString - the license string.

Returns:

the LicenseDetails for license encoded by the given string.

See Also:

JiraLicenseManager.isDecodeable(String), StringUtils.isBlank(CharSequence)

getLicenses

@Nonnull
public List<LicenseDetails> getLicenses()

Description copied from interface: JiraLicenseManager

Retrieve a collection of all product licenses installed in this instance.

In pre-7.0 JIRA this method returns an iterable containing at most one license.

Specified by:

getLicenses in interface JiraLicenseManager

Returns:

all product licenses installed in this instance.

getAllLicensedApplicationKeys

@Nonnull
public Set<com.atlassian.application.api.ApplicationKey> getAllLicensedApplicationKeys()

Description copied from interface: JiraLicenseManager

Retrieve a Set of all installed product license's keys in this instance.

Specified by:

getAllLicensedApplicationKeys in interface JiraLicenseManager

Returns:

all the installed product license's keys in this instance.

getSupportEntitlementNumbers

public SortedSet<String> getSupportEntitlementNumbers()

Description copied from interface: JiraLicenseManager

Retrieves the SEN (Support Entitlement Number) of all installed licenses and orders them in a consistent manner. The order is guaranteed for a given set of licenses. It may change when licenses are added or removed.

Specified by:

getSupportEntitlementNumbers in interface JiraLicenseManager

Returns:

SortedSet of the SEN. The order of SENs in the set will be maintained as far as the set of installed licenses doesn't change.

See Also:

LicenseDetails.getSupportEntitlementNumber()

getLicense

public io.atlassian.fugue.Option<LicenseDetails> getLicense(@Nonnull
                                                            com.atlassian.application.api.ApplicationKey application)

Description copied from interface: JiraLicenseManager

Return the LicenseDetails associated with the passed ApplicationKey.

Specified by:

getLicense in interface JiraLicenseManager

Parameters:

application - the ApplicationKey to query.

Returns:

the LicenseDetails associated with the passed application key or Option.none() if no such application exists.

isLicensed

public boolean isLicensed(@Nonnull
                          com.atlassian.application.api.ApplicationKey application)

Description copied from interface: JiraLicenseManager

Returns true if the given application is licensed.

Specified by:

isLicensed in interface JiraLicenseManager

Parameters:

application - the application

Returns:

true if the given application is licensed.

isDecodeable

public boolean isDecodeable(String licenseString)

Description copied from interface: JiraLicenseManager

This returns true if the provided licence string can be decoded into a valid licence

Specified by:

isDecodeable in interface JiraLicenseManager

Parameters:

licenseString - the license string

Returns:

true if it is can be decoded and false otherwise

setLicense

public LicenseDetails setLicense(String licenseString)

Description copied from interface: JiraLicenseManager

Sets the current license of this instance.

Note that this method will fire a LicenseChangedEvent.

Specified by:

setLicense in interface JiraLicenseManager

Parameters:

licenseString - the license string

Returns:

the JIRA license of this instance, this shouldn't be null if the license is valid.

setLicenses

public Set<LicenseDetails> setLicenses(Collection<String> licenseStrings)

Description copied from interface: JiraLicenseManager

Sets the current licenses of this instance.

Note that this method will fire a LicenseChangedEvent.

Specified by:

setLicenses in interface JiraLicenseManager

Parameters:

licenseStrings - the list of license string to set.

Returns:

all license details of all the giving

Throws:

IllegalArgumentException - if any of is invalid.

com.atlassian.extras.api.LicenseException - if any of was null or could not be decoded

setLicenseNoEvent

public LicenseDetails setLicenseNoEvent(String licenseString)

Description copied from interface: JiraLicenseManager

Sets the current license of this instance.

This is a special version of JiraLicenseManager.setLicense(String) that will not fire any event and is purely for use during a Data Import.

Specified by:

setLicenseNoEvent in interface JiraLicenseManager

Parameters:

licenseString - the license string

Returns:

the JIRA license of this instance, this shouldn't be null if the license is valid.

removeLicense

public void removeLicense(@Nonnull
                          com.atlassian.application.api.ApplicationKey application)

Description copied from interface: JiraLicenseManager

Removes the license that grants access to the passed application. Note: While this could potentially lead to losing access to another application the real world scenarios are:

• You have just one ELA license with multiple applications
• You have multiple licenses with a single application

Specified by:

removeLicense in interface JiraLicenseManager

Parameters:

application - the key of the application to check.

removeLicenses

public void removeLicenses(@Nonnull
                           Iterable<? extends LicenseDetails> licenses)

Description copied from interface: JiraLicenseManager

Removes passed licenses.

Specified by:

removeLicenses in interface JiraLicenseManager

Parameters:

licenses - to be removed

isLicenseSet

public boolean isLicenseSet()

Description copied from interface: JiraLicenseManager

Returns true if at least one license has been set.

Specified by:

isLicenseSet in interface JiraLicenseManager

See Also:

JiraLicenseService.isLicenseSet()

clearAndSetLicense

public void clearAndSetLicense(String licenseString)

Description copied from interface: JiraLicenseManager

Removes all licenses from JIRA and replace them with the new license. If the new license cannot be decoded, this method will throw an IllegalArgumentException.

Specified by:

clearAndSetLicense in interface JiraLicenseManager

clearAndSetLicenseNoEvent

public LicenseDetails clearAndSetLicenseNoEvent(String licenseString)

Description copied from interface: JiraLicenseManager

Removes all licenses from JIRA and replace them with the new license without raising an event. If the new license cannot be decoded, this method will throw an IllegalArgumentException.

Specified by:

clearAndSetLicenseNoEvent in interface JiraLicenseManager

onCacheClear

@EventListener
public void onCacheClear(ClearCacheEvent clearEvent)

confirmProceedUnderEvaluationTerms

public void confirmProceedUnderEvaluationTerms(String userName)

Description copied from interface: JiraLicenseManager

Records that the user has acknowledged that one or more of their licenses is out of maintenance. This triggers JIRA to grant a 30 day grace period whereby these licenses behave as 30 day evaluation licenses. This is so that admins are able to keep their JIRA running. This flag is reset automatically when all the invalid licenses are updated.

Specified by:

confirmProceedUnderEvaluationTerms in interface JiraLicenseManager

Parameters:

userName - the name of the user that made the confirmation.

See Also:

JiraLicenseManager.hasLicenseTooOldForBuildConfirmationBeenDone()

hasLicenseTooOldForBuildConfirmationBeenDone

public boolean hasLicenseTooOldForBuildConfirmationBeenDone()

Description copied from interface: JiraLicenseManager

Returns true if the support/maintenance period for this JIRA instance has been exceeded and an instance admin has acknowledged this fact. Typically, JIRA allows for a 30 day grace (evaluation) period.

Specified by:

hasLicenseTooOldForBuildConfirmationBeenDone in interface JiraLicenseManager

Returns:

true if the licenses in use are too old for the current build number and this instance is in a maintenance grace period.

See Also:

JiraLicenseManager.confirmProceedUnderEvaluationTerms(String)

subscribeToClearCache

public void subscribeToClearCache(@Nonnull
                                  java.util.function.Consumer<Void> consumer)

Description copied from interface: JiraLicenseManager

Subscribe a Consumer to be called after this manager's cache has been cleared.

Specified by:

subscribeToClearCache in interface JiraLicenseManager

Parameters:

consumer - Consumer that will be called after this manager's cache has been cleared.

See Also:

JiraLicenseManager.unSubscribeFromClearCache(Consumer)

unSubscribeFromClearCache

public void unSubscribeFromClearCache(@Nonnull
                                      java.util.function.Consumer<Void> consumer)

Description copied from interface: JiraLicenseManager

Un-subscribe a Consumer from being called after clearing of this manager's cache.

Specified by:

unSubscribeFromClearCache in interface JiraLicenseManager

Parameters:

consumer - Consumer to be un-subscribed from this manager.

See Also:

JiraLicenseManager.subscribeToClearCache(Consumer)

clearCache

public void clearCache()

Description copied from interface: CachingComponent

Clear the cache within the component.

Specified by:

clearCache in interface CachingComponent