com.atlassian.jira.bc.license

Interface JiraLicenseService

All Known Subinterfaces:

JiraLicenseUpdaterService

All Known Implementing Classes:

JiraLicenseServiceImpl

@PublicApi
public interface JiraLicenseService

A service for get license information. (readonly)

Since:

v4.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	JiraLicenseService.ValidationResult Holds the validated license and potential errors

Method Summary

Methods

Modifier and Type	Method and Description
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() Deprecated. since JIRA 6.3 - use getLicenses instead
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.
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) Validates the license String in preparation for setting the license.

Method Detail

getServerId

String getServerId()

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

Returns:

the server ID for this JIRA instance.

getLicense

@Deprecated
LicenseDetails getLicense()

Deprecated. since JIRA 6.3 - use getLicenses instead

Returns a non null LicenseDetails object that represents the current license or an instance of com.atlassian.jira.license.NullLicenseDetails if the license is not currently setup

Returns:

a non null LicenseDetails object

getLicenses

@ExperimentalApi
Iterable<LicenseDetails> getLicenses()

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.

Returns:

all product licenses installed in this instance.

Since:

6.3

validate

JiraLicenseService.ValidationResult validate(I18nHelper i18nHelper,
                                           String licenseString)

Validates the license String in preparation for setting the license. Populates the ValidationResult with errors while validating.

Parameters:

i18nHelper - the helper for i18n

licenseString - the license to validate

Returns:

a validation result with the validated license and potential errors.

confirmProceedUnderEvaluationTerms

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.

Parameters:

userName - the name of the user that made the confirmation

validate

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

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

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