SnapshotTest (GemFire XD Java API Documentation)

java.lang.Object
- snapshot.SnapshotTest

public class SnapshotTest
extends Object

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SnapshotTest.KeySnapshotFilter` Key SnapshotFilter only accepts original entries (created before snapshot written) based on the key (FilterObject_XXX vs.
`static class`	`SnapshotTest.ValueSnapshotFilter` Value SnapshotFilter only accepts original entries (created before snapshot written) based on the value (value should NOT start with this string "object to be filtered").
`static class`	`SnapshotTest.ValueTypeSnapshotFilter` Value Type SnapshotFilter only accepts original entries (created before snapshot written) based on the value type (ValueHolders are accepted, String values are not).

Field Summary

Fields
Modifier and Type	Field and Description
`protected static int`	`CACHE_OPERATIONS`
`protected static String`	`createCallbackPrefix`
`protected static String`	`destroyCallbackPrefix`
`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_PUTALL_OPERATION`
`protected static int`	`ENTRY_UPDATE_OPERATION`
`protected static String`	`getCallbackPrefix`
`protected static String`	`invalidateCallbackPrefix`
`protected static String`	`regionDestroyCallbackPrefix`
`protected static String`	`regionInvalidateCallbackPrefix`
`static SnapshotTest`	`testInstance` instance of this test class
`protected static String`	`updateCallbackPrefix`

Constructor Summary

Constructors
Constructor and Description

SnapshotTest()

Constructors
Constructor and Description
`SnapshotTest()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected Object`	`addEntry(com.gemstone.gemfire.cache.Region aRegion)` Add a new entry to the given region.
`protected void`	`addEntry(com.gemstone.gemfire.cache.Region aRegion, Object key)` Add a new entry to the given region.
`protected static void`	`checkForLastIteration()` Check if we have run for the desired length of time.
`static void`	`CloseTask_closeCache()` Close the cache gracefully (so we can remove the underlying disk store files).
`void`	`createColocatedRegions()`
`protected void`	`destroyEntry(com.gemstone.gemfire.cache.Region aRegion, boolean isLocalDestroy)` Destroy an entry in the given region.
`protected void`	`destroyEntry(com.gemstone.gemfire.cache.Region aRegion, Object key, boolean isLocalDestroy)` Destroy an entry in the given region.
`protected void`	`doOperations(long msToRun)` Do random operations on the cache and any defined regions in this vm.
`protected void`	`doRebalance()` do a rebalance operation
`protected void`	`getExistingKey(com.gemstone.gemfire.cache.Region aRegion)` Does a get operation on an existing key.
`protected void`	`getNewKey(com.gemstone.gemfire.cache.Region aRegion)` Get a new key in the given region.
`protected int`	`getOperation(Long whichPrm)` Get a random operation using the given hydra parameter.
`protected int`	`getOperation(com.gemstone.gemfire.cache.Region aRegion)` Get an operation to perform on the region
`protected Map`	`getPutAllMap(com.gemstone.gemfire.cache.Region aRegion)` Get a map to use for putAll for the given region.
`protected com.gemstone.gemfire.cache.snapshot.SnapshotFilter`	`getSnapshotFilter()` Randomly select one of the SnapshotFilters (Key, Value or ValueType) Returns instance of SnapshotFilter.
`protected void`	`getThisNewKey(com.gemstone.gemfire.cache.Region aRegion, Object key)` Do a get on the given new key.
`protected Object`	`getUpdateObject(com.gemstone.gemfire.cache.Region r, String key)` Return an object to be used to update the given key.
`static BaseValueHolder`	`getVersionedValueHolder(String valueClassName, String key, RandomValues randomValues)`
`protected void`	`handleOperationExceptions(com.gemstone.gemfire.cache.Region aRegion, Exception e)` Handle Exceptions which can be thrown from entry operations during Cache Close/Shutdown
`protected void`	`handleRebalanceException(Exception e)` Handle Exceptions thrown during rebalance (which occur from closing the cache, recycling vms)
`static void`	`HydraTask_createColocatedRegions()` Creates and initializes colocated regions in a peer vm
`static void`	`HydraTask_initialize()` Creates and initializes a server or peer.
`static void`	`HydraTask_initializeController()` Initialization for snapshot controller.
`static void`	`HydraTask_initializeResponder()` Initialize import and verify coordinators as these steps occur after the responder vms have been recycled.
`static void`	`HydraTask_loadRegion()` Hydra task to load the region with keys/values.
`static void`	`HydraTask_removeDiskFiles()` Remove disk files in disk dirs corresponding to this vm's vmID.
`static void`	`HydraTask_resetUniqueKeyIndex()` Reset the uniqueKeyIndex to be higher than the current blackboard counter
`static void`	`HydraTask_snapshotController()` Hydra task to run the snapshot controller thread.
`static void`	`HydraTask_snapshotResponder()` Hydra task to run the responder threads for snapshot tests.
`static void`	`HydraTask_startBridgeServer()` Starts the bridge server in this VM.
`static void`	`initPdxClassLoader()`
`static boolean`	`instanceOfPdxInstance(Object value)`
`protected void`	`invalidateEntry(com.gemstone.gemfire.cache.Region aRegion, boolean isLocalInvalidate)` Invalidate an entry in the given region.
`protected void`	`invalidateEntry(com.gemstone.gemfire.cache.Region aRegion, Object key, boolean isLocalInvalidate)` Invalidate an entry in the given region.
`protected static long`	`logExecutionNumber()` Log the execution number of this serial task.
`protected Object`	`obtainExistingKey(com.gemstone.gemfire.cache.Region aRegion)` Return a random key from aRegion
`protected List<String>`	`obtainExistingKeys(com.gemstone.gemfire.cache.Region aRegion, int numToObtain)` Return a random key from aRegion
`protected Object`	`obtainNewKey()` Return a new key, never before used in the test.
`protected void`	`putAll(com.gemstone.gemfire.cache.Region aRegion)` putall a map to the given region.
`static List`	`shutDownAll()` Task to do a shutDownAll on the worker vms
`static BaseValueHolder`	`toValueHolder(Object value)`
`protected void`	`updateEntry(com.gemstone.gemfire.cache.Region aRegion)` Update an existing entry in the given region.
`protected void`	`updateEntry(com.gemstone.gemfire.cache.Region aRegion, Object key)` Update an existing entry in the given region.
`void`	`verifyFromSnapshot(com.gemstone.gemfire.cache.Region aRegion, Map regionSnapshot)` Verify that the given region is consistent with the given snapshot.

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

- Field Detail
  - testInstance
```
public static SnapshotTest testInstance
```
    instance of this test class
  - 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
  - ENTRY_PUTALL_OPERATION
```
protected static final int ENTRY_PUTALL_OPERATION
```
    See Also:
    
    Constant Field Values
  - CACHE_OPERATIONS
```
protected static final int CACHE_OPERATIONS
```
    See Also:
    
    Constant Field Values
  - getCallbackPrefix
```
protected static final String getCallbackPrefix
```
    See Also:
    
    Constant Field Values
  - createCallbackPrefix
```
protected static final String createCallbackPrefix
```
    See Also:
    
    Constant Field Values
  - updateCallbackPrefix
```
protected static final String updateCallbackPrefix
```
    See Also:
    
    Constant Field Values
  - invalidateCallbackPrefix
```
protected static final String invalidateCallbackPrefix
```
    See Also:
    
    Constant Field Values
  - destroyCallbackPrefix
```
protected static final String destroyCallbackPrefix
```
    See Also:
    
    Constant Field Values
  - regionInvalidateCallbackPrefix
```
protected static final String regionInvalidateCallbackPrefix
```
    See Also:
    
    Constant Field Values
  - regionDestroyCallbackPrefix
```
protected static final String regionDestroyCallbackPrefix
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SnapshotTest
```
public SnapshotTest()
```
- Method Detail
  - HydraTask_initialize
