QueryTest (GemFire XD Java API Documentation)

java.lang.Object
- query.common.QueryTest

```
public class QueryTest
extends Object
```
A Hydra test that concurrently performs a number of cache-related operations and querying. This test is basically for testing the effect of querying on various cache operations. It ensures that the querying works properly without hang in distributed environment Along the way, it also uses the blackboards EventBB and EventCountersBB to keep track of what has happened and to validate that what has happened is expected. It requires that the regions that it tests be distributed and mirrored.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class QueryTest.QueryObserverImpl

Nested Classes
Modifier and Type	Class and Description
`static class`	`QueryTest.QueryObserverImpl`

Field Summary

Fields
Modifier and Type	Field and Description
`protected static int`	`ADD_OPERATION`
`protected static int`	`COUNT_QUERY_OPERATION`
`protected static int`	`CREATE_INDEX_OPERATION`
`protected static String`	`createCallbackPrefix`
`protected static int`	`DESTROY_OPERATION`
`protected static String`	`destroyCallbackPrefix`
`protected com.gemstone.gemfire.distributed.DistributedLockService`	`distLockService`
`protected boolean`	`ignoreQueryExecTimeOutException`
`protected static int`	`INVALIDATE_OPERATION`
`protected static String`	`invalidateCallbackPrefix`
`protected boolean`	`isCarefulValidation`
`protected boolean`	`isSerialExecution`
`protected static int`	`LOCAL_DESTROY_OPERATION`
`protected static int`	`LOCAL_INVALIDATE_OPERATION`
`protected static String`	`LOCK_NAME`
`protected static String`	`LOCK_SERVICE_NAME`
`protected int`	`maxObjects`
`static int`	`MILLIS_TO_WAIT`
`protected long`	`minTaskGranularityMS`
`protected long`	`minTaskGranularitySec`
`protected int`	`numOfRegions`
`protected int`	`numVMs`
`protected static HydraThreadLocal`	`origClassLoader`
`protected static boolean`	`pdxReadSerialized`
`protected static int`	`PDXSTRING_QUERY_OPERATION`
`com.gemstone.gemfire.cache.client.Pool`	`pool`
`protected static int`	`QUERY_OPERATION`
`protected int`	`queryLimit`
`protected static QueryTest`	`queryTest`
`protected RandomValues`	`randomValues`
`protected static int`	`READ_OPERATION`
`static String`	`REGION_NAME`
`protected static int`	`REMOVE_INDEX_OPERATION`
`protected static int`	`UPDATE_OPERATION`
`protected static String`	`updateCallbackPrefix`

Constructor Summary

Constructors
Constructor and Description

QueryTest()

