Package org.keycloak.cluster

Enum Class ClusterProvider.DCNotify

java.lang.Object

java.lang.Enum<ClusterProvider.DCNotify>

org.keycloak.cluster.ClusterProvider.DCNotify

All Implemented Interfaces:

Serializable, Comparable<ClusterProvider.DCNotify>, Constable

Enclosing interface:

ClusterProvider

@Deprecated(since="26.3",
            forRemoval=true)
public static enum ClusterProvider.DCNotify
extends Enum<ClusterProvider.DCNotify>

Deprecated, for removal: This API element is subject to removal in a future version.

For removal in Keycloak 27.

This is now used only in deprecated methods. All methods that are using this enum have a Javadoc suggesting alternative.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL_BUT_LOCAL_DC	Deprecated, for removal: This API element is subject to removal in a future version. Send message to all cluster nodes in all datacenters, but NOT to this datacenter.
ALL_DCS	Deprecated, for removal: This API element is subject to removal in a future version. Send message to all cluster nodes in all DCs
LOCAL_DC_ONLY	Deprecated, for removal: This API element is subject to removal in a future version. Send message to all cluster nodes on THIS datacenter only

Method Summary

Modifier and Type	Method	Description
static ClusterProvider.DCNotify	valueOf(String name)	Deprecated, for removal: This API element is subject to removal in a future version. Returns the enum constant of this class with the specified name.
static ClusterProvider.DCNotify[]	values()	Deprecated, for removal: This API element is subject to removal in a future version. Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ALL_DCS

public static final ClusterProvider.DCNotify ALL_DCS

Deprecated, for removal: This API element is subject to removal in a future version.

Send message to all cluster nodes in all DCs

LOCAL_DC_ONLY

public static final ClusterProvider.DCNotify LOCAL_DC_ONLY

Deprecated, for removal: This API element is subject to removal in a future version.

Send message to all cluster nodes on THIS datacenter only

ALL_BUT_LOCAL_DC

public static final ClusterProvider.DCNotify ALL_BUT_LOCAL_DC

Deprecated, for removal: This API element is subject to removal in a future version.

Send message to all cluster nodes in all datacenters, but NOT to this datacenter. Option "ignoreSender" of method Object.notify() will be ignored as sender is ignored anyway due it is in this datacenter

Method Details

values

public static ClusterProvider.DCNotify[] values()

Deprecated, for removal: This API element is subject to removal in a future version.

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ClusterProvider.DCNotify valueOf(String name)

Deprecated, for removal: This API element is subject to removal in a future version.

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null