```
public static void HydraTask_initialize()
                                 throws Throwable
```
    Creates and initializes a server or peer.
    
    Throws:
    
    Throwable
  - HydraTask_createColocatedRegions
```
public static void HydraTask_createColocatedRegions()
                                             throws Throwable
```
    Creates and initializes colocated regions in a peer vm
    
    Throws:
    
    Throwable
  - createColocatedRegions
```
public void createColocatedRegions()
```
  - HydraTask_startBridgeServer
```
public static void HydraTask_startBridgeServer()
```
    Starts the bridge server in this VM.
  - HydraTask_initializeController
```
public static void HydraTask_initializeController()
```
    Initialization for snapshot controller.
  - HydraTask_loadRegion
```
public static void HydraTask_loadRegion()
```
    Hydra task to load the region with keys/values. This is a batched task. Load the region with SnapshotPrms.numToLoad entries.
  - HydraTask_resetUniqueKeyIndex
```
public static void HydraTask_resetUniqueKeyIndex()
```
    Reset the uniqueKeyIndex to be higher than the current blackboard counter
  - HydraTask_snapshotController
```
public static void HydraTask_snapshotController()
```
    Hydra task to run the snapshot controller thread. This method controls what the responder vms do.
  - HydraTask_snapshotResponder
```
public static void HydraTask_snapshotResponder()
                                        throws Exception
```
    Hydra task to run the responder threads for snapshot tests. This method responds to directives from the snapshot controller.
    
    Throws:
    
    Exception
  - shutDownAll