Constructors
Constructor and Description
`QueryTest()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addObject(com.gemstone.gemfire.cache.Region aRegion, boolean logAddition)`
`protected void`	`createCacheFromXml(String xmlFilename)` Creates the cache based on the given xmlFile
`protected void`	`createRootRegions()` Creates the root region in the `Cache` used in this test according to the configuration in a `RegionDefinition`.
`protected void`	`destroyObject(com.gemstone.gemfire.cache.Region aRegion, boolean isLocalDestroy)`
`protected void`	`doEntryAndQueryOperations()`
`protected void`	`doQuery(boolean logAddition)` Executes the query over the region
`protected com.gemstone.gemfire.cache.CacheListener`	`getCacheListener()` Returns the `CacheListener` that is installed on regions created by this test.
`protected int`	`getNumVMsWithListeners()`
`protected Object`	`getObjectToAdd(String classname)` Creates a new object with the given `name` to add to a region.
`protected int`	`getOperation(Long whichPrm, boolean disallowLocalEntryOps)` Return a random operation from the hydra parameter specified by whichPrm.
`com.gemstone.gemfire.cache.Region`	`getRandomRegionWithValueConstrains()`
`protected Object`	`getUpdateObject(String classname)` Returns the "updated" value of the object with the given `name`.
`protected void`	`handleRegionDestroyedException(com.gemstone.gemfire.cache.Region aRegion, com.gemstone.gemfire.cache.RegionDestroyedException anException)` Called when the test gets a RegionDestroyedException.
`static void`	`HydraTask_doEntryAndQueryOperations()` Performs randomly selected operations (add, invalidate, etc.) on the root region based on the weightings in `QueryPrms#entryOperations`.
`static void`	`HydraTask_initialize_clientCache()`
`static void`	`HydraTask_initialize_xml()` Creates and initializes the singleton instance of `QueryTest` in this VM.
`static void`	`HydraTask_initialize()` Creates and initializes the singleton instance of `QueryTest` in this VM.
`static void`	`HydraTask_load()` Load the regions under test with numToLoad entries spread across all the regions.
`static void`	`HydraTask_populateRegions()` Populate regions with maxObjects number of region entries.
`void`	`initialize_clientCache()`
`void`	`initialize()`
`void`	`initialize(String xmlFilename)`
`protected void`	`invalidateObject(com.gemstone.gemfire.cache.Region aRegion, boolean isLocalInvalidate)`
`protected static void`	`logExecutionNumber()`
`protected void`	`readObject(com.gemstone.gemfire.cache.Region aRegion)` Fetches (reads) the value of a randomly selected entry in the given region.
`protected void`	`updateObject(com.gemstone.gemfire.cache.Region aRegion)` Updates the "first" entry in a given region
`protected void`	`updateObject(com.gemstone.gemfire.cache.Region aRegion, Object name)` Updates the entry with the given key (`name`) in the given region.
`protected void`	`verifyObjectDestroyed(com.gemstone.gemfire.cache.Region aRegion, Object key)` Verify that the given key in the given region is destroyed (has no key/value).
`protected void`	`verifyObjectInvalidated(com.gemstone.gemfire.cache.Region aRegion, Object key)` Verify that the given key in the given region is invalid (has a null value).

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

- Field Detail
  - queryTest
```
protected static QueryTest queryTest
```
  - ADD_OPERATION
```
protected static final int ADD_OPERATION
```
    See Also:
    
    Constant Field Values
  - UPDATE_OPERATION
```
protected static final int UPDATE_OPERATION
```
    See Also:
    
    Constant Field Values
  - INVALIDATE_OPERATION
```
protected static final int INVALIDATE_OPERATION
```
    See Also:
    
    Constant Field Values
  - DESTROY_OPERATION
```
protected static final int DESTROY_OPERATION
```
    See Also:
    
    Constant Field Values
  - READ_OPERATION
```
protected static final int READ_OPERATION
```
    See Also:
    
    Constant Field Values
  - LOCAL_INVALIDATE_OPERATION
```
protected static final int LOCAL_INVALIDATE_OPERATION
```
    See Also:
    
    Constant Field Values
  - LOCAL_DESTROY_OPERATION
```
protected static final int LOCAL_DESTROY_OPERATION
```
    See Also:
    
    Constant Field Values
  - QUERY_OPERATION
```
protected static final int QUERY_OPERATION
```
    See Also:
    
    Constant Field Values
  - CREATE_INDEX_OPERATION
```
protected static final int CREATE_INDEX_OPERATION
```
    See Also:
    
    Constant Field Values
  - REMOVE_INDEX_OPERATION
```
protected static final int REMOVE_INDEX_OPERATION
```
    See Also:
    
    Constant Field Values
  - COUNT_QUERY_OPERATION
```
protected static final int COUNT_QUERY_OPERATION
```
    See Also:
    
    Constant Field Values
  - PDXSTRING_QUERY_OPERATION
```
protected static final int PDXSTRING_QUERY_OPERATION
```
    See Also:
    
    Constant Field Values
  - pdxReadSerialized
```
protected static boolean pdxReadSerialized
```
  - origClassLoader
```
protected static HydraThreadLocal origClassLoader
```
  - numOfRegions
```
protected int numOfRegions
```
  - isSerialExecution
```
protected boolean isSerialExecution
```
  - isCarefulValidation
```
protected boolean isCarefulValidation
```
  - ignoreQueryExecTimeOutException
```
protected boolean ignoreQueryExecTimeOutException
```
  - queryLimit
```
protected int queryLimit
```
  - MILLIS_TO_WAIT
