SBUtil (GemFire XD Java API Documentation)

java.lang.Object
- splitBrain.SBUtil

```
public class SBUtil
extends Object
```
A class to contain methods useful for all splitBrain tests. todo@lhughes - add locators to BB expectForcedDisconnects list todo@lhughes - once forcedDisconnecct received add to forcedDisconnectList

Field Summary

Fields
Modifier and Type Field and Description

static int ONEWAY

static int TWOWAY

Fields
Modifier and Type	Field and Description
`static int`	`ONEWAY`
`static int`	`TWOWAY`

Constructor Summary

Constructors
Constructor and Description

SBUtil()

Constructors
Constructor and Description
`SBUtil()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addMembershipHook(com.gemstone.gemfire.distributed.internal.membership.MembershipTestHook hook)` Install a test hook to notify test when a force disconnect has occurred.
`static void`	`beHealthy()` Cause this vm to be healthy
`static void`	`beSick()` Cause this vm to be sick
`static void`	`createLocatorTask()` Creates a (disconnected) locator.
`static void`	`dropConnection()` Drop the connection between the two test hosts (host1, host2) (machines which host the test client and locator VMs).
`static void`	`dropConnection(String src, String target)`
`static void`	`dropMultipleConnections()` Drop the multiple connection between the pairs of the hosts specified using parameter: SplitBrainPrms.hostPairsForConnectionDropRestore The parameter needs pairs of hostDescriptions with a comma separated list.
`protected static ClientVmInfo`	`getClientVmInfo(String host, int pid)`
`protected static com.gemstone.gemfire.distributed.DistributedMember`	`getCoordinator()` get the DistributedMember info for the Current Coordinator
`static com.gemstone.gemfire.distributed.DistributedMember`	`getLeadMember()` get the DistributedMember info for the Current LeadMember
`static String`	`getMyUniqueName()` Uses RemoteTestModule information to produce a name to uniquely identify a client vm (vmid, clientName, host, pid) for the calling thread
`static boolean`	`isCoordinator()` get eligibleCoordinator info and return true if the calling VM is the coordinator
`static boolean`	`isLeadMember()` get leadMember info and return true if the calling VM is the leadMember
`static void`	`killCoordinator()` Kill the current Coordinator Restriction: This must be called from a client in the same DS as the LeadMember.
`static void`	`killEligibleCoordinator()` Kill an EligibleCoordinator Restriction: This must be called from a client in the same DS as the LeadMember.
`static void`	`killLeadMember()` Kill the current Lead Member Restriction: This must be called from a client in the same DS as the LeadMember.
`static void`	`playDead()` Cause this vm to not respond to ARE_YOU_DEAD messages
`static void`	`removeMembershipHook(com.gemstone.gemfire.distributed.internal.membership.MembershipTestHook hook)` Remove a test hook installed by calling SBUtil.addMembershipHook(...).
`static void`	`restoreConnection()` Restore Connectivity between test hosts The dropType (oneWay vs.
`static void`	`restoreConnection(String src, String target)` Restore Connectivity between src and target hosts The dropType (oneWay vs.
`static void`	`restoreMultipleConnections()` Restore connectivity between multiple host pairs.
`static void`	`startAndConnectLocatorTask()` Connects a locator to its distributed system.
`static void`	`stopLocatorTask()` Stops a locator.
`protected static Object[]`	`waitForCoordChange(com.gemstone.gemfire.distributed.DistributedMember member, int msToSleep)` Given a member, wait for the coordinator member to become different than the given member.
`protected static Object[]`	`waitForLeadChange(com.gemstone.gemfire.distributed.DistributedMember member, int msToSleep)` Given a member, wait for the lead member to become different than the given member.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ONEWAY
```
public static final int ONEWAY
```
    See Also:
    
    Constant Field Values
  - TWOWAY
```
public static final int TWOWAY
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SBUtil
```
public SBUtil()
```
- Method Detail
  - createLocatorTask
```
public static void createLocatorTask()
```
    Creates a (disconnected) locator.
  - startAndConnectLocatorTask
```
public static void startAndConnectLocatorTask()
```
    Connects a locator to its distributed system.
  - stopLocatorTask
```
public static void stopLocatorTask()
```
    Stops a locator.
  - restoreConnection
```
public static void restoreConnection()
```
    Restore Connectivity between test hosts The dropType (oneWay vs. twoWay) is determined by the SplitBrainPrm dropType (which defaults to twoWay).
  - restoreConnection
```
public static void restoreConnection(String src,
                                     String target)
```
    Restore Connectivity between src and target hosts The dropType (oneWay vs. twoWay) is determined by the SplitBrainPrm dropType (which defaults to twoWay).
  - restoreMultipleConnections
```
public static void restoreMultipleConnections()
```
    Restore connectivity between multiple host pairs. (Which is dropped initially using dropMultipleConnections() method Host pairs are specified using SplitBrainPrms.hostPairsForConnectionDropRestore The parameter needs pairs of hostDescriptions with a comma separated list. E.g. hostPairsForConnectionDropRestore = hd1 hd2, hd2 hd4;
  - killEligibleCoordinator
```
public static void killEligibleCoordinator()
```
    Kill an EligibleCoordinator Restriction: This must be called from a client in the same DS as the LeadMember. For example, edge clients are not connected to a DS (they are loners), so this call will have to be made from bridgeServers in hct tests.
  - killCoordinator
```
public static void killCoordinator()
```
    Kill the current Coordinator Restriction: This must be called from a client in the same DS as the LeadMember. For example, edge clients are not connected to a DS (they are loners), so this call will have to be made from bridgeServers in hct tests.
  - killLeadMember
```
public static void killLeadMember()
```
    Kill the current Lead Member Restriction: This must be called from a client in the same DS as the LeadMember. For example, edge clients are not connected to a DS (they are loners), so this call will have to be made from bridgeServers in hct tests.
  - dropConnection
```
public static void dropConnection()
```
    Drop the connection between the two test hosts (host1, host2) (machines which host the test client and locator VMs). The dropType is determined by SplitBrainPrms.dropType (default = TWOWAY) Tests which require coordination between client VMs and the networkDrop do so through a hydra.blackboard.SharedLock (see criticalCodeSection) Currently used by splitBrain/PRNetDown.java. Tests which require time for the system to 'settle down' after a network partition (for example, to re-establish redundancy in PRs) can set SplitBrainPrms.dropWaitTimeSec to cause this task to wait for dropWaitTimeSec before returning. (defaults to 0)
  - dropConnection
```
public static void dropConnection(String src,
                                  String target)
```
  - dropMultipleConnections
```
public static void dropMultipleConnections()
```
    Drop the multiple connection between the pairs of the hosts specified using parameter: SplitBrainPrms.hostPairsForConnectionDropRestore The parameter needs pairs of hostDescriptions with a comma separated list. E.g. hostPairsForConnectionDropRestore = hd1 hd2, hd2 hd4;
  - isCoordinator
```
public static boolean isCoordinator()
```
    get eligibleCoordinator info and return true if the calling VM is the coordinator
  - getCoordinator
```
protected static com.gemstone.gemfire.distributed.DistributedMember getCoordinator()
```
    get the DistributedMember info for the Current Coordinator
  - getLeadMember
```
public static com.gemstone.gemfire.distributed.DistributedMember getLeadMember()
```
    get the DistributedMember info for the Current LeadMember
  - isLeadMember
```
public static boolean isLeadMember()
```
    get leadMember info and return true if the calling VM is the leadMember
  - getClientVmInfo
```
protected static ClientVmInfo getClientVmInfo(String host,
                                              int pid)
```
  - waitForLeadChange
```
protected static Object[] waitForLeadChange(com.gemstone.gemfire.distributed.DistributedMember member,
                                            int msToSleep)
```
    Given a member, wait for the lead member to become different than the given member.
    
    Parameters:
    
    member - A distributed member or null. This method waits until the current lead member is different than this one.
    
    msToSleep - The number of millis to sleep between checks for the lead member.
    
    return - A lead member different than member.
    
    Returns:
    
    [0] (Long) The number of millseconds it took to detect a lead change. Note that the value of msToSleep can affect this value. [1] (DistributedMember) The new DistributedMember
  - waitForCoordChange
```
protected static Object[] waitForCoordChange(com.gemstone.gemfire.distributed.DistributedMember member,
                                             int msToSleep)
```
    Given a member, wait for the coordinator member to become different than the given member.
    
    Parameters:
    
    member - A distributed member or null. This method waits until the current coordinator member is different than this one.
    
    msToSleep - The number of millis to sleep between checks for the coordinator member.
    
    Returns:
    
    [0] (Long) The number of millseconds it took to detect a coordinator change. Note that the value of msToSleep can affect this value. [1] (DistributedMember) The new DistributedMember
  - getMyUniqueName
```
public static String getMyUniqueName()
```
    Uses RemoteTestModule information to produce a name to uniquely identify a client vm (vmid, clientName, host, pid) for the calling thread
  - addMembershipHook
```
public static void addMembershipHook(com.gemstone.gemfire.distributed.internal.membership.MembershipTestHook hook)
```
    Install a test hook to notify test when a force disconnect has occurred.
  - removeMembershipHook
```
public static void removeMembershipHook(com.gemstone.gemfire.distributed.internal.membership.MembershipTestHook hook)
```
    Remove a test hook installed by calling SBUtil.addMembershipHook(...).
  - beSick
```
public static void beSick()
```
    Cause this vm to be sick
  - beHealthy
```
public static void beHealthy()
```
    Cause this vm to be healthy
  - playDead
```
public static void playDead()
```
    Cause this vm to not respond to ARE_YOU_DEAD messages

Class SBUtil

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ONEWAY

TWOWAY

Constructor Detail

SBUtil

Method Detail

createLocatorTask

startAndConnectLocatorTask

stopLocatorTask

restoreConnection

restoreConnection

restoreMultipleConnections

killEligibleCoordinator

killCoordinator

killLeadMember

dropConnection

dropConnection

dropMultipleConnections

isCoordinator

getCoordinator

getLeadMember

isLeadMember

getClientVmInfo

waitForLeadChange

waitForCoordChange

getMyUniqueName

addMembershipHook

removeMembershipHook

beSick

beHealthy

playDead