MLRioTest (GemFire XD Java API Documentation)

java.lang.Object
- util.OperationsClient
- - splitBrain.MLRioTest

```
public class MLRioTest
extends OperationsClient
```
ML Rio Use Case (SplitBrainTestSpec: 10.3.10)

Since:

5.5

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`isNewWanConfig`
`protected static int`	`ITERATIONS`
`protected int`	`numDynamicRegions`
`protected int`	`numRootRegions`
`protected RandomValues`	`randomValues`
`protected static MLRioTest`	`testInstance`

Constructor Summary

Constructors
Constructor and Description

MLRioTest()

Constructors
Constructor and Description
`MLRioTest()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`closeCacheAndDisconnectFromDS()` Close the cache (and disconnect from the DS) This should prevent the ShutdownException: no down protocol available! during Shutdown (if locators (client vms) are shut down prior to application client vms
`protected void`	`createAndStartNewWanComponents()`
`protected com.gemstone.gemfire.cache.Region`	`createDynamicRegion(String parentName, String drName)` Creates a dynamic region (from dynamicReg/DynamicRegionTest.java)
`protected void`	`createDynamicRegions()`
`protected void`	`createGatewayHub()`
`protected void`	`doEntryOperations()`
`protected void`	`forceDisconnect()`
`protected double`	`getConflatedEventCount()`
`protected com.gemstone.gemfire.cache.Region`	`getRandomRegion(boolean allowRootRegion)` Selects random region (copied from dynamicReg/DynamicRegionTest.java)
`protected com.gemstone.gemfire.cache.Region`	`getRandomRootRegion()` Selects and returns a random rootRegion
`protected void`	`healthController()`
`static void`	`HydraCloseTask_validateKeysInRegion()` This validation task does not do any coordination between the publishing/forcedDisconnect or validation.
`static void`	`HydraEndTask_verifyConflation()`
`static void`	`HydraTask_createAndStartNewWanComponents()` Creates start new wan components i.e senders based on `ConfigPrms.gatewaySenderConfig` and receivers based on `ConfigPrms.gatewayReceiverConfig`.
`static void`	`HydraTask_createDynamicRegions()` Create MLRioBB.numDynamicRegions (execute once in each WAN Site) after servers and clients have been initialized (with non-dynamic parent regions).
`static void`	`HydraTask_createGatewaySenderIds()` Creates GatewaySender ids based on the `ConfigPrms.gatewaySenderConfig`.
`static void`	`HydraTask_doEntryOperations()` Performs puts/gets on entries in TestRegion
`static void`	`HydraTask_forceDisconnect()` Cause a server to beSick/playDead (but don't synchronize with bridgeClient operations (use healthController for coordination with validation).
`static void`	`HydraTask_healthController()` Cause a server to beSick/playDead.
`static void`	`HydraTask_initializeBridgeClient()` Setup DynamicRegionFactory and create non-dynamic parent regions
`static void`	`HydraTask_initializeBridgeServer()`
`static void`	`HydraTask_networkController()` Cause a network split between the primary and secondary gateway (servers) in WAN Site #1.
`static void`	`HydraTask_putSequentialKeys()` Performs ITERATIONS puts on a unique entry in TestRegion Each assignment of this task gets a new key from the NameFactory, and then updates that key with sequential values from 1 -> ITERATIONS.
`static void`	`HydraTask_startGatewayHubTask()` Add Gateways and start the GatewayHub Note: This must be done after all servers have been initialized (and invoked createGatewayHub(), so the hydra WAN blackboard knows about all the available servers and endpoints.
`static void`	`HydraTask_waitForDynamicRegions()` Create MLRioBB.numDynamicRegions (execute once in each WAN Site) after servers and clients have been initialized (with non-dynamic parent regions).
`void`	`initCacheWithXml(String cacheConfig, String regionConfig, String poolConfig)` Initialize using XML based on the given cache and region configurations.
`protected void`	`initializeBridgeClient()`
`protected void`	`initializeBridgeServer()`
`protected void`	`networkController()`
`protected void`	`putSequentialKeys()`
`protected void`	`startGatewayHub(String gatewayConfig)` Starts a gateway hub in a VM that previously created one, after creating gateways.
`protected void`	`validateKeysInRegion()`
`protected void`	`validateRegion(com.gemstone.gemfire.cache.Region aRegion, boolean verifyModVal)`
`protected void`	`validateSequentialKeys()` This validation method coordinates client operations/validation with the healthController (forcedDisconnect of bridge/gateway).
`protected void`	`verifyConflation()`

Methods inherited from class util.OperationsClient
addEntry, createLocatorTask, destroyEntry, doEntryOperations, getExistingKey, getExistingKeys, getKey, getNewKey, getNewKey, getOperation, getRecentKey, getUpdateObject, getValueForKey, initializeOperationsClient, invalidateEntry, putAll, putIfAbsent, remove, remove, replace, replace, startAndConnectLocatorTask, stopLocatorTask, updateEntry

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

- Field Detail
  - ITERATIONS
```
protected static final int ITERATIONS
```
    See Also:
    
    Constant Field Values
  - testInstance
```
protected static MLRioTest testInstance
```
  - randomValues
```
protected RandomValues randomValues
```
  - numRootRegions
```
protected int numRootRegions
```
  - numDynamicRegions
```
protected int numDynamicRegions
```
  - isNewWanConfig
```
protected boolean isNewWanConfig
```
- Constructor Detail
  - MLRioTest
```
public MLRioTest()
```
- Method Detail
  - HydraTask_initializeBridgeServer
```
public static void HydraTask_initializeBridgeServer()
```
  - initializeBridgeServer
```
protected void initializeBridgeServer()
```
  - HydraTask_startGatewayHubTask
```
public static void HydraTask_startGatewayHubTask()
```
    Add Gateways and start the GatewayHub Note: This must be done after all servers have been initialized (and invoked createGatewayHub(), so the hydra WAN blackboard knows about all the available servers and endpoints.
  - startGatewayHub
```
protected void startGatewayHub(String gatewayConfig)
```
    Starts a gateway hub in a VM that previously created one, after creating gateways.
  - HydraTask_createGatewaySenderIds
```
public static void HydraTask_createGatewaySenderIds()
```
    Creates GatewaySender ids based on the ConfigPrms.gatewaySenderConfig.
  - HydraTask_createAndStartNewWanComponents
```
public static void HydraTask_createAndStartNewWanComponents()
```
    Creates start new wan components i.e senders based on ConfigPrms.gatewaySenderConfig and receivers based on ConfigPrms.gatewayReceiverConfig.
  - createAndStartNewWanComponents
```
protected void createAndStartNewWanComponents()
```
  - HydraTask_initializeBridgeClient
```
public static void HydraTask_initializeBridgeClient()
```
    Setup DynamicRegionFactory and create non-dynamic parent regions
  - initializeBridgeClient
```
protected void initializeBridgeClient()
```
  - HydraTask_createDynamicRegions
```
public static void HydraTask_createDynamicRegions()
```
    Create MLRioBB.numDynamicRegions (execute once in each WAN Site) after servers and clients have been initialized (with non-dynamic parent regions).
  - createDynamicRegions
```
protected void createDynamicRegions()
```
  - HydraTask_waitForDynamicRegions
```
public static void HydraTask_waitForDynamicRegions()
```
    Create MLRioBB.numDynamicRegions (execute once in each WAN Site) after servers and clients have been initialized (with non-dynamic parent regions).
  - initCacheWithXml
```
public void initCacheWithXml(String cacheConfig,
                             String regionConfig,
                             String poolConfig)