```
public static final int MILLIS_TO_WAIT
```
    See Also:
    
    Constant Field Values
  - numVMs
```
protected int numVMs
```
  - minTaskGranularitySec
```
protected long minTaskGranularitySec
```
  - minTaskGranularityMS
```
protected long minTaskGranularityMS
```
  - randomValues
```
protected RandomValues randomValues
```
  - maxObjects
```
protected int maxObjects
```
  - distLockService
```
protected com.gemstone.gemfire.distributed.DistributedLockService distLockService
```
  - pool
```
public com.gemstone.gemfire.cache.client.Pool pool
```
  - 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
  - LOCK_SERVICE_NAME
```
protected static String LOCK_SERVICE_NAME
```
  - LOCK_NAME
```
protected static String LOCK_NAME
```
  - REGION_NAME
```
public static final String REGION_NAME
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - QueryTest
```
public QueryTest()
```
- Method Detail
  - HydraTask_initialize
```
public static void HydraTask_initialize()
```
    Creates and initializes the singleton instance of QueryTest in this VM.
  - HydraTask_initialize_xml
```
public static void HydraTask_initialize_xml()
```
    Creates and initializes the singleton instance of QueryTest in this VM.
  - HydraTask_initialize_clientCache
```
public static void HydraTask_initialize_clientCache()
```
  - initialize_clientCache
```
public void initialize_clientCache()
```
  - initialize
```
public void initialize()
```
  - initialize
```
public void initialize(String xmlFilename)
```
    See Also:
    
    HydraTask_initialize()
  - HydraTask_load
```
public static void HydraTask_load()
```
    Load the regions under test with numToLoad entries spread across all the regions.
  - HydraTask_populateRegions
```
public static void HydraTask_populateRegions()
```
    Populate regions with maxObjects number of region entries.
  - HydraTask_doEntryAndQueryOperations
```
public static void HydraTask_doEntryAndQueryOperations()
```
    Performs randomly selected operations (add, invalidate, etc.) on the root region based on the weightings in QueryPrms#entryOperations. The operations will continue to be performed until the minimum task granularity has been reached.
  - getRandomRegionWithValueConstrains
```
public com.gemstone.gemfire.cache.Region getRandomRegionWithValueConstrains()
```
  - doEntryAndQueryOperations
```
protected void doEntryAndQueryOperations()
```
    See Also:
    
    #HydraTask_doEntryOperations
  - addObject
```
protected void addObject(com.gemstone.gemfire.cache.Region aRegion,
                         boolean logAddition)
```
  - invalidateObject
```
protected void invalidateObject(com.gemstone.gemfire.cache.Region aRegion,
                                boolean isLocalInvalidate)
```
  - destroyObject
```
protected void destroyObject(com.gemstone.gemfire.cache.Region aRegion,
                             boolean isLocalDestroy)
```
  - updateObject
```
protected void updateObject(com.gemstone.gemfire.cache.Region aRegion)
```
    Updates the "first" entry in a given region
  - updateObject
```
protected void updateObject(com.gemstone.gemfire.cache.Region aRegion,
                            Object name)
```
    Updates the entry with the given key (name) in the given region.
  - readObject
```
protected void readObject(com.gemstone.gemfire.cache.Region aRegion)
```
    Fetches (reads) the value of a randomly selected entry in the given region.
  - doQuery
```
protected void doQuery(boolean logAddition)
```
    Executes the query over the region
  - getObjectToAdd
```
protected Object getObjectToAdd(String classname)
```
    Creates a new object with the given name to add to a region.
    
    See Also:
    
    BaseValueHolder, RandomValues
  - getUpdateObject
```
protected Object getUpdateObject(String classname)
```
    Returns the "updated" value of the object with the given name.
    
    See Also:
    
    BaseValueHolder.getAlternateValueHolder(util.RandomValues)
  - getCacheListener
```
protected com.gemstone.gemfire.cache.CacheListener getCacheListener()
```
    Returns the CacheListener that is installed on regions created by this test.
    
    See Also:
    
    ETListener
  - getNumVMsWithListeners
```
protected int getNumVMsWithListeners()
```
  - createRootRegions
```
protected void createRootRegions()
```
    Creates the root region in the Cache used in this test according to the configuration in a RegionDefinition.
    
    See Also:
    
    RegionDefinition.createRegionDefinition(), RegionDefinition.createRootRegion(com.gemstone.gemfire.cache.Cache, java.lang.String, com.gemstone.gemfire.cache.CacheListener, com.gemstone.gemfire.cache.CacheLoader, com.gemstone.gemfire.cache.CacheWriter)
  - createCacheFromXml
```
protected void createCacheFromXml(String xmlFilename)
```
    Creates the cache based on the given xmlFile
  - getOperation
```
protected int getOperation(Long whichPrm,
                           boolean disallowLocalEntryOps)
