VersioningTest (GemFire XD Java API Documentation)

java.lang.Object
- versioning.VersioningTest

public class VersioningTest
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VersioningTest.ValueAndVersion

Nested Classes
Modifier and Type	Class and Description
`static class`	`VersioningTest.ValueAndVersion`

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.gemstone.gemfire.cache.Region`	`aRegion`
`protected int`	`concurrentLeaderTid`
`protected static java.lang.String`	`createCallbackPrefix`
`protected static java.lang.String`	`destroyCallbackPrefix`
`protected java.util.Set`	`destroyedKeys`
`protected static int`	`ENTRY_ADD_OPERATION`
`protected static int`	`ENTRY_DESTROY_OPERATION`
`protected static int`	`ENTRY_GET_NEW_OPERATION`
`protected static int`	`ENTRY_GET_OPERATION`
`protected static int`	`ENTRY_INVALIDATE_OPERATION`
`protected static int`	`ENTRY_LOCAL_DESTROY_OPERATION`
`protected static int`	`ENTRY_LOCAL_INVALIDATE_OPERATION`
`protected static int`	`ENTRY_UPDATE_OPERATION`
`static int`	`EQUAL`
`static int`	`EQUIVALENT`
`protected static java.lang.String`	`getCallbackPrefix`
`protected static java.lang.String`	`invalidateCallbackPrefix`
`protected boolean`	`isSerialExecution`
`protected int`	`lowerThreshold`
`protected long`	`minTaskGranularityMS`
`protected long`	`minTaskGranularitySec`
`protected int`	`numOpsPerTask`
`HydraThreadLocal`	`ownKeysIndex`
`protected static int`	`PUT_IF_ABSENT_OPERATION`
`protected RandomValues`	`randomValues`
`protected static java.lang.String`	`REGION_NAME`
`protected static java.lang.String`	`regionDestroyCallbackPrefix`
`protected static java.lang.String`	`regionInvalidateCallbackPrefix`
`protected java.util.Map`	`regionSnapshot`
`protected static int`	`REMOVE_OPERATION`
`protected static int`	`REPLACE_OPERATION`
`protected int`	`secondsToRun`
`protected long`	`taskStartTime`
`protected int`	`totalNumThreadsInTest`
`protected static java.lang.String`	`updateCallbackPrefix`
`protected int`	`upperThreshold`
`protected boolean`	`useOwnKeys`

Constructor Summary

Constructors
Constructor and Description

VersioningTest()

Constructors
Constructor and Description
`VersioningTest()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected java.lang.Object`	`addEntry(com.gemstone.gemfire.cache.Region aRegion)` Add a new entry to the given region.
`protected void`	`checkForLastIteration()` Check if we have run for the desired length of time.
`protected static void`	`closeAndOpenRegion()` Close the region and re-open for next round of ops
`protected void`	`concVerify()`
`protected void`	`createGatewayHub()` Creates a gateway hub with the configured HubConfig.
`protected void`	`createGatewayHub(java.lang.String gatewayHubConfig)` Re-creates a gateway hub (within HAController method)
`static void`	`createLocatorTask()` Creates a (disconnected) locator.
`protected void`	`createRegion()` create region based on config prms and reset test instance 'aRegion'
`protected void`	`destroyEntry(com.gemstone.gemfire.cache.Region aRegion, boolean isLocalDestroy)` Destroy an entry in the given region.
`protected void`	`doConcOpsAndVerify()` Do random operations and verification for concurrent tests.
`protected void`	`doEntryOperations(com.gemstone.gemfire.cache.Region aRegion)` Do random entry operations on the given region ending either with minTaskGranularityMS or numOpsPerTask.
`protected java.lang.Object`	`getExistingKey(com.gemstone.gemfire.cache.Region aRegion)` Return a random key currently in the given region.
`protected void`	`getKey(com.gemstone.gemfire.cache.Region aRegion)` Get an existing key in the given region if one is available, otherwise get a new key.
`protected java.lang.Object`	`getNewKey()` Return a new key
`protected void`	`getNewKey(com.gemstone.gemfire.cache.Region aRegion)` Get a new key int the given region.
`protected int`	`getOperation(java.lang.Long whichPrm)` Get a random operation using the given hydra parameter.
`protected java.lang.Object`	`getRecentKey(com.gemstone.gemfire.cache.Region aRegion, int recentHistory)` Return a random recently used key.
`protected ValueHolder`	`getUpdateObject(com.gemstone.gemfire.cache.Region aRegion, java.lang.String key)` Return an object to be used to update the given key.
`protected ValueHolder`	`getValueForKey(java.lang.Object key)` Return a value for the given key
`static void`	`HydraTask_doConcOpsAndVerify()` Hydra task method for concurrent tests with verification.
`static void`	`HydraTask_initialize()` Creates and initializes the singleton instance of VersioningTest in this VM.
`static void`	`HydraTask_startGatewayHubTask()` Starts a gateway hub in a VM that previously created one, after creating gateways.
`protected void`	`initializeInstance()` Initialize this test instance
`protected void`	`invalidateEntry(com.gemstone.gemfire.cache.Region aRegion, boolean isLocalInvalidate)` Invalidate an entry in the given region.
`protected static void`	`logExecutionNumber()` Log the execution number of this serial task.
`protected java.lang.Object`	`putIfAbsent(com.gemstone.gemfire.cache.Region aRegion)` Add a new entry to the given region via putIfAbsent
`protected void`	`remove(com.gemstone.gemfire.cache.Region aRegion)` Remove an entry from the given region.
`protected void`	`replace(com.gemstone.gemfire.cache.Region aRegion)` Replace an existing entry in the given region.
`static void`	`startAndConnectLocatorTask()` Connects a locator to its (admin-only) distributed system.
`protected void`	`startGatewayHub(java.lang.String gatewayConfig)` Starts a gateway hub in a VM that previously created one, after creating gateways.
`static void`	`stopLocatorTask()` Stops a locator.
`protected void`	`updateEntry(com.gemstone.gemfire.cache.Region aRegion)` Update an existing entry in the given region.
`protected static void`	`verifyContainsKey(com.gemstone.gemfire.cache.Region aRegion, java.lang.Object key, boolean expected)` Verify containsKey for the given region and key.
`protected static void`	`verifyContainsValueForKey(com.gemstone.gemfire.cache.Region aRegion, java.lang.Object key, boolean expected)` Verify containsValueForKey for the given region and key.
`protected void`	`verifyFromSnapshot()` Verify this thread's view of the keys and values in the region by reading the region snapshot and destroyed keys from the blackboad.
`protected static void`	`verifyMyValue(com.gemstone.gemfire.cache.Region aRegion, java.lang.Object key, java.lang.Object expectedValue, java.lang.Object valueToCheck, int compareStrategy)` Verify that the given object is an instance of ValueHolder with expectedValue as the myValue field.
`protected static void`	`verifySize(com.gemstone.gemfire.cache.Region aRegion, int expectedSize)` Verify that the size of the given region is expectedSize.

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

- Field Detail
  - ENTRY_ADD_OPERATION
```
protected static final int ENTRY_ADD_OPERATION
```
    See Also:
    
    Constant Field Values
  - ENTRY_DESTROY_OPERATION
```
protected static final int ENTRY_DESTROY_OPERATION
```
    See Also:
    
    Constant Field Values
  - ENTRY_INVALIDATE_OPERATION
```
protected static final int ENTRY_INVALIDATE_OPERATION
```
    See Also:
    
    Constant Field Values
  - ENTRY_LOCAL_DESTROY_OPERATION
```
protected static final int ENTRY_LOCAL_DESTROY_OPERATION
```
    See Also:
    
    Constant Field Values
  - ENTRY_LOCAL_INVALIDATE_OPERATION
```
protected static final int ENTRY_LOCAL_INVALIDATE_OPERATION
```
    See Also:
    
    Constant Field Values
  - ENTRY_UPDATE_OPERATION
```
protected static final int ENTRY_UPDATE_OPERATION
```
    See Also:
    
    Constant Field Values
  - ENTRY_GET_OPERATION
```
protected static final int ENTRY_GET_OPERATION
```
    See Also:
    
    Constant Field Values
  - ENTRY_GET_NEW_OPERATION
```
protected static final int ENTRY_GET_NEW_OPERATION
```
    See Also:
    
    Constant Field Values
  - PUT_IF_ABSENT_OPERATION
```
protected static final int PUT_IF_ABSENT_OPERATION
```
    See Also:
    
    Constant Field Values
  - REMOVE_OPERATION
```
protected static final int REMOVE_OPERATION
```
    See Also:
    
    Constant Field Values
  - REPLACE_OPERATION
```
protected static final int REPLACE_OPERATION
```
    See Also:
    
    Constant Field Values
  - REGION_NAME
```
protected static final java.lang.String REGION_NAME
```
    See Also:
    
    Constant Field Values
  - minTaskGranularitySec
```
protected long minTaskGranularitySec
```
  - minTaskGranularityMS
```
protected long minTaskGranularityMS
```
  - numOpsPerTask
```
protected int numOpsPerTask
```
  - isSerialExecution
```
protected boolean isSerialExecution
```
  - totalNumThreadsInTest
```
protected int totalNumThreadsInTest
```
  - randomValues
```
protected RandomValues randomValues
```
  - aRegion
```
protected com.gemstone.gemfire.cache.Region aRegion
```
  - upperThreshold
```
protected int upperThreshold
```
  - lowerThreshold
```
protected int lowerThreshold
```
  - concurrentLeaderTid
```
protected int concurrentLeaderTid
```
  - secondsToRun
```
protected int secondsToRun
```
  - taskStartTime
```
protected volatile long taskStartTime
```
  - regionSnapshot
```
protected java.util.Map regionSnapshot
```
  - destroyedKeys
```
protected java.util.Set destroyedKeys
```
  - useOwnKeys
```
protected boolean useOwnKeys
```
  - ownKeysIndex
```
public HydraThreadLocal ownKeysIndex
```
  - getCallbackPrefix
```
protected static final java.lang.String getCallbackPrefix
```
    See Also:
    
    Constant Field Values
  - createCallbackPrefix
```
protected static final java.lang.String createCallbackPrefix
```
    See Also:
    
    Constant Field Values
  - updateCallbackPrefix
```
protected static final java.lang.String updateCallbackPrefix
```
    See Also:
    
    Constant Field Values
  - invalidateCallbackPrefix
```
protected static final java.lang.String invalidateCallbackPrefix
```
    See Also:
    
    Constant Field Values
  - destroyCallbackPrefix
```
protected static final java.lang.String destroyCallbackPrefix
```
    See Also:
    
    Constant Field Values
  - regionInvalidateCallbackPrefix
```
protected static final java.lang.String regionInvalidateCallbackPrefix
```
    See Also:
    
    Constant Field Values
  - regionDestroyCallbackPrefix
```
protected static final java.lang.String regionDestroyCallbackPrefix
```
    See Also:
    
    Constant Field Values
  - EQUAL
```
public static int EQUAL
```
  - EQUIVALENT
```
public static int EQUIVALENT
```
- Constructor Detail
  - VersioningTest
```
public VersioningTest()
```
- Method Detail
  - createLocatorTask
```
public static void createLocatorTask()
```
    Creates a (disconnected) locator.
  - startAndConnectLocatorTask
```
public static void startAndConnectLocatorTask()
```
    Connects a locator to its (admin-only) distributed system.
  - stopLocatorTask
```
public static void stopLocatorTask()
```
    Stops a locator.
  - HydraTask_startGatewayHubTask
```
public static void HydraTask_startGatewayHubTask()
```
    Starts a gateway hub in a VM that previously created one, after creating gateways.
  - startGatewayHub
```
protected void startGatewayHub(java.lang.String gatewayConfig)
```
    Starts a gateway hub in a VM that previously created one, after creating gateways.
  - createGatewayHub
```
protected void createGatewayHub()
```
    Creates a gateway hub with the configured HubConfig.
  - createGatewayHub
```
protected void createGatewayHub(java.lang.String gatewayHubConfig)
```
    Re-creates a gateway hub (within HAController method)
  - HydraTask_initialize
```
public static void HydraTask_initialize()
```
    Creates and initializes the singleton instance of VersioningTest in this VM.
  - initializeInstance
```
protected void initializeInstance()
```
    Initialize this test instance
  - HydraTask_doConcOpsAndVerify
```
public static void HydraTask_doConcOpsAndVerify()
```
    Hydra task method for concurrent tests with verification.
  - doConcOpsAndVerify
```
protected void doConcOpsAndVerify()
```
    Do random operations and verification for concurrent tests.
  - doEntryOperations
```
protected void doEntryOperations(com.gemstone.gemfire.cache.Region aRegion)
```
    Do random entry operations on the given region ending either with minTaskGranularityMS or numOpsPerTask. Uses VersionPrms.entryOperations to determine the operations to execute.
  - addEntry
```
protected java.lang.Object addEntry(com.gemstone.gemfire.cache.Region aRegion)
```
    Add a new entry to the given region.
    
    Parameters:
    
    aRegion - The region to use for adding a new entry.
  - invalidateEntry
```
protected void invalidateEntry(com.gemstone.gemfire.cache.Region aRegion,
                               boolean isLocalInvalidate)
