com.atlassian.jira.license

Class JiraLicenseManagerImpl

java.lang.Object

com.atlassian.jira.license.JiraLicenseManagerImpl

All Implemented Interfaces:

JiraLicenseManager

public class JiraLicenseManagerImpl
extends Object
implements JiraLicenseManager

Since:

v4.0

Constructor Summary

Constructors

Constructor and Description
JiraLicenseManagerImpl(BuildUtilsInfo buildUtilsInfo, com.atlassian.license.SIDManager sidManager, com.atlassian.event.api.EventPublisher eventPublisher, MultiLicenseStore multiLicenseStore, FeatureManager featureManager, LicenseDetailsFactory licenseDetailsFactory)

Method Summary

Methods

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	confirmProceedUnderEvaluationTerms(String userName) This will confirm that user has agreed to proceed under Evaluation terms, typically when the license is too old for the current JIRA build.
LicenseDetails	getLicense() Gets the current license details of this instance.
LicenseDetails	getLicense(String licenseString) This will decode the given string into a LicenseDetails object.
Iterable<LicenseDetails>	getLicenses() Retrieve a list of all products licenses installed in this instance.
String	getServerId() Gets the server ID of the JIRA instance, creates it if it doesn't already exists.
boolean	isDecodeable(String licenseString) This returns true if the provided licence string can be decoded into a valid licence
boolean	isLicensed(LicenseRoleId role) Returns true if the given license role is present and licensed.
LicenseDetails	setLicense(String licenseString) Sets the current license of this instance.
LicenseDetails	setLicenseNoEvent(String licenseString) Sets the current license of this instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

JiraLicenseManagerImpl

public JiraLicenseManagerImpl(BuildUtilsInfo buildUtilsInfo,
                      com.atlassian.license.SIDManager sidManager,
                      com.atlassian.event.api.EventPublisher eventPublisher,
                      MultiLicenseStore multiLicenseStore,
                      FeatureManager featureManager,
                      LicenseDetailsFactory licenseDetailsFactory)

Method Detail

getServerId

public String getServerId()

Description copied from interface: JiraLicenseManager

Gets the server ID of the JIRA instance, creates it if it doesn't already exists.

Specified by:

getServerId in interface JiraLicenseManager

Returns:

the server ID for this JIRA instance.

getLicense

public LicenseDetails getLicense()

Description copied from interface: JiraLicenseManager

Gets the current license details of this instance.

Specified by:

getLicense in interface JiraLicenseManager

Returns:

the JIRA license of this instance, or NULL_LICENSE_DETAILS if it doesn't exist.

getLicense

public LicenseDetails getLicense(String licenseString)

Description copied from interface: JiraLicenseManager

This will decode the given string into a LicenseDetails object. It is assumed that the string is valid. You will wear the consequences if it is not.

Specified by:

getLicense in interface JiraLicenseManager

Parameters:

licenseString - the license string

Returns:

the JIRA license for the given string or NULL_LICENSE_DETAILS if it is blank

getLicenses

@Nonnull
public Iterable<LicenseDetails> getLicenses()

Description copied from interface: JiraLicenseManager

Retrieve a list of all products licenses installed in this instance.

In JIRA 6.3 this method returns an iterable containing at most one license. In later versions it may contain more.

Specified by:

getLicenses in interface JiraLicenseManager

Returns:

all product licenses installed in this instance.

isLicensed

public boolean isLicensed(@Nonnull
                 LicenseRoleId role)

Description copied from interface: JiraLicenseManager

Returns true if the given license role is present and licensed.

Specified by:

isLicensed in interface JiraLicenseManager

Parameters:

role - the role

Returns:

true if the given license role is present and 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 NewLicenseEvent.

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.

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.

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

confirmProceedUnderEvaluationTerms

public void confirmProceedUnderEvaluationTerms(String userName)

Description copied from interface: JiraLicenseManager

This will confirm that user has agreed to proceed under Evaluation terms, typically when the license is too old for the current JIRA build.

Specified by:

confirmProceedUnderEvaluationTerms in interface JiraLicenseManager

Parameters:

userName - the name of the user that made the confirmation