WANTest (GemFire XD Java API Documentation)

java.lang.Object
- newWan.WANTest

Direct Known Subclasses:

DynamicDiscoveryTest, WanConflictResolverTest, WanSecurity
```
public class WANTest
extends Object
```
Supports tests for WAN distribution.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static Set<com.gemstone.gemfire.cache.wan.GatewaySender>`	`gatewaySenders`
`static WANTest`	`instance`
`protected boolean`	`isBridgeClient`
`protected boolean`	`isBridgeConfiguration`
`protected AtomicBoolean`	`isQueuePrinting`
`protected static int`	`ITERATIONS`
`static com.gemstone.gemfire.LogWriter`	`logger`
`protected static long`	`maxOperations`
`protected static WANOperationsClient`	`opsClient`
`static GsRandom`	`rand`
`protected static List<String>`	`regionDescriptNames`
`protected static List<String>`	`regionNames`
`static RandomValues`	`rv`
`static MethodCoordinator`	`updateRegionSnapshot`

Constructor Summary

Constructors
Constructor and Description

WANTest()

Constructors
Constructor and Description
`WANTest()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`closeEdgeClientCacheTask()` Closes an edge cache.
`static void`	`createGatewaySenderIdsTask()` Creates GatewaySender ids based on the `ConfigPrms.gatewaySenderConfig`.
`static void`	`createLocatorTask()` Creates a (disconnected) locator.
`protected void`	`doEntryOperationAllRegions()`
`static void`	`doEntryOperationTask()`
`static void`	`doHAEntryOperationTask()`
`static void`	`doHASenderOperationAndVerifyTask()`
`static void`	`doSenderOperationTask()`
`static String`	`generateAllRemoteDSNameLists(String prefix, int n, int m)` Generates comma-separated lists of remote distributed system names.
`static String`	`generateDoubleSuffixedNames(String prefix, int n, int m, int start_n, int start_m, boolean varyFirst, boolean useComma)` Generates a list of strings with the specified prefix and suffixed x_y, where x varies start_n,...,n and y varies start_m,...,m, and x varies first if varyFirst is true, else y.
`static String`	`generateRandomRemoteDSName(String prefix, int n, int m)` Generates comma-separated lists of remote distributed system names in random topology.
`static String`	`generateRingRemoteDSName(String prefix, int n, int m)` Generates comma-separated lists of remote distributed system names in random topology.
`QueryObject`	`getQueryObjectForCounter(long key)` Return a value for the given key
`static void`	`HydraTask_initPeerTask()`
`static void`	`HydraTask_initServerTask()`
`static void`	`HydraTask_initWANComponentsTask()`
`static void`	`HydraTask_pauseSenders()` Task to pause all senders in vm
`static void`	`HydraTask_resumeSenders()` Task to resume all senders in vm
`static void`	`HydraTask_stopWANComponents()`
`static void`	`HydraTask_verifyQueueEviction()`
`static void`	`initAccessorRegionTask()`
`void`	`initCQClient()`
`static void`	`initCQClientTask()` Initializes an edge CQ client based on the `CacheClientPrms`.
`void`	`initDatastoreRegion()`
`void`	`initEdgeClientCache()`
`static void`	`initEdgeClientCacheTask()` Initializes a edge cache based on the `CacheClientPrms`.
`void`	`initGatewayReceiver()`
`static void`	`initGatewayReceiverTask()` Initializes GatewayReceiver based on the `WANTestPrms#GatewayReceiverConfig`.
`void`	`initGatewaySender()`
`static void`	`initGatewaySenderTask()` Initializes GatewaySender based on the `ConfigPrms.gatewaySenderConfig`.
`static void`	`initializeClient()`
`static void`	`initializeDatastore()`
`static void`	`initializeLocator()`
`void`	`initPeerCache()`
`static void`	`initPeerCacheTask()` Initializes a peer cache based on the `ConfigPrms.cacheConfig`.
`static void`	`initPeerRegionTask()`
`static void`	`initServerCacheTask()` Initializes a server cache based on the `ConfigPrms.cacheConfig`.
`static void`	`initServerRegionTask()`
`void`	`killAndVerifyLocators()`
`static void`	`killAndVerifyLocatorsTask()`
`static void`	`killClient()` Kill the clients
`void`	`killPeerAndDoNonCoordinatedOps()`
`static void`	`killPeerAndDoNonCoordinatedOpsTask()` kill other peer and simultaneously do entry operations.
`void`	`killPeerAndDoOps()`
`static void`	`killPeerAndDoOpsTask()` kill other peer and simultaneously do entry operations.
`static void`	`mentionReferenceInBlackboard()` Mention the reference vm in the blackboard
`static void`	`printDistributionLocatorMapTask()`
`void`	`printQueueContents()`
`static void`	`printQueueContentsTask()` Prints the contents of the local queue.
`void`	`printRegionQueue(com.gemstone.gemfire.cache.Region region, Set rq)`
`void`	`printSequentialKeys(com.gemstone.gemfire.cache.Region region)`
`static void`	`printSequentialKeysTask()` Prints the contents of the local cache.
`void`	`putSequentialKeys(com.gemstone.gemfire.cache.Region region)`
`void`	`putSequentialKeysAndHA()`
`static void`	`putSequentialKeysAndHATask()` Puts integers into the cache with a globally increasing shared counter as the key.
`void`	`putSequentialKeysCQ(com.gemstone.gemfire.cache.Region region)`
`static void`	`putSequentialKeysCQTask()` Puts integers into the cache with a globally increasing shared counter as the key.
`static void`	`putSequentialKeysTask()` Puts integers into the cache with a globally increasing shared counter as the key.
`void`	`putSequentialKeyUsingPutAll(com.gemstone.gemfire.cache.Region region, int sleepMs)`
`void`	`restartMembers()`
`static void`	`restartMembersTask()`
`static void`	`restartVerifyLocatorsTask()`
`static void`	`starAndVerifytLocatorAdminDSTask()` Connects a locator to its (admin-only) distributed system.
`static void`	`startAndConnectAndVerifyLocatorTask()` Connects a locator to its (admin-only) distributed system.
`static void`	`startAndConnectLocatorTask()` Connects a locator to its (non-admin) distributed system.
`void`	`startGatewaySender()`
`static void`	`startGatewaySenderTask()`
`static void`	`startLocatorAndAdminDSTask()` Connects a locator to its (admin-only) distributed system.
`void`	`startResumeSenders()`
`static void`	`startResumeSenderTask()`
`static void`	`stopGatewayReceiverTask()`
`static void`	`stopGatewaySenderTask()`
`static void`	`stopLocatorTask()` Stops a locator.
`static void`	`updateRegionSnapshotTask()`
`static void`	`validateDoEntryOperationTask()` Validates the contents of the local cache after running doEntryOperationTask task
`static void`	`validateDoEntryOperationTxTask()` Validates the contents of the local cache after running doEntryOperationTask task
`protected void`	`validateDoEntryOperationUniqueKeys()`
`protected void`	`validateDoEntryOperationUniqueKeysTransactions()`
`static void`	`validateEventsReceived()` Validate the events received by the clients with the reference Vm
`void`	`validateRegion(com.gemstone.gemfire.cache.Region aRegion)`
`void`	`validateSequentialKeysCQ(com.gemstone.gemfire.cache.Region region)`
`static void`	`validateSequentialKeysCQTask()` Validates the CQEvent counters and SelectResults against expected contents of server region
`protected void`	`validateSequentialKeysInRegion()`
`static void`	`validateSequentialKeysTask()` Validates the contents of the local cache.
`void`	`verifyLocators()`
`static void`	`verifyLocatorsTask()`
`protected void`	`verifyQueueEviction()`
`static void`	`verifySenderOperationTask()`
`static void`	`waitForListenerSilence()` Task to wait for the listener silence before doing validation tasks.
`protected void`	`waitForLocatorDiscovery()`
`void`	`waitForQueuesToDrain()` Waits `WANTestPrms.secToWaitForQueue` for queues to drain.
`static void`	`waitForQueuesToDrainTask()`
`void`	`waitForRecovery(List startupRecoveryVms, List departedRecoveryVMs)`
`static void`	`waitTask()`

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
```

maxOperations

protected static final long maxOperations

regionDescriptNames

protected static List<String> regionDescriptNames

regionNames

protected static List<String> regionNames

isBridgeConfiguration

protected boolean isBridgeConfiguration

isBridgeClient
```
protected boolean isBridgeClient
```

instance
```
public static WANTest instance
```

opsClient

protected static WANOperationsClient opsClient

updateRegionSnapshot

public static volatile MethodCoordinator updateRegionSnapshot

logger

public static com.gemstone.gemfire.LogWriter logger

rand
```
public static GsRandom rand
```

rv
```
public static RandomValues rv
```

gatewaySenders

protected static Set<com.gemstone.gemfire.cache.wan.GatewaySender> gatewaySenders

isQueuePrinting

protected AtomicBoolean isQueuePrinting

Constructor Detail
- WANTest
```
public WANTest()
```

Method Detail

initializeLocator

public static void initializeLocator()

initializeDatastore

public static void initializeDatastore()

initializeClient
```
public static void initializeClient()
```

createLocatorTask
```
public static void createLocatorTask()
```
Creates a (disconnected) locator.

startAndConnectLocatorTask
```
public static void startAndConnectLocatorTask()
```
Connects a locator to its (non-admin) distributed system.

startAndConnectAndVerifyLocatorTask
```
public static void startAndConnectAndVerifyLocatorTask()
```
Connects a locator to its (admin-only) distributed system.

waitForLocatorDiscovery

protected void waitForLocatorDiscovery()

startLocatorAndAdminDSTask
```
public static void startLocatorAndAdminDSTask()
```
Connects a locator to its (admin-only) distributed system.

starAndVerifytLocatorAdminDSTask
```
public static void starAndVerifytLocatorAdminDSTask()
```
Connects a locator to its (admin-only) distributed system.

stopLocatorTask
```
public static void stopLocatorTask()
```
Stops a locator.

initPeerCacheTask
```
public static void initPeerCacheTask()
```
Initializes a peer cache based on the ConfigPrms.cacheConfig.

initPeerCache
```
public void initPeerCache()
```

initServerCacheTask
```
public static void initServerCacheTask()
```
Initializes a server cache based on the ConfigPrms.cacheConfig.

initPeerRegionTask

public static void initPeerRegionTask()

initDatastoreRegion
```
public void initDatastoreRegion()
```

initAccessorRegionTask

public static void initAccessorRegionTask()

initServerRegionTask

public static void initServerRegionTask()

initEdgeClientCacheTask
```
public static void initEdgeClientCacheTask()
```
Initializes a edge cache based on the CacheClientPrms.

initEdgeClientCache
```
public void initEdgeClientCache()
```

initCQClientTask
```
public static void initCQClientTask()
```
Initializes an edge CQ client based on the CacheClientPrms.

initCQClient
```
public void initCQClient()
```

createGatewaySenderIdsTask
```
public static void createGatewaySenderIdsTask()
```
Creates GatewaySender ids based on the ConfigPrms.gatewaySenderConfig.

initGatewaySenderTask
```
public static void initGatewaySenderTask()
```
Initializes GatewaySender based on the ConfigPrms.gatewaySenderConfig.

initGatewaySender
```
public void initGatewaySender()
```

startGatewaySenderTask

public static void startGatewaySenderTask()

startGatewaySender
```
public void startGatewaySender()
```

HydraTask_stopWANComponents

public static void HydraTask_stopWANComponents()

stopGatewaySenderTask

public static void stopGatewaySenderTask()

stopGatewayReceiverTask

public static void stopGatewayReceiverTask()

initGatewayReceiverTask
```
public static void initGatewayReceiverTask()
```
Initializes GatewayReceiver based on the WANTestPrms#GatewayReceiverConfig.

initGatewayReceiver
```
public void initGatewayReceiver()
```

HydraTask_initPeerTask

public static void HydraTask_initPeerTask()

HydraTask_initServerTask

public static void HydraTask_initServerTask()

HydraTask_initWANComponentsTask

public static void HydraTask_initWANComponentsTask()

closeEdgeClientCacheTask

public static void closeEdgeClientCacheTask()

Closes an edge cache.

validateSequentialKeysTask
```
public static void validateSequentialKeysTask()
```
Validates the contents of the local cache.

validateSequentialKeysInRegion

protected void validateSequentialKeysInRegion()

validateRegion

public void validateRegion(com.gemstone.gemfire.cache.Region aRegion)

validateSequentialKeysCQTask
```
public static void validateSequentialKeysCQTask()
                                         throws Exception