```
    Invalidate an entry in the given region.
    
    Parameters:
    
    aRegion - The region to use for invalidating an entry.
    
    isLocalInvalidate - True if the invalidate should be local, false otherwise.
  - destroyEntry
```
protected void destroyEntry(com.gemstone.gemfire.cache.Region aRegion,
                            boolean isLocalDestroy)
```
    Destroy an entry in the given region.
    
    Parameters:
    
    aRegion - The region to use for destroying an entry.
    
    isLocalDestroy - True if the destroy should be local, false otherwise.
  - putIfAbsent
```
protected java.lang.Object putIfAbsent(com.gemstone.gemfire.cache.Region aRegion)
```
    Add a new entry to the given region via putIfAbsent
    
    Parameters:
    
    aRegion - The region to use for adding a new entry.
  - replace
```
protected void replace(com.gemstone.gemfire.cache.Region aRegion)
```
    Replace an existing entry in the given region. If there are no available keys in the region, then this is a noop.
    
    Parameters:
    
    aRegion - The region to use for updating an entry.
  - remove
```
protected void remove(com.gemstone.gemfire.cache.Region aRegion)
```
    Remove an entry from the given region.
    
    Parameters:
    
    aRegion - The region to use for removing an entry.
  - updateEntry
```
protected void updateEntry(com.gemstone.gemfire.cache.Region aRegion)
```
    Update an existing entry in the given region. If there are no available keys in the region, then this is a noop.
    
    Parameters:
    
    aRegion - The region to use for updating an entry.
  - getKey
```
protected void getKey(com.gemstone.gemfire.cache.Region aRegion)
```
    Get an existing key in the given region if one is available, otherwise get a new key.
    
    Parameters:
    
    aRegion - The region to use for getting an entry.
  - getNewKey
```
protected void getNewKey(com.gemstone.gemfire.cache.Region aRegion)
```
    Get a new key int the given region.
    
    Parameters:
    
    aRegion - The region to use for getting an entry.
  - checkForLastIteration
```
protected void checkForLastIteration()
```
    Check if we have run for the desired length of time. We cannot use hydra's taskTimeSec parameter because of a small window of opportunity for the test to hang due to the test's "concurrent round robin" type of strategy. Here we set a blackboard counter if time is up and this is the last concurrent round.
  - getValueForKey
```
protected ValueHolder getValueForKey(java.lang.Object key)
```
    Return a value for the given key
  - getNewKey
```
protected java.lang.Object getNewKey()
```
    Return a new key
  - getRecentKey
```
protected java.lang.Object getRecentKey(com.gemstone.gemfire.cache.Region aRegion,
                                        int recentHistory)