```
    Initialize using XML based on the given cache and region configurations.
  - createGatewayHub
```
protected void createGatewayHub()
```
  - HydraTask_forceDisconnect
```
public static void HydraTask_forceDisconnect()
```
    Cause a server to beSick/playDead (but don't synchronize with bridgeClient operations (use healthController for coordination with validation). Once the forced disconnect has completed, (and validation completed), re-initialize the cache and restart the Bridge/GatewayHub.
  - forceDisconnect
```
protected void forceDisconnect()
```
  - HydraTask_healthController
```
public static void HydraTask_healthController()
```
    Cause a server to beSick/playDead. Once the forced disconnect has completed, (and validation completed), re-initialize the cache and restart the Bridge/GatewayHub.
  - healthController
```
protected void healthController()
```
  - HydraTask_networkController
```
public static void HydraTask_networkController()
```
    Cause a network split between the primary and secondary gateway (servers) in WAN Site #1. After network partition causes ForcedDisconnects, recycle disconnected Gatweay/server re-initialize the cache and restart the Bridge/GatewayHub. The networkController operations are coordinated with putSequentialKeys via the MLRioBB.healthControllerComplete SharedLock.SharedCondition.
  - networkController
```
protected void networkController()
```
  - HydraTask_putSequentialKeys
```
public static void HydraTask_putSequentialKeys()
```
    Performs ITERATIONS puts on a unique entry in TestRegion Each assignment of this task gets a new key from the NameFactory, and then updates that key with sequential values from 1 -> ITERATIONS. This allows the client listeners to verify incremental updates on the key and for a final CLOSETASK validator to verify that all clients have all keys with the correct ending value (ITERATIONS).
  - putSequentialKeys
```
protected void putSequentialKeys()
```
  - HydraTask_doEntryOperations
```
public static void HydraTask_doEntryOperations()
```
    Performs puts/gets on entries in TestRegion
  - doEntryOperations
```
protected void doEntryOperations()
```
  - closeCacheAndDisconnectFromDS
```
public static void closeCacheAndDisconnectFromDS()
```
    Close the cache (and disconnect from the DS) This should prevent the ShutdownException: no down protocol available! during Shutdown (if locators (client vms) are shut down prior to application client vms
  - validateSequentialKeys
```
protected void validateSequentialKeys()
```
    This validation method coordinates client operations/validation with the healthController (forcedDisconnect of bridge/gateway). Called directly from putSequentialKeys task which coordinates publishing, forcedDisconnect of server (healthController) and validation by pausing and waiting for activities to sync up. Use validateKeysInRegion for concurrent (non-pausing) tests which use doEntryOperations() on randomKeys vs. putSequentialKeys/Values.
  - HydraCloseTask_validateKeysInRegion
```
public static void HydraCloseTask_validateKeysInRegion()
```
    This validation task does not do any coordination between the publishing/forcedDisconnect or validation. It should be used as a one time call at the end of the test (as a CLOSETASK). Verifies the region has the same keySet as the server region and that ValueHolder.myValue is correct for each key. concurrent (non-pausing) tests should use HydraCloseTask_validateKeysInRegion().
  - validateKeysInRegion
```
protected void validateKeysInRegion()
```
  - validateRegion
```
protected void validateRegion(com.gemstone.gemfire.cache.Region aRegion,
                              boolean verifyModVal)