```
Validates the CQEvent counters and SelectResults against expected contents of server region

Throws:

Exception

validateSequentialKeysCQ

public void validateSequentialKeysCQ(com.gemstone.gemfire.cache.Region region)

HydraTask_verifyQueueEviction

public static void HydraTask_verifyQueueEviction()

HydraTask_pauseSenders
```
public static void HydraTask_pauseSenders()
```
Task to pause all senders in vm

HydraTask_resumeSenders
```
public static void HydraTask_resumeSenders()
```
Task to resume all senders in vm

verifyQueueEviction
```
protected void verifyQueueEviction()
```

printQueueContentsTask

public static void printQueueContentsTask()
                                   throws Exception

Prints the contents of the local queue.

Throws:: Exception

printQueueContents
```
public void printQueueContents()
```

printRegionQueue

public void printRegionQueue(com.gemstone.gemfire.cache.Region region,
                             Set rq)

waitForQueuesToDrainTask

public static void waitForQueuesToDrainTask()

waitForQueuesToDrain
```
public void waitForQueuesToDrain()
```
Waits WANTestPrms.secToWaitForQueue for queues to drain. Suitable for use as a helper method or hydra task.

waitForListenerSilence
```
public static void waitForListenerSilence()
```
Task to wait for the listener silence before doing validation tasks.

printSequentialKeysTask

public static void printSequentialKeysTask()
                                    throws Exception

Prints the contents of the local cache.

Throws:: Exception

printSequentialKeys

public void printSequentialKeys(com.gemstone.gemfire.cache.Region region)
                         throws Exception

Throws:: Exception

doHAEntryOperationTask

public static void doHAEntryOperationTask()

doEntryOperationTask

public static void doEntryOperationTask()

doEntryOperationAllRegions

protected void doEntryOperationAllRegions()

validateDoEntryOperationTask
```
public static void validateDoEntryOperationTask()
```
Validates the contents of the local cache after running doEntryOperationTask task

validateDoEntryOperationUniqueKeys

protected void validateDoEntryOperationUniqueKeys()

updateRegionSnapshotTask

public static void updateRegionSnapshotTask()

validateDoEntryOperationTxTask
```
public static void validateDoEntryOperationTxTask()
```
Validates the contents of the local cache after running doEntryOperationTask task

validateDoEntryOperationUniqueKeysTransactions

protected void validateDoEntryOperationUniqueKeysTransactions()

putSequentialKeysTask
```
public static void putSequentialKeysTask()
                                  throws Exception