```
    Return a random recently used key.
    
    Parameters:
    
    aRegion - The region to use for getting a recently used key.
    
    recentHistory - The number of most recently used keys to consider for returning.
  - getUpdateObject
```
protected ValueHolder getUpdateObject(com.gemstone.gemfire.cache.Region aRegion,
                                      java.lang.String key)
```
    Return an object to be used to update the given key. If the value for the key is a ValueHolder, then get an alternate value which is similar to it's previous value (see ValueHolder.getAlternateValueHolder()).
    
    Parameters:
    
    aRegion - The region which possible contains key.
    
    key - The key to get a new value for.
  - logExecutionNumber
```
protected static void logExecutionNumber()
```
    Log the execution number of this serial task.
  - getOperation
```
protected int getOperation(java.lang.Long whichPrm)
```
    Get a random operation using the given hydra parameter.
    
    Parameters:
    
    whichPrm - A hydra parameter which specifies random operations.
  - verifyFromSnapshot
```
protected void verifyFromSnapshot()
```
    Verify this thread's view of the keys and values in the region by reading the region snapshot and destroyed keys from the blackboad.
  - concVerify
```
protected void concVerify()
```
  - verifySize
```
protected static void verifySize(com.gemstone.gemfire.cache.Region aRegion,
                                 int expectedSize)
