com.atlassian.jira.license
Interface JiraLicenseManager

All Known Implementing Classes:

JiraLicenseManagerImpl

public interface JiraLicenseManager

This manager is used to perform Licence releated tasks using the spanking brand new Licencing 2.0

Since:

v4.0

Method Summary

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.
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
LicenseDetails	setLicense(String license) Sets the current license of this instance.

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

LicenseDetails getLicense()

Gets the current license details of this instance.

Returns:

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

Throws:

com.atlassian.extras.common.LicenseException - if the stored license string cannot be decoded

getLicense

LicenseDetails getLicense(String licenseString)

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.

Parameters:

licenseString - the input string

Returns:

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

Throws:

com.atlassian.extras.common.LicenseException - if the stored license string cannot be decoded

isDecodeable

boolean isDecodeable(String licenseString)

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

Parameters:

licenseString - the input string

Returns:

true if it is can be decoded and false otherwise

setLicense

LicenseDetails setLicense(String license)

Sets the current license of this instance.

Returns:

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

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 amde the confirmation