Package org.keycloak.compatibility

Class KeycloakCompatibilityMetadataProvider

java.lang.Object

org.keycloak.compatibility.KeycloakCompatibilityMetadataProvider

All Implemented Interfaces:

CompatibilityMetadataProvider

public class KeycloakCompatibilityMetadataProvider
extends Object
implements CompatibilityMetadataProvider

A CompatibilityMetadataProvider implementation to provide the Keycloak version.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ID
static final String	VERSION_KEY

Fields inherited from interface org.keycloak.compatibility.CompatibilityMetadataProvider

DEFAULT_PRIORITY

Constructor Summary

Constructors

Constructor	Description
KeycloakCompatibilityMetadataProvider()
KeycloakCompatibilityMetadataProvider(String version)

Method Summary

Modifier and Type	Method	Description
String	getId()
CompatibilityResult	isCompatible(Map<String,String> other)	It compares the current metadata with other from another deployment.
Map<String,String>	metadata()	Provides the metadata to be persisted.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.compatibility.CompatibilityMetadataProvider

priority

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

VERSION_KEY

public static final String VERSION_KEY

See Also:

• Constant Field Values

Constructor Details

KeycloakCompatibilityMetadataProvider

public KeycloakCompatibilityMetadataProvider()

KeycloakCompatibilityMetadataProvider

public KeycloakCompatibilityMetadataProvider(String version)

Method Details

metadata

public Map<String,String> metadata()

Description copied from interface: CompatibilityMetadataProvider

Provides the metadata to be persisted.

If an empty Map is returned, no information about this implementation will be persisted. A null return value is not supported, and it will interrupt the process.

Specified by:

metadata in interface CompatibilityMetadataProvider

Returns:

The metadata required by this provider to determine if a rolling update is possible.

isCompatible

public CompatibilityResult isCompatible(Map<String,String> other)

Description copied from interface: CompatibilityMetadataProvider

It compares the current metadata with other from another deployment.

The default implementation will allow a rolling update if the metadata from the current server is equal to the other. Implementations can overwrite this method as required.

Specified by:

isCompatible in interface CompatibilityMetadataProvider

Parameters:

other - The other deployment metadata. It only contains the metadata from this implementation.

Returns:

The CompatibilityResult with the outcome.

See Also:

• CompatibilityResult

getId

public String getId()

Specified by:

getId in interface CompatibilityMetadataProvider

Returns:

The ID of this implementation. It should be unique as implementation with the same ID and priority is not valid.