com.atlassian.sal.api.validate

Class LicenseValidationResult

java.lang.Object

com.atlassian.sal.api.validate.LicenseValidationResult

@PublicApi
public class LicenseValidationResult
extends Object

The outcome of a license validation check for each product key.

Since:

4.2

Method Summary

Modifier and Type	Method and Description
Collection<LicenseValidationError>	getErrorMessages() Returns validation error for each products.
Optional<String>	getLicense()
Optional<String>	getProductKey()
Collection<LicenseValidationWarning>	getWarningMessages() Returns validation warnings for each products.
boolean	hasErrors() Return true if the validation added error messages.
boolean	hasWarnings() Return true if the validation added warning messages.
boolean	isValid() Return true if the validation passed, false if there were errors.
static LicenseValidationResult	withErrorAndWarningMessages(Optional<String> productKey, Optional<String> license, Iterable<LicenseValidationError> errorMessages, Iterable<LicenseValidationWarning> warningMessages)
static LicenseValidationResult	withErrorMessages(Optional<String> productKey, Optional<String> license, Iterable<LicenseValidationError> errorMessages)
static LicenseValidationResult	withValidResult(Optional<String> productKey, Optional<String> license)
static LicenseValidationResult	withWarningMessages(Optional<String> productKey, Optional<String> license, Iterable<LicenseValidationWarning> warningMessages)

Methods inherited from class java.lang.Object

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

Method Detail

withErrorMessages

public static LicenseValidationResult withErrorMessages(@Nonnull
                                                        Optional<String> productKey,
                                                        @Nonnull
                                                        Optional<String> license,
                                                        @Nonnull
                                                        Iterable<LicenseValidationError> errorMessages)

withWarningMessages

public static LicenseValidationResult withWarningMessages(@Nonnull
                                                          Optional<String> productKey,
                                                          @Nonnull
                                                          Optional<String> license,
                                                          @Nonnull
                                                          Iterable<LicenseValidationWarning> warningMessages)

withErrorAndWarningMessages

public static LicenseValidationResult withErrorAndWarningMessages(@Nonnull
                                                                  Optional<String> productKey,
                                                                  @Nonnull
                                                                  Optional<String> license,
                                                                  @Nonnull
                                                                  Iterable<LicenseValidationError> errorMessages,
                                                                  @Nonnull
                                                                  Iterable<LicenseValidationWarning> warningMessages)

withValidResult

public static LicenseValidationResult withValidResult(@Nonnull
                                                      Optional<String> productKey,
                                                      @Nonnull
                                                      Optional<String> license)

getProductKey

public Optional<String> getProductKey()

Returns:

product key of this class

getLicense

public Optional<String> getLicense()

Returns:

the raw license String that gets validated. It could be valid or invalid depends on the isValid()

isValid

public boolean isValid()

Return true if the validation passed, false if there were errors. (Note warnings do not cause this method to return false).

Returns:

true if the validation passed, false if there were errors.

See Also:

hasWarnings()

hasErrors

public boolean hasErrors()

Return true if the validation added error messages.

Returns:

true if the validation failed with error messages.

hasWarnings

public boolean hasWarnings()

Return true if the validation added warning messages.

Returns:

true if the validation failed with warning messages.

getErrorMessages

@Nonnull
public Collection<LicenseValidationError> getErrorMessages()

Returns validation error for each products.

This will never be null, but may be empty.

Returns:

validation error messages, could be empty but not null.

getWarningMessages

@Nonnull
public Collection<LicenseValidationWarning> getWarningMessages()

Returns validation warnings for each products.

This will never be null, but may be empty.

Returns:

validation warning messages, could be empty but not null.