Package org.keycloak.compatibility

Interface CompatibilityResult

public interface CompatibilityResult

The result of CompatibilityMetadataProvider.isCompatible(Map).

It is composed by the exit code (to help building scripts around this tool as it is easier than parsing logs), and an optional error message.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	CompatibilityResult.ExitCode

Method Summary

Modifier and Type	Method	Description
default Optional<String>	endMessage()
default Optional<String>	errorMessage()
int	exitCode()
static CompatibilityResult	incompatibleAttribute(String providerId, String attribute, String previousValue, String currentValue)
default Optional<Set<String>>	incompatibleAttributes()
static CompatibilityResult	providerCompatible(String providerId)

Method Details

exitCode

int exitCode()

Returns:

The exit code to use to signal the compatibility result.

errorMessage

default Optional<String> errorMessage()

Returns:

An optional error message explaining what caused the incompatibility.

endMessage

default Optional<String> endMessage()

Returns:

An optional message after the check is finished.

incompatibleAttributes

default Optional<Set<String>> incompatibleAttributes()

providerCompatible

static CompatibilityResult providerCompatible(String providerId)

incompatibleAttribute

static CompatibilityResult incompatibleAttribute(String providerId,
 String attribute,
 String previousValue,
 String currentValue)