Package org.keycloak.compatibility

Class AbstractCompatibilityMetadataProvider

java.lang.Object

org.keycloak.compatibility.AbstractCompatibilityMetadataProvider

All Implemented Interfaces:

CompatibilityMetadataProvider

Direct Known Subclasses:

CachingEmbeddedMetadataProvider, CachingRemoteMetadataProvider, JGroupsCertificatesMetadataProvider

public abstract class AbstractCompatibilityMetadataProvider
extends Object
implements CompatibilityMetadataProvider

Field Summary

Fields inherited from interface org.keycloak.compatibility.CompatibilityMetadataProvider

DEFAULT_PRIORITY

Constructor Summary

Constructors

Constructor	Description
AbstractCompatibilityMetadataProvider(String spi, String providerId)

Method Summary

Modifier and Type	Method	Description
protected Stream<String>	configKeys()
protected Map<String,String>	customMeta()
String	getId()
protected abstract boolean	isEnabled(Config.Scope scope)
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

isCompatible, priority

Constructor Details

AbstractCompatibilityMetadataProvider

public AbstractCompatibilityMetadataProvider(String spi,
 String providerId)

Method Details

isEnabled

protected abstract boolean isEnabled(Config.Scope scope)

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.

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.

customMeta

protected Map<String,String> customMeta()

configKeys

protected Stream<String> configKeys()