```
    Return a random operation from the hydra parameter specified by whichPrm.
    
    Parameters:
    
    whichPrm - - the hydra parameter that is a list of operations
    
    disallowLocalEntryOps - - if true, then do not return localInvalidate or localDestroy. This is used for regions that are mirrored, since localInvalidate and localDestroy are disallowed for mirrored regions.
  - logExecutionNumber
```
protected static void logExecutionNumber()
```
  - handleRegionDestroyedException
```
protected void handleRegionDestroyedException(com.gemstone.gemfire.cache.Region aRegion,
                                              com.gemstone.gemfire.cache.RegionDestroyedException anException)
```
    Called when the test gets a RegionDestroyedException. Sometimes the test expects this exception, sometimes not. Check for error scenarios and throw an error if the test should not get the RegionDestroyedException.
    
    Parameters:
    
    aRegion - - the region that supposedly was destroyed and triggered the RegionDestroyedException
    
    anException - - the exception that was thrown.
  - verifyObjectInvalidated
```
protected void verifyObjectInvalidated(com.gemstone.gemfire.cache.Region aRegion,
                                       Object key)
```
    Verify that the given key in the given region is invalid (has a null value). If not, then throw an error. Checking is done locally, without invoking a cache loader or doing a net search.
    
    Parameters:
    
    aRegion - The region containing key
    
    key - The key that should have a null value
  - verifyObjectDestroyed
```
protected void verifyObjectDestroyed(com.gemstone.gemfire.cache.Region aRegion,
                                     Object key)
```
    Verify that the given key in the given region is destroyed (has no key/value). If not, then throw an error. Checking is done locally, without invoking a cache loader or doing a net search.
    
    Parameters:
    
    aRegion - The region contains the destroyed key
    
    key - The destroyed key

Class QueryTest

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

queryTest

ADD_OPERATION

UPDATE_OPERATION

INVALIDATE_OPERATION

DESTROY_OPERATION

READ_OPERATION

LOCAL_INVALIDATE_OPERATION

LOCAL_DESTROY_OPERATION

QUERY_OPERATION

CREATE_INDEX_OPERATION

REMOVE_INDEX_OPERATION

COUNT_QUERY_OPERATION

PDXSTRING_QUERY_OPERATION

pdxReadSerialized

origClassLoader

numOfRegions

isSerialExecution

isCarefulValidation

ignoreQueryExecTimeOutException

queryLimit

MILLIS_TO_WAIT

numVMs

minTaskGranularitySec

minTaskGranularityMS

randomValues

maxObjects

distLockService

pool

createCallbackPrefix

updateCallbackPrefix

invalidateCallbackPrefix

destroyCallbackPrefix

LOCK_SERVICE_NAME

LOCK_NAME

REGION_NAME

Constructor Detail

QueryTest

Method Detail

HydraTask_initialize

HydraTask_initialize_xml

HydraTask_initialize_clientCache

initialize_clientCache

initialize

initialize

HydraTask_load

HydraTask_populateRegions

HydraTask_doEntryAndQueryOperations

getRandomRegionWithValueConstrains

doEntryAndQueryOperations

addObject

invalidateObject

destroyObject

updateObject

updateObject

readObject

doQuery

getObjectToAdd

getUpdateObject

getCacheListener

getNumVMsWithListeners

createRootRegions

createCacheFromXml

getOperation

logExecutionNumber

handleRegionDestroyedException

verifyObjectInvalidated

verifyObjectDestroyed