```
    Verify that the size of the given region is expectedSize.
    
    Parameters:
    
    aRegion - The region to verify.
    
    expectedSize - The expected size of aRegion.
    
    Throws:
    
    TestException - if size() has the wrong value
  - getExistingKey
```
protected java.lang.Object getExistingKey(com.gemstone.gemfire.cache.Region aRegion)
```
    Return a random key currently in the given region.
    
    Parameters:
    
    aRegion - The region to use for getting an existing key.
  - verifyContainsKey
```
protected static void verifyContainsKey(com.gemstone.gemfire.cache.Region aRegion,
                                        java.lang.Object key,
                                        boolean expected)
```
    Verify containsKey for the given region and key.
    
    Parameters:
    
    aRegion - The region to verify.
    
    key - The key in aRegion to verify.
    
    expected - The expected value of containsKey()
    
    Throws:
    
    TestException - if containsKey() has the wrong value
  - verifyContainsValueForKey
```
protected static void verifyContainsValueForKey(com.gemstone.gemfire.cache.Region aRegion,
                                                java.lang.Object key,
                                                boolean expected)
```
    Verify containsValueForKey for the given region and key.
    
    Parameters:
    
    aRegion - The region to verify.
    
    key - The key in aRegion to verify.
    
    expected - The expected value of containsKey()
    
    Throws:
    
    TestException - if containsValueforKey() has the wrong value
  - verifyMyValue
```
protected static void verifyMyValue(com.gemstone.gemfire.cache.Region aRegion,
                                    java.lang.Object key,
                                    java.lang.Object expectedValue,
                                    java.lang.Object valueToCheck,
                                    int compareStrategy)
