CQKnownKeysTest (GemFire XD Java API Documentation)

java.lang.Object
- cq.CQKnownKeysTest

public class CQKnownKeysTest
extends Object

Field Summary

Fields
Modifier and Type	Field and Description
`protected static int`	`ADD_NEW_KEY`
`protected com.gemstone.gemfire.cache.Region`	`aRegion`
`protected static boolean`	`CQsOn`
`protected CQTest`	`CQTestInstance`
`protected static int`	`DESTROY`
`protected static int`	`FIRST_OP`
`protected static int`	`GET`
`protected static int`	`INVALIDATE`
`protected boolean`	`isBridgeClient`
`protected boolean`	`isBridgeConfiguration`
`protected KeyIntervals`	`keyIntervals`
`protected static int`	`LAST_OP`
`protected static int`	`LOCAL_DESTROY`
`protected static int`	`LOCAL_INVALIDATE`
`protected long`	`minTaskGranularityMS`
`protected long`	`minTaskGranularitySec`
`protected int`	`numNewKeys`
`protected static int[]`	`operations`
`protected com.gemstone.gemfire.cache.query.QueryService`	`qService`
`protected int`	`queryDepth`
`protected Map`	`queryMap`
`protected static String`	`REGION_NAME`
`protected int`	`SLEEP_BETWEEN_OPS_MILLIS`
`protected boolean`	`sleepBetweenOps`
`protected static CQKnownKeysTest`	`testInstance`
`protected int`	`totalNumKeys`
`protected HydraThreadLocal`	`uniqueKeyIndex`
`protected static int`	`UPDATE_EXISTING_KEY`
`protected static int`	`verifyQueryCount`
`protected static Iterator`	`verifyQueryIterator`
`protected static boolean`	`verifyRegionContentsCompleted`
`protected static StringBuffer`	`verifyRegionContentsErrStr`
`protected static int`	`verifyRegionContentsIndex`
`protected static String`	`VmIDStr`

Constructor Summary

Constructors
Constructor and Description

CQKnownKeysTest()

