com.hazelcast.config

Class SplitBrainProtectionConfig

java.lang.Object

com.hazelcast.config.SplitBrainProtectionConfig

All Implemented Interfaces:

NamedConfig, DataSerializable, IdentifiedDataSerializable

public class SplitBrainProtectionConfig
extends Object
implements IdentifiedDataSerializable, NamedConfig

Configuration for cluster split brain protection, a means to protect consistency of data from network partitions. In this context, split brain protection refers to the number of members in the cluster required for an operation to succeed.

Since Hazelcast 3.5, the default built-in split brain protection implementation keeps track of the number of members in the cluster, as determined by Hazelcast's cluster membership management.

Since Hazelcast 3.10, two additional built-in split brain protection implementations, decoupled from the existing cluster membership management, are provided:

• Probabilistic split brain protection: in this mode, member heartbeats are tracked and an adaptive failure detector determines for each member the suspicion level. Additionally, when the Hazelcast member is configured with the ICMP ping failure detector enabled and operating in parallel mode, ping information is also used to detect member failures early.

  To create a SplitBrainProtectionConfig for probabilistic split brain protection, use newProbabilisticSplitBrainProtectionConfigBuilder(String, int) to configure and build the SplitBrainProtectionConfig.

• Recently-active split brain protection: in this mode, for a member to be considered present for split brain protection, a heartbeat must be received within the configured time-window since now. Additionally, when the Hazelcast member is configured with the ICMP ping failure detector enabled and operating in parallel mode, ping information is also used to detect member failures early.

  To create a SplitBrainProtectionConfig for recently-active split brain protection, use newRecentlyActiveSplitBrainProtectionConfigBuilder(String, int, int) to configure and build the SplitBrainProtectionConfig.

See Also:

SplitBrainProtectionFunction, ProbabilisticSplitBrainProtectionFunction, RecentlyActiveSplitBrainProtectionFunction

Constructor Summary

Constructors

Constructor and Description
SplitBrainProtectionConfig()
SplitBrainProtectionConfig(SplitBrainProtectionConfig splitBrainProtectionConfig)
SplitBrainProtectionConfig(String name, boolean enabled)
SplitBrainProtectionConfig(String name, boolean enabled, int minimumClusterSize)

Method Summary

Modifier and Type	Method and Description
SplitBrainProtectionConfig	addListenerConfig(SplitBrainProtectionListenerConfig listenerConfig)
int	getClassId() Returns type identifier for this class.
int	getFactoryId() Returns DataSerializableFactory factory ID for this class.
String	getFunctionClassName()
SplitBrainProtectionFunction	getFunctionImplementation()
List<SplitBrainProtectionListenerConfig>	getListenerConfigs()
int	getMinimumClusterSize()
String	getName()
SplitBrainProtectionOn	getProtectOn()
boolean	isEnabled()
static ProbabilisticSplitBrainProtectionConfigBuilder	newProbabilisticSplitBrainProtectionConfigBuilder(String name, int minimumClusterSize) Returns a builder for SplitBrainProtectionConfig with the given name using a probabilistic split brain protection function, for the given split brain protection size that is enabled by default.
static RecentlyActiveSplitBrainProtectionConfigBuilder	newRecentlyActiveSplitBrainProtectionConfigBuilder(String name, int minimumClusterSize, int toleranceMillis) Returns a builder for a SplitBrainProtectionConfig with the given name using a recently-active split brain protection function for the given split brain protection size that is enabled by default.
void	readData(ObjectDataInput in) Reads fields from the input stream
SplitBrainProtectionConfig	setEnabled(boolean enabled)
SplitBrainProtectionConfig	setFunctionClassName(String functionClassName)
SplitBrainProtectionConfig	setFunctionImplementation(SplitBrainProtectionFunction functionImplementation)
SplitBrainProtectionConfig	setListenerConfigs(List<SplitBrainProtectionListenerConfig> listenerConfigs)
SplitBrainProtectionConfig	setMinimumClusterSize(int minimumClusterSize)
SplitBrainProtectionConfig	setName(String name)
SplitBrainProtectionConfig	setProtectOn(SplitBrainProtectionOn protectOn)
String	toString()
void	writeData(ObjectDataOutput out) Writes object fields to output stream

Methods inherited from class java.lang.Object

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

Constructor Detail