```
  - getRandomRegion
```
protected com.gemstone.gemfire.cache.Region getRandomRegion(boolean allowRootRegion)
```
    Selects random region (copied from dynamicReg/DynamicRegionTest.java)
  - createDynamicRegion
```
protected com.gemstone.gemfire.cache.Region createDynamicRegion(String parentName,
                                                                String drName)
```
    Creates a dynamic region (from dynamicReg/DynamicRegionTest.java)
  - getRandomRootRegion
```
protected com.gemstone.gemfire.cache.Region getRandomRootRegion()
```
    Selects and returns a random rootRegion
  - HydraEndTask_verifyConflation
```
public static void HydraEndTask_verifyConflation()
```
  - verifyConflation
```
protected void verifyConflation()
```
  - getConflatedEventCount
```
protected double getConflatedEventCount()
```

Class MLRioTest

Field Summary

Fields inherited from class util.OperationsClient

Constructor Summary

Method Summary

Methods inherited from class util.OperationsClient

Methods inherited from class java.lang.Object

Field Detail

ITERATIONS

testInstance

randomValues

numRootRegions

numDynamicRegions

isNewWanConfig

Constructor Detail

MLRioTest

Method Detail

HydraTask_initializeBridgeServer

initializeBridgeServer

HydraTask_startGatewayHubTask

startGatewayHub

HydraTask_createGatewaySenderIds

HydraTask_createAndStartNewWanComponents

createAndStartNewWanComponents

HydraTask_initializeBridgeClient

initializeBridgeClient

HydraTask_createDynamicRegions

createDynamicRegions

HydraTask_waitForDynamicRegions

initCacheWithXml

createGatewayHub

HydraTask_forceDisconnect

forceDisconnect

HydraTask_healthController

healthController

HydraTask_networkController

networkController

HydraTask_putSequentialKeys

putSequentialKeys

HydraTask_doEntryOperations

doEntryOperations

closeCacheAndDisconnectFromDS

validateSequentialKeys

HydraCloseTask_validateKeysInRegion

validateKeysInRegion

validateRegion

getRandomRegion

createDynamicRegion

getRandomRootRegion

HydraEndTask_verifyConflation

verifyConflation

getConflatedEventCount