com.atlassian.jira.bc.license

Class JiraLicenseServiceImpl

java.lang.Object

com.atlassian.jira.bc.license.JiraLicenseServiceImpl

All Implemented Interfaces:

JiraLicenseService, JiraLicenseUpdaterService

public class JiraLicenseServiceImpl
extends Object
implements JiraLicenseUpdaterService

The implementation of JiraLicenseService

Since:

v4.0

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.jira.bc.license.JiraLicenseService

JiraLicenseService.ValidationResult

Constructor Summary

Constructors

Constructor and Description
JiraLicenseServiceImpl(JiraLicenseManager licenseManager, ClusterManager clusterManager, com.atlassian.application.api.ApplicationManager applicationManager, UserManager userManager, HelpUrls helpUrls)

Method Summary

Modifier and Type	Method and Description
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.
SortedSet<String>	getSupportEntitlementNumbers() Retrieves the SEN (Support Entitlement Number) of all installed licenses and orders them in a consistent manner.
boolean	isLicenseSet() Returns true if at least one license has been set.
void	removeLicenses(Iterable<? extends LicenseDetails> licensesToRemove) Removes provided licenses.
LicenseDetails	setLicense(JiraLicenseService.ValidationResult validationResult) Sets the license from the given ValidationResult as the current JIRA license.
LicenseDetails	setLicenseNoEvent(JiraLicenseService.ValidationResult validationResult) Sets the license from the given ValidationResult as the current JIRA license.
JiraLicenseService.ValidationResult	validate(com.atlassian.application.api.ApplicationKey applicationKey, String licenseString, I18nHelper i18nHelper) Validates a JIRA application license string in preparation for setting that string as the license for the specified application.
Iterable<JiraLicenseService.ValidationResult>	validate(I18nHelper i18nHelper) Checks that all existing licenses are valid.
Iterable<JiraLicenseService.ValidationResult>	validate(I18nHelper i18n, Iterable<String> licenses) Validates each license String provided in preparation for setting them.
JiraLicenseService.ValidationResult	validate(I18nHelper i18nHelper, String licenseString) Performs minimum validation on the license.
JiraLicenseService.ValidationResult	validateApplicationLicense(I18nHelper i18nHelper, String licenseString) Validates the passed license string against all installed JIRA applications in preparation for setting a new JIRA application license.

Methods inherited from class java.lang.Object

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

Constructor Detail

JiraLicenseServiceImpl

public JiraLicenseServiceImpl(@Nonnull
                              JiraLicenseManager licenseManager,
                              @Nonnull
                              ClusterManager clusterManager,
                              @Nonnull
                              com.atlassian.application.api.ApplicationManager applicationManager,
                              @Nonnull
                              UserManager userManager,
                              @Nonnull
                              HelpUrls helpUrls)

Method Detail

getServerId

public String getServerId()

Description copied from interface: JiraLicenseService

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

Specified by:

getServerId in interface JiraLicenseService

Returns:

the server ID for this JIRA instance.

validate

public JiraLicenseService.ValidationResult validate(@Nonnull
                                                    I18nHelper i18nHelper,
                                                    @Nonnull
                                                    String licenseString)

Description copied from interface: JiraLicenseService

Performs minimum validation on the license. But won't check if the license gives you access to applications. Populates the ValidationResult with errors while validating.

Specified by:

validate in interface JiraLicenseService

Parameters:

i18nHelper - the helper for i18n

licenseString - the license to validate

Returns:

a validation result with the validated license and potential errors.

See Also:

JiraLicenseService#validate(com.atlassian.application.api.ApplicationKey, String, com.atlassian.jira.util.I18nHelper)}.

validate

public JiraLicenseService.ValidationResult validate(@Nonnull
                                                    com.atlassian.application.api.ApplicationKey applicationKey,
                                                    @Nonnull
                                                    String licenseString,
                                                    @Nonnull
                                                    I18nHelper i18nHelper)

Description copied from interface: JiraLicenseService

Validates a JIRA application license string in preparation for setting that string as the license for the specified application. This validation does not include checking if the license provides access to the given application, and populates the returned ValidationResult with any errors.