SplitBrainProtectionConfig

public SplitBrainProtectionConfig()

SplitBrainProtectionConfig

public SplitBrainProtectionConfig(String name,
                                  boolean enabled)

SplitBrainProtectionConfig

public SplitBrainProtectionConfig(String name,
                                  boolean enabled,
                                  int minimumClusterSize)

SplitBrainProtectionConfig

public SplitBrainProtectionConfig(SplitBrainProtectionConfig splitBrainProtectionConfig)

Method Detail

getName

public String getName()

Specified by:

getName in interface NamedConfig

setName

public SplitBrainProtectionConfig setName(String name)

Specified by:

setName in interface NamedConfig

isEnabled

public boolean isEnabled()

setEnabled

public SplitBrainProtectionConfig setEnabled(boolean enabled)

getMinimumClusterSize

public int getMinimumClusterSize()

setMinimumClusterSize

public SplitBrainProtectionConfig setMinimumClusterSize(int minimumClusterSize)

getProtectOn

public SplitBrainProtectionOn getProtectOn()

setProtectOn

public SplitBrainProtectionConfig setProtectOn(SplitBrainProtectionOn protectOn)

getListenerConfigs

public List<SplitBrainProtectionListenerConfig> getListenerConfigs()

setListenerConfigs

public SplitBrainProtectionConfig setListenerConfigs(List<SplitBrainProtectionListenerConfig> listenerConfigs)

addListenerConfig

public SplitBrainProtectionConfig addListenerConfig(SplitBrainProtectionListenerConfig listenerConfig)

getFunctionClassName

public String getFunctionClassName()

setFunctionClassName

public SplitBrainProtectionConfig setFunctionClassName(String functionClassName)

getFunctionImplementation

public SplitBrainProtectionFunction getFunctionImplementation()

setFunctionImplementation

public SplitBrainProtectionConfig setFunctionImplementation(SplitBrainProtectionFunction functionImplementation)

toString

public String toString()

Overrides:

toString in class Object

getFactoryId

public int getFactoryId()

Description copied from interface: IdentifiedDataSerializable

Returns DataSerializableFactory factory ID for this class.

Specified by:

getFactoryId in interface IdentifiedDataSerializable

Returns:

factory ID

getClassId

public int getClassId()

Description copied from interface: IdentifiedDataSerializable

Returns type identifier for this class. It should be unique per DataSerializableFactory.

Specified by:

getClassId in interface IdentifiedDataSerializable

Returns:

type ID

writeData

public void writeData(ObjectDataOutput out)
               throws IOException

Description copied from interface: DataSerializable

Writes object fields to output stream

Specified by:

writeData in interface DataSerializable

Parameters:

out - output

Throws:

IOException - if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

readData

public void readData(ObjectDataInput in)
              throws IOException

Description copied from interface: DataSerializable

Reads fields from the input stream

Specified by:

readData in interface DataSerializable

Parameters:

in - input

Throws:

IOException - if an I/O error occurs. In particular, an IOException may be thrown if the input stream has been closed.

newProbabilisticSplitBrainProtectionConfigBuilder

public static ProbabilisticSplitBrainProtectionConfigBuilder newProbabilisticSplitBrainProtectionConfigBuilder(String name,
                                                                                                               int minimumClusterSize)

Returns a builder for SplitBrainProtectionConfig with the given name using a probabilistic split brain protection function, for the given split brain protection size that is enabled by default.

Parameters:

name - the split brain protection's name

minimumClusterSize - minimum count of members in the cluster not to be considered it split.

See Also:

ProbabilisticSplitBrainProtectionFunction

newRecentlyActiveSplitBrainProtectionConfigBuilder

public static RecentlyActiveSplitBrainProtectionConfigBuilder newRecentlyActiveSplitBrainProtectionConfigBuilder(String name,
                                                                                                                 int minimumClusterSize,
                                                                                                                 int toleranceMillis)

Returns a builder for a SplitBrainProtectionConfig with the given name using a recently-active split brain protection function for the given split brain protection size that is enabled by default.

Parameters:

name - the split brain protection's name

minimumClusterSize - minimum count of members in the cluster not to be considered it split.

toleranceMillis - maximum amount of milliseconds that may have passed since last heartbeat was received for a member to be considered present for split brain protection.

See Also:

RecentlyActiveSplitBrainProtectionFunction