Constructors
Constructor and Description
`CQKnownKeysTest()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`addNewKey()` Add a new key to REGION_NAME.
`protected void`	`checkContainsKey(Object key, boolean expected, String logStr)` Check that containsKey() called on the tests' region has the expected result.
`protected void`	`checkContainsValueForKey(Object key, boolean expected, String logStr)` Check that containsValueForKey() called on the tests' region has the expected result.
`protected void`	`checkUpdatedValue(Object key, Object value)` Check that the value of the given key is expected as an updated value.
`protected void`	`checkValue(Object key, Object value)` Check that the value of the given key is expected for this test.
`protected boolean`	`destroy()` Destroy a key in region REGION_NAME.
`void`	`doOps(BitSet availableOps)` Do operations on the REGION_NAME's keys using keyIntervals to specify which keys get which operations.
`protected boolean`	`get()` Do a get on a key in region REGION_NAME.
`protected int`	`getOp(BitSet bs, int bsSize)` Get a random operation to perform.
`protected Set`	`getRegionKeySet(com.gemstone.gemfire.cache.Region aRegion)`
`protected QueryObject`	`getValueToAdd(Object key)` Return a value to add to a region for the given key
`static void`	`HydraTask_doOps()` Hydra task to execution ops, then stop scheduling.
`static void`	`HydraTask_initCombineTest()`
`static void`	`HydraTask_initializeBridgeServer()` Creates and initializes a data store PR in a bridge server.
`static void`	`HydraTask_initializeClient()` Creates and initializes the singleton instance of CQTest in a client and start the CQs running.
`static void`	`HydraTask_initializeClientWithoutStartingCQs()` Creates and initializes the singleton instance of CQTest in a client without starting the CQs running.
`static void`	`HydraTask_loadRegion()` Hydra task to initialize a region and load it according to hydra param settings.
`static void`	`HydraTask_startCQsRunning()` Hydra task to start the CQs running for this VM.
`static void`	`HydraTask_verifyQueries()` Hydra task to verify queries on the region after all ops.
`static void`	`HydraTask_verifyQueriesCombine()` Hydra task to verify queries on the region after all ops for a test where executeWithInitialResults occurs concurrently with ops.
`static void`	`HydraTask_verifyRegionContents()` Hydra task to verify the contents of the region after all ops.
`static void`	`HydraTask_waitForSilence()` Hydra task to wait for a period of silence (30 seconds) to allow the server queues to drain to the clients.
`void`	`initializeInstance()` Initialize fields for this instance
`protected void`	`initializeQueryService()`
`protected void`	`initializeRegion(String regDescriptName)` Create a region with the given region description name.
`protected boolean`	`invalidate()` Invalidate a key in region REGION_NAME.
`void`	`loadRegion()` Load a region with keys and values.
`protected boolean`	`localDestroy()` Locally destroy a key in region REGION_NAME.
`protected boolean`	`localInvalidate()` Locally invalidate a key in region REGION_NAME.
`protected void`	`logNumOps()` Log the number of ops that have completed.
`protected static void`	`registerInterest(com.gemstone.gemfire.cache.Region aRegion)` Register interest with ALL_KEYS, and InterestPolicyResult = KEYS_VALUES which is equivalent to a full GII.
`static void`	`StartTask_initialize()` Hydra start task to initialize key intervals, which are ranges of keys which are to have an operation done on them (invalidate, destroy, etc)
`protected boolean`	`updateExistingKey()` Update an existing key in region REGION_NAME.
`protected void`	`verifyQueryResultsCombine()` Verify the result of the CQs registered for this VM.
`void`	`verifyRegionContents()` Verify the contents of the region, taking into account the keys that were destroyed, invalidated, etc (as specified in keyIntervals) Throw an error of any problems are detected.

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

- Field Detail
  - testInstance
```
protected static CQKnownKeysTest testInstance
```
  - REGION_NAME
```
protected static final String REGION_NAME
```
    See Also:
    
    Constant Field Values
  - numNewKeys
```
protected int numNewKeys
```
  - keyIntervals
```
protected KeyIntervals keyIntervals
```
  - totalNumKeys
```
protected int totalNumKeys
```
  - aRegion
```
protected com.gemstone.gemfire.cache.Region aRegion
```
  - minTaskGranularitySec
```
protected long minTaskGranularitySec
```
  - minTaskGranularityMS
```
protected long minTaskGranularityMS
```
  - isBridgeConfiguration
```
protected boolean isBridgeConfiguration
```
  - isBridgeClient
```
protected boolean isBridgeClient
```
  - CQTestInstance
```
protected CQTest CQTestInstance
```
  - uniqueKeyIndex
```
protected HydraThreadLocal uniqueKeyIndex
```
  - queryMap
```
protected Map queryMap
```
  - queryDepth
```
protected int queryDepth
```
  - qService
```
protected com.gemstone.gemfire.cache.query.QueryService qService
```
  - VmIDStr
```
protected static final String VmIDStr
```
    See Also:
    
    Constant Field Values
  - CQsOn
```
protected static boolean CQsOn
```
  - sleepBetweenOps
```
protected boolean sleepBetweenOps
```
  - SLEEP_BETWEEN_OPS_MILLIS
```
protected final int SLEEP_BETWEEN_OPS_MILLIS
```
    See Also:
    
    Constant Field Values
  - verifyRegionContentsIndex
```
protected static int verifyRegionContentsIndex
```
  - verifyRegionContentsErrStr
```
protected static StringBuffer verifyRegionContentsErrStr
```
  - verifyRegionContentsCompleted
```
protected static boolean verifyRegionContentsCompleted
```
  - verifyQueryIterator
```
protected static Iterator verifyQueryIterator
```
  - verifyQueryCount
```
protected static int verifyQueryCount
```
  - INVALIDATE
```
protected static final int INVALIDATE
```
    See Also:
    
    Constant Field Values
  - LOCAL_INVALIDATE
```
protected static final int LOCAL_INVALIDATE
```
    See Also:
    
    Constant Field Values
  - DESTROY
```
protected static final int DESTROY
```
    See Also:
    
    Constant Field Values
  - LOCAL_DESTROY
```
protected static final int LOCAL_DESTROY
```
    See Also:
    
    Constant Field Values
  - UPDATE_EXISTING_KEY
```
protected static final int UPDATE_EXISTING_KEY
```
    See Also:
    
    Constant Field Values
  - GET
```
protected static final int GET
```
    See Also:
    
    Constant Field Values
  - ADD_NEW_KEY
```
protected static final int ADD_NEW_KEY
```
    See Also:
    
    Constant Field Values
  - FIRST_OP
```
protected static final int FIRST_OP
```
    See Also:
    
    Constant Field Values
  - LAST_OP
```
protected static final int LAST_OP
```
    See Also:
    
    Constant Field Values
  - operations
```
protected static final int[] operations
```
- Constructor Detail
  - CQKnownKeysTest
```
public CQKnownKeysTest()
```
- Method Detail
  - HydraTask_initializeClient
```
public static void HydraTask_initializeClient()
```
    Creates and initializes the singleton instance of CQTest in a client and start the CQs running.
  - HydraTask_initializeClientWithoutStartingCQs
```
public static void HydraTask_initializeClientWithoutStartingCQs()
```
    Creates and initializes the singleton instance of CQTest in a client without starting the CQs running.
  - HydraTask_initCombineTest
```
public static void HydraTask_initCombineTest()
```
  - HydraTask_initializeBridgeServer
```
public static void HydraTask_initializeBridgeServer()
```
    Creates and initializes a data store PR in a bridge server.
  - initializeRegion
```
protected void initializeRegion(String regDescriptName)
```
    Create a region with the given region description name.
    
    Parameters:
    
    regDescriptName - The name of a region description.
  - initializeInstance
```
public void initializeInstance()
```
    Initialize fields for this instance
  - StartTask_initialize
```
public static void StartTask_initialize()
```
    Hydra start task to initialize key intervals, which are ranges of keys which are to have an operation done on them (invalidate, destroy, etc)
  - HydraTask_loadRegion
```
public static void HydraTask_loadRegion()
```
    Hydra task to initialize a region and load it according to hydra param settings.
  - HydraTask_doOps
```
public static void HydraTask_doOps()
```
    Hydra task to execution ops, then stop scheduling.
  - HydraTask_waitForSilence
```
public static void HydraTask_waitForSilence()
```
    Hydra task to wait for a period of silence (30 seconds) to allow the server queues to drain to the clients.
  - HydraTask_startCQsRunning
```
public static void HydraTask_startCQsRunning()
```
    Hydra task to start the CQs running for this VM.
  - HydraTask_verifyRegionContents
```
public static void HydraTask_verifyRegionContents()
```
    Hydra task to verify the contents of the region after all ops. This MUST be called as a batched task, and will throw StopSchedulingTaskOnClientOrder when completed. It is necessary to reinitialize the verify state variables if this is called a second time in this VM, however an error is thrown if a second attempt it made without resetting the state variables.
  - HydraTask_verifyQueries
```
public static void HydraTask_verifyQueries()
```
    Hydra task to verify queries on the region after all ops. This MUST be called as a batched task, and will throw StopSchedulingTaskOnClientOrder when completed. It is necessary to reinitialize the verify state variables if this is called a second time in this VM, however an error is thrown if a second attempt it made without resetting the state variables.
  - HydraTask_verifyQueriesCombine
```
public static void HydraTask_verifyQueriesCombine()
```
    Hydra task to verify queries on the region after all ops for a test where executeWithInitialResults occurs concurrently with ops. We must combine the results of executeWithInitialResults and the cq events that come after
  - loadRegion
```
public void loadRegion()
```
    Load a region with keys and values. The number of keys and values is specified by the total number of keys in keyIntervals. This can be invoked by several threads to accomplish the work.
  - doOps
```
public void doOps(BitSet availableOps)
```
    Do operations on the REGION_NAME's keys using keyIntervals to specify which keys get which operations. This will return when all operations in all intervals have completed.
    
    Parameters:
    
    availableOps - - Bits which are true correspond to the operations that should be executed.
  - addNewKey
```
protected boolean addNewKey()
```
    Add a new key to REGION_NAME.
    
    Returns:
    
    true if all new keys have been added (specified by CQUtilPrms.numNewKeys)
  - updateExistingKey
```
protected boolean updateExistingKey()
```
    Update an existing key in region REGION_NAME. The keys to update are specified in keyIntervals.
    
    Returns:
    
    true if all keys to be updated have been completed.
  - localInvalidate
```
protected boolean localInvalidate()
```
    Locally invalidate a key in region REGION_NAME. The keys to locally invalidate are specified in keyIntervals.
    
    Returns:
    
    true if all keys to be locally invalidated have been completed.
  - invalidate
```
protected boolean invalidate()
```
    Invalidate a key in region REGION_NAME. The keys to invalidate are specified in keyIntervals.
    
    Returns:
    
    true if all keys to be invalidated have been completed.
  - localDestroy
```
protected boolean localDestroy()
```
    Locally destroy a key in region REGION_NAME. The keys to locally destroy are specified in keyIntervals.
    
    Returns:
    
    true if all keys to be locally destroyed have been completed.
  - destroy
```
protected boolean destroy()
```
    Destroy a key in region REGION_NAME. The keys to destroy are specified in keyIntervals.
    
    Returns:
    
    true if all keys to be destroyed have been completed.
  - get
```
protected boolean get()
```
    Do a get on a key in region REGION_NAME. Keys to get are specified in keyIntervals.
    
    Returns:
    
    true if all keys to have get performaed have been completed.
  - verifyRegionContents
```
public void verifyRegionContents()
```
    Verify the contents of the region, taking into account the keys that were destroyed, invalidated, etc (as specified in keyIntervals) Throw an error of any problems are detected. This must be called repeatedly by the same thread until StopSchedulingTaskOnClientOrder is thrown.
  - checkContainsKey
```
protected void checkContainsKey(Object key,
                                boolean expected,
                                String logStr)
