com.hazelcast.splitbrainprotection.impl

Class SplitBrainProtectionServiceImpl

java.lang.Object

com.hazelcast.splitbrainprotection.impl.SplitBrainProtectionServiceImpl

All Implemented Interfaces:

MembershipAwareService, EventPublishingService<SplitBrainProtectionEvent,SplitBrainProtectionListener>, HeartbeatAware, PingAware, SplitBrainProtectionService

public class SplitBrainProtectionServiceImpl
extends Object
implements EventPublishingService<SplitBrainProtectionEvent,SplitBrainProtectionListener>, MembershipAwareService, SplitBrainProtectionService, HeartbeatAware, PingAware

Service containing logic for cluster split brain protection.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_NAME

Constructor Summary

Constructors

Constructor and Description
SplitBrainProtectionServiceImpl(NodeEngineImpl nodeEngine)

Method Summary

Modifier and Type	Method and Description
void	addSplitBrainProtectionListener(String name, SplitBrainProtectionListener listener)
void	dispatchEvent(SplitBrainProtectionEvent event, SplitBrainProtectionListener listener) Notifies the service of a published event.
void	ensureNoSplitBrain(Operation op) Ensures that the split brain protection for the given operation is present.
void	ensureNoSplitBrain(String splitBrainProtectionName, SplitBrainProtectionOn requiredSplitBrainProtectionPermissionType) Ensures that the split brain protection with the given name is present.
SplitBrainProtection	getSplitBrainProtection(String splitBrainProtectionName) Returns the SplitBrainProtection instance for a given split brain protection name.
void	memberAdded(MembershipServiceEvent event) Invoked when a new member is added to the cluster.
void	memberAttributeChanged(MemberAttributeServiceEvent event) Invoked when a member attribute is changed.
void	memberRemoved(MembershipServiceEvent event) Invoked when an existing member leaves the cluster.
void	onHeartbeat(Member member, long timestamp) Notifies of a received heartbeat.
void	onPingLost(Member member) Notifies the SplitBrainProtectionFunction of ping loss.
void	onPingRestored(Member member) Notifies the SplitBrainProtectionFunction of a successful ping after one or more pings to that member were lost.
void	start()

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE_NAME

public static final String SERVICE_NAME

See Also:

Constant Field Values

Constructor Detail

SplitBrainProtectionServiceImpl

public SplitBrainProtectionServiceImpl(NodeEngineImpl nodeEngine)

Method Detail

start

public void start()

addSplitBrainProtectionListener

public void addSplitBrainProtectionListener(String name,
                                            SplitBrainProtectionListener listener)

ensureNoSplitBrain

public void ensureNoSplitBrain(Operation op)

Ensures that the split brain protection for the given operation is present. This requires that there is a split brain protection configured under the name which is returned by the operation service. This in turn requires that the operation is named and that the operation service is a SplitBrainProtectionAwareService.

Parameters:

op - the operation for which the minimum cluster size property should be satisfied

Throws:

SplitBrainProtectionException - if the operation requires a split brain protection and the minimum cluster size property is not satisfied

ensureNoSplitBrain

public void ensureNoSplitBrain(String splitBrainProtectionName,
                               SplitBrainProtectionOn requiredSplitBrainProtectionPermissionType)

Description copied from interface: SplitBrainProtectionService

Ensures that the split brain protection with the given name is present. Throws a SplitBrainProtectionException if split brain protection not present. Does not throw exception if splitBrainProtectionName null or split brain protection undefined. If (requiredSplitBrainProtectionPermissionType == READ) -> will check for presence of READ or READ_WRITE split brain protection
If (requiredSplitBrainProtectionPermissionType == WRITE) -> will check for presence of WRITE or READ_WRITE split brain protection
If (requiredSplitBrainProtectionPermissionType == READ_WRITE) -> will check for presence of READ_WRITE split brain protection

Specified by:

ensureNoSplitBrain in interface SplitBrainProtectionService

Parameters:

splitBrainProtectionName - split brain protection name to ensure, can be null or empty

requiredSplitBrainProtectionPermissionType - type of split brain protection required

dispatchEvent

public void dispatchEvent(SplitBrainProtectionEvent event,
                          SplitBrainProtectionListener listener)

Description copied from interface: EventPublishingService

Notifies the service of a published event.

Specified by:

dispatchEvent in interface EventPublishingService<SplitBrainProtectionEvent,SplitBrainProtectionListener>

Parameters:

event - the published event

listener - the listener registered for this event

memberAdded

public void memberAdded(MembershipServiceEvent event)

Description copied from interface: MembershipAwareService

Invoked when a new member is added to the cluster. Should be non-blocking.

Specified by:

memberAdded in interface MembershipAwareService

Parameters:

event - the event for a new member added to the cluster

memberRemoved

public void memberRemoved(MembershipServiceEvent event)

Description copied from interface: MembershipAwareService

Invoked when an existing member leaves the cluster. Should be non-blocking.

Specified by:

memberRemoved in interface MembershipAwareService

Parameters:

event - the event for an existing member leaving the cluster

memberAttributeChanged

public void memberAttributeChanged(MemberAttributeServiceEvent event)

Description copied from interface: MembershipAwareService

Invoked when a member attribute is changed.

Specified by:

memberAttributeChanged in interface MembershipAwareService

Parameters:

event - the event for a member attribute being changed

getSplitBrainProtection

public SplitBrainProtection getSplitBrainProtection(String splitBrainProtectionName)

Description copied from interface: SplitBrainProtectionService

Returns the SplitBrainProtection instance for a given split brain protection name.

Specified by:

getSplitBrainProtection in interface SplitBrainProtectionService

Parameters:

splitBrainProtectionName - name of the split brain protection

Returns:

SplitBrainProtection

onHeartbeat

public void onHeartbeat(Member member,
                        long timestamp)

Description copied from interface: HeartbeatAware

Notifies of a received heartbeat. This method is always invoked before SplitBrainProtectionFunction.apply(Collection) so the SplitBrainProtectionFunction can update its internal state before deciding on whether the minimum cluster size property (for the purpose of split brain detection) is satisfied.

Specified by:

onHeartbeat in interface HeartbeatAware

Parameters:

member - member from which heartbeat was received

timestamp - timestmap on which heartbeat was received

onPingLost

public void onPingLost(Member member)

Description copied from interface: PingAware

Notifies the SplitBrainProtectionFunction of ping loss.

Specified by:

onPingLost in interface PingAware

Parameters:

member - member which was not pinged successfully

onPingRestored

public void onPingRestored(Member member)

Description copied from interface: PingAware

Notifies the SplitBrainProtectionFunction of a successful ping after one or more pings to that member were lost.

Specified by:

onPingRestored in interface PingAware

Parameters:

member - member which was pinged successfully