Package dev.demeng.sentinel.client.license.validation

Class ValidationResult

java.lang.Object

dev.demeng.sentinel.client.license.validation.ValidationResult

public final class ValidationResult
extends Object

The result of a license validation request.

Check isValid() to determine whether the license is valid. On success, getDetails() provides the license details. On failure, getType() and getMessage() describe the reason, and getFailureDetails() may provide additional context for certain failure types.

Alternatively, use requireValid() to throw a LicenseValidationException if the license is not valid.

Method Summary

Modifier and Type	Method	Description
static ValidationResult	failure(ValidationResultType type, String message)	Creates a failed validation result with no additional failure details.
static ValidationResult	failure(ValidationResultType type, String message, @Nullable FailureDetails failureDetails)	Creates a failed validation result with additional failure details.
@Nullable ValidationDetails	getDetails()	Returns the license details if the validation was successful, or null on failure.
@Nullable FailureDetails	getFailureDetails()	Returns additional details about the failure, or null if unavailable.
String	getMessage()	Returns the message from the API response.
ValidationResultType	getType()	Returns the validation result type.
boolean	isValid()	Returns true if the license is valid.
ValidationDetails	requireValid()	Returns the license details if valid, or throws a LicenseValidationException if the license failed validation.
static ValidationResult	success(ValidationDetails details, String message)	Creates a successful validation result.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

success

public static ValidationResult success(ValidationDetails details,
 String message)

Creates a successful validation result.

Parameters:

details - the license details

message - the API response message

Returns:

a successful result

failure

public static ValidationResult failure(ValidationResultType type,
 String message)

Creates a failed validation result with no additional failure details.

Parameters:

type - the failure type

message - the API response message

Returns:

a failed result

failure

public static ValidationResult failure(ValidationResultType type,
 String message,
 @Nullable FailureDetails failureDetails)

Creates a failed validation result with additional failure details.

Parameters:

type - the failure type

message - the API response message

failureDetails - additional context about the failure, or null

Returns:

a failed result

isValid

public boolean isValid()

Returns true if the license is valid.

Returns:

whether the license passed validation

getType

public ValidationResultType getType()

Returns the validation result type.

Returns:

the result type (e.g. ValidationResultType.SUCCESS, ValidationResultType.EXPIRED_LICENSE)

getMessage

public String getMessage()

Returns the message from the API response.

Returns:

the response message

getDetails

public @Nullable ValidationDetails getDetails()

Returns the license details if the validation was successful, or null on failure.

Returns:

the license details, or null

getFailureDetails

public @Nullable FailureDetails getFailureDetails()

Returns additional details about the failure, or null if unavailable. Only populated for certain failure types such as ValidationResultType.BLACKLISTED_LICENSE, ValidationResultType.EXCESSIVE_SERVERS, and ValidationResultType.EXCESSIVE_IPS.

Returns:

the failure details, or null

requireValid

public ValidationDetails requireValid()
                               throws LicenseValidationException

Returns the license details if valid, or throws a LicenseValidationException if the license failed validation.

Returns:

the license details

Throws:

LicenseValidationException - if the license is not valid

toString

public String toString()

Overrides:

toString in class Object