Package org.keycloak.connections.infinispan

Interface InfinispanConnectionProviderFactory

All Superinterfaces:

ProviderFactory<InfinispanConnectionProvider>

All Known Implementing Classes:

DefaultInfinispanConnectionProviderFactory

public interface InfinispanConnectionProviderFactory
extends ProviderFactory<InfinispanConnectionProvider>

Author:

Stian Thorgersen

Method Summary

Modifier and Type	Method	Description
default boolean	isClusterHealthSupported()	Checks if the cluster health check is supported.
default boolean	isClusterHealthy()	Detects network split in the cluster.
default boolean	isCoordinator()	Checks if the current node is the coordinator of the JGroups cluster.
default boolean	isCoordinatorSupported()	Checks if the coordinator check is supported.

Methods inherited from interface org.keycloak.provider.ProviderFactory

close, create, dependsOn, getConfigMetadata, getId, init, order, postInit

Method Details

isClusterHealthy

default boolean isClusterHealthy()

Detects network split in the cluster.

If a possible network split is detected and this node does not belong to the winning partition, this method will return false, and should not continue handling requests, to keep data safety.

Returns:

true if the cluster is healthy and this node can continue processing requests. When false, this node must reject any work.

isClusterHealthSupported

default boolean isClusterHealthSupported()

Checks if the cluster health check is supported.

Not all JGroups configurations support discovering network splits and this method signals if the current in use configuration can detect those.

Returns:

true if the cluster health check is supported.

isCoordinator

default boolean isCoordinator()

Checks if the current node is the coordinator of the JGroups cluster.

Returns:

true if this node is the coordinator.

isCoordinatorSupported

default boolean isCoordinatorSupported()

Checks if the coordinator check is supported.

Not all configurations use an embedded cache manager with JGroups clustering, so this method signals whether isCoordinator() returns meaningful results.

Returns:

true if the coordinator check is supported.