```
    Check that containsKey() called on the tests' region has the expected result. Throw an error if any problems.
    
    Parameters:
    
    key - The key to check.
    
    expected - The expected result of containsKey
    
    logStr - Used if throwing an error due to an unexpected value.
  - checkContainsValueForKey
```
protected void checkContainsValueForKey(Object key,
                                        boolean expected,
                                        String logStr)
```
    Check that containsValueForKey() called on the tests' region has the expected result. Throw an error if any problems.
    
    Parameters:
    
    key - The key to check.
    
    expected - The expected result of containsValueForKey
    
    logStr - Used if throwing an error due to an unexpected value.
  - checkValue
```
protected void checkValue(Object key,
                          Object value)
```
    Check that the value of the given key is expected for this test. Throw an error if any problems.
    
    Parameters:
    
    key - The key to check.
    
    value - The value for the key.
    
    logStr - Used if throwing an error due to an unexpected value.
  - checkUpdatedValue
```
protected void checkUpdatedValue(Object key,
                                 Object value)
```
    Check that the value of the given key is expected as an updated value. Throw an error if any problems.
    
    Parameters:
    
    key - The key to check.
    
    value - The value for the key.
    
    logStr - Used if throwing an error due to an unexpected value.
  - verifyQueryResultsCombine
```
protected void verifyQueryResultsCombine()
```
    Verify the result of the CQs registered for this VM. Query results from executeWithInitialResults are combined with subsequent cq events to form the final result.
  - getOp
```
protected int getOp(BitSet bs,
                    int bsSize)
