com.atlassian.jira.license

Class Jira6xServiceDeskPluginEncodedLicenseSupplier

java.lang.Object

com.atlassian.jira.license.Jira6xServiceDeskPluginEncodedLicenseSupplier

All Implemented Interfaces:

java.util.function.Supplier<io.atlassian.fugue.Option<String>>

public class Jira6xServiceDeskPluginEncodedLicenseSupplier
extends Object
implements com.atlassian.cache.Supplier<io.atlassian.fugue.Option<String>>

Supplies a encoded plugin license for Service Desk version 1 or 2.

This class is intended to be used solely for the purposes of checking & migrating pre-7.0 Service Desk licenses. It is not a general-purposes SD license supplier, instead, see JiraLicenseManager#getLicense(com.atlassian.application.api.ApplicationKey).

To start and upgrade JIRA it needs to have all its licenses in maintenance. JIRA forces the admin to add/remove licenses until this is the case. This means that we can remove the old UPM SD license before migration has run which is very bad because we need it to migrate ({@link com.atlassian.jira.upgrade.tasks.role.MoveJira6xABPServiceDeskPermissions}). To work around this problem we move the license {@link #moveToUpgradeStore()} into a new location that means it becomes inactive but is still available to upgrade tasks through {@link #getUpgrade()} or {@link #getCurrentOrUpgrade()}.

Since:

7.0

Constructor Summary

Constructors

Constructor and Description
Jira6xServiceDeskPluginEncodedLicenseSupplier(ApplicationProperties applicationProperties)

Method Summary

Modifier and Type	Method and Description
void	clear() Remove the SD license from the plugin store and/or upgrade location.
io.atlassian.fugue.Option<String>	get() Retrieves encoded Service Desk license string from plugin store.
io.atlassian.fugue.Option<String>	getCurrentOrUpgrade() Retrieves encoded Service Desk license string from plugin store or the upgrade location if it exists.
io.atlassian.fugue.Option<String>	getUpgrade() Retrieves encoded Service Desk license from the upgrade location.
void	moveToUpgradeStore() Move the license from the UPM store into a location for upgrade.

Methods inherited from class java.lang.Object

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

Constructor Detail

Jira6xServiceDeskPluginEncodedLicenseSupplier

public Jira6xServiceDeskPluginEncodedLicenseSupplier(ApplicationProperties applicationProperties)

Method Detail

get

public io.atlassian.fugue.Option<String> get()

Retrieves encoded Service Desk license string from plugin store. No validation is performed, so returned license may be malformed or may not be a Service Desk license.

Specified by:

get in interface java.util.function.Supplier<io.atlassian.fugue.Option<String>>

Returns:

Option containing encoded license or Option.none() if there was no license in the plugin location.

getUpgrade

public io.atlassian.fugue.Option<String> getUpgrade()

Retrieves encoded Service Desk license from the upgrade location. No validation is performed, so returned license may be malformed or may not be a Service Desk license.

Returns:

Option containing encoded license or Option.none() if there was no such license.

getCurrentOrUpgrade

public io.atlassian.fugue.Option<String> getCurrentOrUpgrade()

Retrieves encoded Service Desk license string from plugin store or the upgrade location if it exists. No validation is performed, so returned license may be malformed or may not be a Service Desk license.

Returns:

the encoded Service Desk license string from plugin store or the upgrade location if it exists.

moveToUpgradeStore

public void moveToUpgradeStore()

Move the license from the UPM store into a location for upgrade. This logically removes the license from JIRA but leaves it accessible to upgrade tasks through getUpgrade() or getCurrentOrUpgrade().

clear

public void clear()

Remove the SD license from the plugin store and/or upgrade location.