```
Puts integers into the cache with a globally increasing shared counter as the key. Does 1000 updates on each key.

Throws:

Exception

putSequentialKeys

public void putSequentialKeys(com.gemstone.gemfire.cache.Region region)
                       throws Exception

Throws:: Exception

putSequentialKeysAndHATask
```
public static void putSequentialKeysAndHATask()
                                       throws Exception
```
Puts integers into the cache with a globally increasing shared counter as the key. Does 1000 updates on each key.

Throws:

Exception

putSequentialKeysAndHA

public void putSequentialKeysAndHA()
                            throws Exception

Throws:: Exception

putSequentialKeysCQTask
```
public static void putSequentialKeysCQTask()
                                    throws Exception
```
Puts integers into the cache with a globally increasing shared counter as the key. Does 1000 updates on each key.

Throws:

Exception

putSequentialKeysCQ

public void putSequentialKeysCQ(com.gemstone.gemfire.cache.Region region)
                         throws Exception

Throws:: Exception

mentionReferenceInBlackboard
```
public static void mentionReferenceInBlackboard()
```
Mention the reference vm in the blackboard

validateEventsReceived
```
public static void validateEventsReceived()
```
Validate the events received by the clients with the reference Vm

killClient
```
public static void killClient()
```
Kill the clients

getQueryObjectForCounter

public QueryObject getQueryObjectForCounter(long key)

Return a value for the given key

putSequentialKeyUsingPutAll

public void putSequentialKeyUsingPutAll(com.gemstone.gemfire.cache.Region region,
                                        int sleepMs)
                                 throws Exception

Throws:: Exception

waitTask
```
public static void waitTask()
```

generateAllRemoteDSNameLists

public static String generateAllRemoteDSNameLists(String prefix,
                                                  int n,
                                                  int m)

Generates comma-separated lists of remote distributed system names.

generateRingRemoteDSName

public static String generateRingRemoteDSName(String prefix,
                                              int n,
                                              int m)

Generates comma-separated lists of remote distributed system names in random topology.

generateRandomRemoteDSName

public static String generateRandomRemoteDSName(String prefix,
                                                int n,
                                                int m)

Generates comma-separated lists of remote distributed system names in random topology.

killAndVerifyLocatorsTask

public static void killAndVerifyLocatorsTask()

killAndVerifyLocators
```
public void killAndVerifyLocators()
```

restartVerifyLocatorsTask

public static void restartVerifyLocatorsTask()

printDistributionLocatorMapTask

public static void printDistributionLocatorMapTask()

verifyLocatorsTask

public static void verifyLocatorsTask()

verifyLocators
```
public void verifyLocators()
```

killPeerAndDoOpsTask
```
public static void killPeerAndDoOpsTask()
```
kill other peer and simultaneously do entry operations. This TASK should be run with maxThreads = 1. It coordinates with other entry operations task (ex doHAEntryOperationTask).

killPeerAndDoOps
```
public void killPeerAndDoOps()
```

killPeerAndDoNonCoordinatedOpsTask
```
public static void killPeerAndDoNonCoordinatedOpsTask()
```
kill other peer and simultaneously do entry operations. This TASK should be run with maxThreads = 1. No coordination is provided with other entry operations task.

killPeerAndDoNonCoordinatedOps

public void killPeerAndDoNonCoordinatedOps()

waitForRecovery

public void waitForRecovery(List startupRecoveryVms,
                            List departedRecoveryVMs)

restartMembersTask

public static void restartMembersTask()

restartMembers
```
public void restartMembers()
```

doSenderOperationTask

public static void doSenderOperationTask()

doHASenderOperationAndVerifyTask

public static void doHASenderOperationAndVerifyTask()

verifySenderOperationTask

public static void verifySenderOperationTask()

startResumeSenderTask

public static void startResumeSenderTask()
                                  throws Exception

Throws:: Exception

startResumeSenders

public void startResumeSenders()
                        throws Exception

Throws:: Exception

generateDoubleSuffixedNames
```
public static String generateDoubleSuffixedNames(String prefix,
                                                 int n,
                                                 int m,
                                                 int start_n,
                                                 int start_m,
                                                 boolean varyFirst,
                                                 boolean useComma)