```
    Get a random operation to perform. The set of operations available are in the BitSet. These bits correspond to the operations defined in this class.
    
    Parameters:
    
    bs - True bits correspond to operations available to be chosen.
    
    bsSize - The number of bits to consider.
    
    Returns:
    
    An operation as defined in this class.
  - getValueToAdd
```
protected QueryObject getValueToAdd(Object key)
```
    Return a value to add to a region for the given key
  - getRegionKeySet
```
protected Set getRegionKeySet(com.gemstone.gemfire.cache.Region aRegion)
```
  - registerInterest
```
protected static void registerInterest(com.gemstone.gemfire.cache.Region aRegion)
```
    Register interest with ALL_KEYS, and InterestPolicyResult = KEYS_VALUES which is equivalent to a full GII.
    
    Parameters:
    
    aRegion - The region to register interest on.
  - initializeQueryService
```
protected void initializeQueryService()
```
  - logNumOps
```
protected void logNumOps()
```
    Log the number of ops that have completed.

Class CQKnownKeysTest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

testInstance

REGION_NAME

numNewKeys

keyIntervals

totalNumKeys

aRegion

minTaskGranularitySec

minTaskGranularityMS

isBridgeConfiguration

isBridgeClient

CQTestInstance

uniqueKeyIndex

queryMap

queryDepth

qService

VmIDStr

CQsOn

sleepBetweenOps

SLEEP_BETWEEN_OPS_MILLIS

verifyRegionContentsIndex

verifyRegionContentsErrStr

verifyRegionContentsCompleted

verifyQueryIterator

verifyQueryCount

INVALIDATE

LOCAL_INVALIDATE

DESTROY

LOCAL_DESTROY

UPDATE_EXISTING_KEY

GET

ADD_NEW_KEY

FIRST_OP

LAST_OP

operations

Constructor Detail

CQKnownKeysTest

Method Detail

HydraTask_initializeClient

HydraTask_initializeClientWithoutStartingCQs

HydraTask_initCombineTest

HydraTask_initializeBridgeServer

initializeRegion

initializeInstance

StartTask_initialize

HydraTask_loadRegion

HydraTask_doOps

HydraTask_waitForSilence

HydraTask_startCQsRunning

HydraTask_verifyRegionContents

HydraTask_verifyQueries

HydraTask_verifyQueriesCombine

loadRegion

doOps

addNewKey

updateExistingKey

localInvalidate

invalidate

localDestroy

destroy

get

verifyRegionContents

checkContainsKey

checkContainsValueForKey

checkValue

checkUpdatedValue

verifyQueryResultsCombine

getOp

getValueToAdd

getRegionKeySet

registerInterest

initializeQueryService

logNumOps