com.atlassian.jira.bc.license

Class LicenseValidationInfo

java.lang.Object

com.atlassian.jira.bc.license.LicenseValidationInfo

All Implemented Interfaces:

LicenseValidationInformation

public class LicenseValidationInfo
extends Object
implements LicenseValidationInformation

A set of methods which describe the validation information of a specific license details of a specific ApplicationKey of the currently installed license.

Since:

v8.9

Constructor Summary

Constructors

Constructor and Description
LicenseValidationInfo(com.atlassian.sal.api.license.RawProductLicense rawProductLicense, Optional<LicenseDetails> licenseDetail)
LicenseValidationInfo(com.atlassian.sal.api.license.RawProductLicense rawProductLicense, Optional<LicenseDetails> licenseDetail, com.atlassian.sal.api.validate.LicenseValidationResult licenseValidationResult)

Method Summary

Modifier and Type	Method and Description
Optional<com.atlassian.application.api.ApplicationKey>	getApplicationKey()
Optional<LicenseDetails>	getLicenseDetail()
com.atlassian.sal.api.validate.LicenseValidationResult	getLicenseValidationResult()
boolean	isDeleteLicense()
boolean	isLicenseDetailsValid()
boolean	isLicensePairWithCorrectProductKey()
boolean	isProductKeyValid()
boolean	needMoreValidation()
LicenseValidationInfo	with(com.atlassian.sal.api.validate.LicenseValidationResult licenseValidationResult)
LicenseValidationInfo	withError(com.atlassian.sal.api.validate.LicenseErrorCode licenseErrorCode, String errorMessage)
LicenseValidationInfo	withWarning(com.atlassian.sal.api.validate.LicenseWarningCode licenseWarningCode, String warningMessage)
LicenseValidationInfo	withWarnings(Set<com.atlassian.sal.api.validate.LicenseValidationWarning> warnings)

Methods inherited from class java.lang.Object

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

Constructor Detail

LicenseValidationInfo

public LicenseValidationInfo(@Nonnull
                             com.atlassian.sal.api.license.RawProductLicense rawProductLicense,
                             @Nonnull
                             Optional<LicenseDetails> licenseDetail)

Parameters:

rawProductLicense - the productKey and license string that plan to be validated.

licenseDetail - the license detail of the RawProductLicense.getLicense()

LicenseValidationInfo

public LicenseValidationInfo(@Nonnull
                             com.atlassian.sal.api.license.RawProductLicense rawProductLicense,
                             @Nonnull
                             Optional<LicenseDetails> licenseDetail,
                             @Nonnull
                             com.atlassian.sal.api.validate.LicenseValidationResult licenseValidationResult)

Parameters:

rawProductLicense - the productKey and license string that plan to be validated.

licenseDetail - the license detail of the RawProductLicense.getLicense()

licenseValidationResult - the licenseDetail's validation result

Method Detail

getLicenseDetail

public Optional<LicenseDetails> getLicenseDetail()

Specified by:

getLicenseDetail in interface LicenseValidationInformation

Returns:

the Optional of the license detail.

getLicenseValidationResult

public com.atlassian.sal.api.validate.LicenseValidationResult getLicenseValidationResult()

Specified by:

getLicenseValidationResult in interface LicenseValidationInformation

Returns:

the license validation result

isDeleteLicense

public boolean isDeleteLicense()

Specified by:

isDeleteLicense in interface LicenseValidationInformation

Returns:

true if plan to removed LicenseValidationInformation.getLicenseDetail() out from the product, false otherwise.

getApplicationKey

public Optional<com.atlassian.application.api.ApplicationKey> getApplicationKey()

Specified by:

getApplicationKey in interface LicenseValidationInformation

Returns:

the valid application key that the license is applied to

isProductKeyValid

public boolean isProductKeyValid()

Specified by:

isProductKeyValid in interface LicenseValidationInformation

Returns:

true if the value of LicenseValidationInformation.getApplicationKey() is valid, false otherwise.

isLicenseDetailsValid

public boolean isLicenseDetailsValid()

Specified by:

isLicenseDetailsValid in interface LicenseValidationInformation

Returns:

true if the LicenseValidationInformation.getLicenseDetail() is valid, false otherwise.

isLicensePairWithCorrectProductKey

public boolean isLicensePairWithCorrectProductKey()

Specified by:

isLicensePairWithCorrectProductKey in interface LicenseValidationInformation

Returns:

true if LicenseValidationInformation.getLicenseDetail() can apply to LicenseValidationInformation.getApplicationKey(), false otherwise.

needMoreValidation

public boolean needMoreValidation()

Specified by:

needMoreValidation in interface LicenseValidationInformation

Returns:

true if the LicenseValidationInformation.getLicenseValidationResult() is valid, false when the LicenseValidationInformation.getLicenseDetail() has failed at least one validation or LicenseValidationInformation.isDeleteLicense() is true.

with

public LicenseValidationInfo with(@Nonnull
                                  com.atlassian.sal.api.validate.LicenseValidationResult licenseValidationResult)

Specified by:

with in interface LicenseValidationInformation

Returns:

a defensive copy of this LicenseValidationInformation with a giving LicenseValidationResult.

withError

public LicenseValidationInfo withError(@Nonnull
                                       com.atlassian.sal.api.validate.LicenseErrorCode licenseErrorCode,
                                       @Nonnull
                                       String errorMessage)

Specified by:

withError in interface LicenseValidationInformation

Parameters:

licenseErrorCode - the validation error code

errorMessage - the error message

Returns:

a defensive copy of this LicenseValidationInformation with error validation result

withWarning

public LicenseValidationInfo withWarning(@Nonnull
                                         com.atlassian.sal.api.validate.LicenseWarningCode licenseWarningCode,
                                         @Nonnull
                                         String warningMessage)

Specified by:

withWarning in interface LicenseValidationInformation

Parameters:

licenseWarningCode - the validation warning code

warningMessage - the warning message

Returns:

a defensive copy of this LicenseValidationInformatio with warning validation result

withWarnings

public LicenseValidationInfo withWarnings(@Nonnull
                                          Set<com.atlassian.sal.api.validate.LicenseValidationWarning> warnings)

Specified by:

withWarnings in interface LicenseValidationInformation

Parameters:

warnings - the list of warning validation results

Returns:

a defensive copy of this LicenseValidationInformatio with warning validation result