```
    Verify that the given object is an instance of ValueHolder with expectedValue as the myValue field.
    
    Parameters:
    
    aRegion - The region to verify.
    
    key - The key in aRegion to verify.
    
    expectedValue - The expected myValue field of a ValueHolder in aRegion, or null if the expected value should be null.
    
    valuetoCheck - This is expected to be a ValueHolder, whose myValue field compares to expectedValue, according to comparStrategy
    
    compareStrategy - Whether the compare is equals or equivalent (for ValueHolders)
    
    Throws:
    
    TestException - if the result of a get on key does not have the expected value.
  - closeAndOpenRegion
```
protected static void closeAndOpenRegion()
```
    Close the region and re-open for next round of ops
  - createRegion
```
protected void createRegion()
```
    create region based on config prms and reset test instance 'aRegion'

Class VersioningTest

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ENTRY_ADD_OPERATION

ENTRY_DESTROY_OPERATION

ENTRY_INVALIDATE_OPERATION

ENTRY_LOCAL_DESTROY_OPERATION

ENTRY_LOCAL_INVALIDATE_OPERATION

ENTRY_UPDATE_OPERATION

ENTRY_GET_OPERATION

ENTRY_GET_NEW_OPERATION

PUT_IF_ABSENT_OPERATION

REMOVE_OPERATION

REPLACE_OPERATION

REGION_NAME

minTaskGranularitySec

minTaskGranularityMS

numOpsPerTask

isSerialExecution

totalNumThreadsInTest

randomValues

aRegion

upperThreshold

lowerThreshold

concurrentLeaderTid

secondsToRun

taskStartTime

regionSnapshot

destroyedKeys

useOwnKeys

ownKeysIndex

getCallbackPrefix

createCallbackPrefix

updateCallbackPrefix

invalidateCallbackPrefix

destroyCallbackPrefix

regionInvalidateCallbackPrefix

regionDestroyCallbackPrefix

EQUAL

EQUIVALENT

Constructor Detail

VersioningTest

Method Detail

createLocatorTask

startAndConnectLocatorTask

stopLocatorTask

HydraTask_startGatewayHubTask

startGatewayHub

createGatewayHub

createGatewayHub

HydraTask_initialize

initializeInstance

HydraTask_doConcOpsAndVerify

doConcOpsAndVerify

doEntryOperations

addEntry

invalidateEntry

destroyEntry

putIfAbsent

replace

remove

updateEntry

getKey

getNewKey

checkForLastIteration

getValueForKey

getNewKey

getRecentKey

getUpdateObject

logExecutionNumber

getOperation

verifyFromSnapshot

concVerify

verifySize

getExistingKey

verifyContainsKey