```
Generates a list of strings with the specified prefix and suffixed x_y, where x varies start_n,...,n and y varies start_m,...,m, and x varies first if varyFirst is true, else y. For example:
generateDoubleSuffixedNames("frip", 3, 2, 1, 3, true, false) yields: frip_1_3 frip_2_3 frip_3_3 frip_1_4 frip_2_4 frip_3_4.
generateDoubleSuffixedNames("frip", 3, 2, 1, 3, false, false) yields: frip_1_3 frip_1_4 frip_2_3 frip_2_4 frip_3_3 frip_3_4.

Class WANTest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ITERATIONS

maxOperations

regionDescriptNames

regionNames

isBridgeConfiguration

isBridgeClient

instance

opsClient

updateRegionSnapshot

logger

rand

rv

gatewaySenders

isQueuePrinting

Constructor Detail

WANTest

Method Detail

initializeLocator

initializeDatastore

initializeClient

createLocatorTask

startAndConnectLocatorTask

startAndConnectAndVerifyLocatorTask

waitForLocatorDiscovery

startLocatorAndAdminDSTask

starAndVerifytLocatorAdminDSTask

stopLocatorTask

initPeerCacheTask

initPeerCache

initServerCacheTask

initPeerRegionTask

initDatastoreRegion

initAccessorRegionTask

initServerRegionTask

initEdgeClientCacheTask

initEdgeClientCache

initCQClientTask

initCQClient

createGatewaySenderIdsTask

initGatewaySenderTask

initGatewaySender

startGatewaySenderTask

startGatewaySender

HydraTask_stopWANComponents

stopGatewaySenderTask

stopGatewayReceiverTask

initGatewayReceiverTask

initGatewayReceiver

HydraTask_initPeerTask

HydraTask_initServerTask

HydraTask_initWANComponentsTask

closeEdgeClientCacheTask

validateSequentialKeysTask

validateSequentialKeysInRegion

validateRegion

validateSequentialKeysCQTask

validateSequentialKeysCQ

HydraTask_verifyQueueEviction

HydraTask_pauseSenders

HydraTask_resumeSenders

verifyQueueEviction

printQueueContentsTask

printQueueContents