```
public static List shutDownAll()
```
    Task to do a shutDownAll on the worker vms
  - HydraTask_initializeResponder
```
public static void HydraTask_initializeResponder()
```
    Initialize import and verify coordinators as these steps occur after the responder vms have been recycled. Verify no events processed during import
  - getSnapshotFilter
```
protected com.gemstone.gemfire.cache.snapshot.SnapshotFilter getSnapshotFilter()
```
    Randomly select one of the SnapshotFilters (Key, Value or ValueType) Returns instance of SnapshotFilter.
  - verifyFromSnapshot
```
public void verifyFromSnapshot(com.gemstone.gemfire.cache.Region aRegion,
                               Map regionSnapshot)
```
    Verify that the given region is consistent with the given snapshot.
    
    Parameters:
    
    aRegion - The region to verify
    
    snapshot - The expected contents of aRegion.
  - doRebalance
```
protected void doRebalance()
```
    do a rebalance operation
  - doOperations
```
protected void doOperations(long msToRun)
                     throws Exception
```
    Do random operations on the cache and any defined regions in this vm.
    
    Parameters:
    
    msToRun - The number of milliseconds to run operations before returning.
    
    Throws:
    
    Exception
  - getOperation
```
protected int getOperation(com.gemstone.gemfire.cache.Region aRegion)
```
    Get an operation to perform on the region
    
    Parameters:
    
    reg - The region to get an operation for.
  - getOperation
```
protected int getOperation(Long whichPrm)
```
    Get a random operation using the given hydra parameter.
    
    Parameters:
    
    whichPrm - A hydra parameter which specifies random operations.
  - getExistingKey
```
protected void getExistingKey(com.gemstone.gemfire.cache.Region aRegion)
```
    Does a get operation on an existing key.
    
    Parameters:
    
    aRegion - The region to perform the get on.
  - addEntry
```
protected 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.
  - addEntry
```
protected void addEntry(com.gemstone.gemfire.cache.Region aRegion,
                        Object key)
```
    Add a new entry to the given region.
    
    Parameters:
    
    aRegion - The region to use for adding a new entry.
    
    key - The key to add.
  - putAll
```
protected void putAll(com.gemstone.gemfire.cache.Region aRegion)
```
    putall a map to the given region.
    
    Parameters:
    
    aRegion - The region to use for putall a map.
  - getPutAllMap
```
protected Map getPutAllMap(com.gemstone.gemfire.cache.Region aRegion)
```
    Get a map to use for putAll for the given region. Make sure the values in the map honor unique keys.
    
    Parameters:
    
    aRegion - The region to consider for the putAll.
    
    Returns:
    
    Map The map to use for the argument to putAll
  - 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.
  - invalidateEntry
```
protected void invalidateEntry(com.gemstone.gemfire.cache.Region aRegion,
                               Object key,
                               boolean isLocalInvalidate)
```
    Invalidate an entry in the given region.
    
    Parameters:
    
    aRegion - The region to use for invalidating an entry.
    
    key - The key to invalidate.
    
    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.
  - destroyEntry
```
protected void destroyEntry(com.gemstone.gemfire.cache.Region aRegion,
                            Object key,
                            boolean isLocalDestroy)
```
    Destroy an entry in the given region.
    
    Parameters:
    
    aRegion - The region to use for destroying an entry.
    
    key - The key to destroy.
    
    isLocalDestroy - True if the destroy should be local, false otherwise.
  - 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.
  - updateEntry
```
protected void updateEntry(com.gemstone.gemfire.cache.Region aRegion,
                           Object key)