Specified by:

validate in interface JiraLicenseService

Parameters:

applicationKey - the application key this license is for

licenseString - the license to validate

i18nHelper - the helper for i18n

Returns:

a validation result with the validated license and potential errors.

validateApplicationLicense

public JiraLicenseService.ValidationResult validateApplicationLicense(@Nonnull
                                                                      I18nHelper i18nHelper,
                                                                      @Nonnull
                                                                      String licenseString)

Description copied from interface: JiraLicenseService

Validates the passed license string against all installed JIRA applications in preparation for setting a new JIRA application license. That is, will the new license cause loss of access to any of the applications under the conditions of the current license. The returned ValidationResult will contain any errors found in the process. It is recommended that JiraLicenseService.validate(com.atlassian.application.api.ApplicationKey, java.lang.String, com.atlassian.jira.util.I18nHelper) is used instead of this method.

Specified by:

validateApplicationLicense in interface JiraLicenseService

Parameters:

i18nHelper - i18n helper used for messaging.

licenseString - the license to validate

Returns:

a validation result with the validated license and potential errors.

getSupportEntitlementNumbers

public SortedSet<String> getSupportEntitlementNumbers()

Description copied from interface: JiraLicenseService

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. Clients that used to use a single SEN can easily retrieve the first item. That will suffice in most cases, though ensure to consider the consequences of when the licenses changes.

Specified by:

getSupportEntitlementNumbers in interface JiraLicenseService

Returns:

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

See Also:

LicenseDetails.getSupportEntitlementNumber()

validate

@Nonnull
public Iterable<JiraLicenseService.ValidationResult> validate(I18nHelper i18nHelper)

Description copied from interface: JiraLicenseService

Checks that all existing licenses are valid.

Specified by:

validate in interface JiraLicenseService

Returns:

an ErrorCollection containing 0-many license validation error messages.

validate

public Iterable<JiraLicenseService.ValidationResult> validate(I18nHelper i18n,
                                                              Iterable<String> licenses)

Description copied from interface: JiraLicenseService

Validates each license String provided in preparation for setting them. Populates the resulting ValidationResults with errors while validating.

Specified by:

validate in interface JiraLicenseService

Parameters:

i18n - the helper for i18n - used to populate the error messages

licenses - the licenses to validate

Returns:

all the validation results for the validated licenses including errors

isLicenseSet

public boolean isLicenseSet()

Description copied from interface: JiraLicenseService

Returns true if at least one license has been set.

Specified by:

isLicenseSet in interface JiraLicenseService

See Also:

JiraLicenseManager.isLicenseSet()

setLicense

public LicenseDetails setLicense(JiraLicenseService.ValidationResult validationResult)

Description copied from interface: JiraLicenseUpdaterService

Sets the license from the given ValidationResult as the current JIRA license. The validation result must have no errors.

Specified by:

setLicense in interface JiraLicenseUpdaterService

Parameters:

validationResult - the validation result to get the license from.

Returns:

the new LicenseDetails created from the validated license.

setLicenseNoEvent

public LicenseDetails setLicenseNoEvent(JiraLicenseService.ValidationResult validationResult)

Description copied from interface: JiraLicenseUpdaterService

Sets the license from the given ValidationResult as the current JIRA license. The validation result must have no errors. Note that this is a special method specifically for resetting a license during Data Import which is why it will specifically not fire an Event.

Specified by:

setLicenseNoEvent in interface JiraLicenseUpdaterService

Parameters:

validationResult - the validation result to get the license from.

Returns:

the new LicenseDetails created from the validated license.

removeLicenses

public void removeLicenses(Iterable<? extends LicenseDetails> licensesToRemove)

Description copied from interface: JiraLicenseUpdaterService

Removes provided licenses. If any of the provided licenses do not exist they will be ignored.

Specified by:

removeLicenses in interface JiraLicenseUpdaterService

Parameters:

licensesToRemove - the licenses that are going to be removed.

getLicenses

@Nonnull
public Iterable<LicenseDetails> getLicenses()

Description copied from interface: JiraLicenseService

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 JiraLicenseService

Returns:

all product licenses installed in this instance.