```
    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.
    
    key - The key to update.
  - getNewKey
```
protected void getNewKey(com.gemstone.gemfire.cache.Region aRegion)
```
    Get a new key in the given region.
    
    Parameters:
    
    aRegion - The region to use for getting an entry.
  - getThisNewKey
```
protected void getThisNewKey(com.gemstone.gemfire.cache.Region aRegion,
                             Object key)
```
    Do a get on the given new key.
    
    Parameters:
    
    aRegion - The region to use for getting an entry.
    
    key - A new key never used before.
  - obtainExistingKey
```
protected Object obtainExistingKey(com.gemstone.gemfire.cache.Region aRegion)
```
    Return a random key from aRegion
    
    Parameters:
    
    aRegion - The region to get the existing key from.
    
    Returns:
    
    A random key from aRegion.
  - obtainExistingKeys
```
protected List<String> obtainExistingKeys(com.gemstone.gemfire.cache.Region aRegion,
                                          int numToObtain)
```
    Return a random key from aRegion
    
    Parameters:
    
    aRegion - The region to get the existing key from.
    
    Returns:
    
    A List of existing keys.
  - logExecutionNumber
```
protected static long logExecutionNumber()
```
    Log the execution number of this serial task.
  - checkForLastIteration
```
protected static 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.
  - obtainNewKey
```
protected Object obtainNewKey()
```
    Return a new key, never before used in the test.
  - getUpdateObject
```
protected Object getUpdateObject(com.gemstone.gemfire.cache.Region r,
                                 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.
  - handleRebalanceException
```
protected void handleRebalanceException(Exception e)
```
    Handle Exceptions thrown during rebalance (which occur from closing the cache, recycling vms)
    
    Parameters:
    
    - - Exception e
  - handleOperationExceptions
```
protected void handleOperationExceptions(com.gemstone.gemfire.cache.Region aRegion,
                                         Exception e)
```
    Handle Exceptions which can be thrown from entry operations during Cache Close/Shutdown
    
    Parameters:
    
    - - Region involved in failed operation
    
    - - Exception e
  - CloseTask_closeCache
```
public static void CloseTask_closeCache()
```
    Close the cache gracefully (so we can remove the underlying disk store files).
  - HydraTask_removeDiskFiles
```
public static void HydraTask_removeDiskFiles()
```
    Remove disk files in disk dirs corresponding to this vm's vmID.
  - initPdxClassLoader
```
public static void initPdxClassLoader()
```
  - getVersionedValueHolder
```
public static BaseValueHolder getVersionedValueHolder(String valueClassName,
                                                      String key,
                                                      RandomValues randomValues)
```
    Parameters:
    
    valueClassName -
    
    key -
    
    randomValues -
    
    Returns:
  - instanceOfPdxInstance
```
public static boolean instanceOfPdxInstance(Object value)
```
    Parameters:
    
    value -
    
    Returns:
  - toValueHolder
```
public static BaseValueHolder toValueHolder(Object value)
```
    Parameters:
    
    value -
    
    Returns:

Class SnapshotTest

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

testInstance

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

ENTRY_PUTALL_OPERATION

CACHE_OPERATIONS

getCallbackPrefix

createCallbackPrefix

updateCallbackPrefix

invalidateCallbackPrefix

destroyCallbackPrefix

regionInvalidateCallbackPrefix

regionDestroyCallbackPrefix

Constructor Detail

SnapshotTest

Method Detail

HydraTask_initialize

HydraTask_createColocatedRegions

createColocatedRegions

HydraTask_startBridgeServer

HydraTask_initializeController

HydraTask_loadRegion

HydraTask_resetUniqueKeyIndex

HydraTask_snapshotController

HydraTask_snapshotResponder

shutDownAll

HydraTask_initializeResponder

getSnapshotFilter

verifyFromSnapshot

doRebalance

doOperations

getOperation

getOperation

getExistingKey

addEntry

addEntry

putAll

getPutAllMap

invalidateEntry

invalidateEntry

destroyEntry

destroyEntry

updateEntry

updateEntry

getNewKey

getThisNewKey

obtainExistingKey

obtainExistingKeys

logExecutionNumber

checkForLastIteration

obtainNewKey

getUpdateObject

handleRebalanceException

handleOperationExceptions

CloseTask_closeCache

HydraTask_removeDiskFiles

initPdxClassLoader

getVersionedValueHolder

instanceOfPdxInstance

toValueHolder