CQUtilPrms (GemFire XD Java API Documentation)

java.lang.Object
- hydra.BasePrms
- - cq.CQUtilPrms

```
public class CQUtilPrms
extends BasePrms
```
A class used to store keys for cq.CQUtil configuration settings.

Field Summary

Fields
Modifier and Type	Field and Description
`static Long`	`clientEntryOperations` (Vector of Strings) A list of entry operations allowed on a client, as long as the region size is < regionSizeThreshold.
`static Long`	`clientInFeederVm` (boolean) Whether or not the ops client is in a feeder task (in same DS w/bridge) Used to determine if INVALIDATE events should be seen in client VMs
`static Long`	`cqListener` (String) ClassName for CQListener
`static Long`	`CQsOn` (boolean) If true (the default), then the test is run with cqs executing, false otherwise.
`static Long`	`createIndex` (boolean) if true, bridges will create index.
`static Long`	`createMktValueIndex` (boolean) if true, bridges will create functional index on mktValue.
`static Long`	`createPrimaryIndex` (boolean) if true, bridges will create primary index on secId.
`static Long`	`createQtyIndex` (boolean) if true, bridges will create functional index on qty.
`static Long`	`edgePutAndVerify` (boolean) edges perform put operation and verify results
`static Long`	`edgeThreads` (int) The number of edge threads.
`static Long`	`edgeThreadsPerVM` (int) The number of edge threads per vm
`static Long`	`entryOperations` (Vector of Strings) A list of the operations on a region entry that this test is allowed to do, as long as the region size is < regionSizeThreshold.
`static Long`	`exactCounterValue` (boolean) Whether or not to require the exact CQEvent count (vs.
`static Long`	`feederThreads` (int) The number of feeder threads.
`static Long`	`highAvailability` (boolean) True if the test is doing high availability, false otherwise.
`static Long`	`logCQOperations` (boolean) Whether or not to log the results of operations initiated by doCQOperations().
`static Long`	`lowerThreshold` (int) The size of the partitioned region that will trigger the test to choose its operations from lowerThresholdOperations.
`static long`	`lowerThresholdClientOperations` (Vector of Strings) A list of the operations on a region entry that this test is allowed to do when the region size falls below lowerThresold in a bridge client.
`static Long`	`lowerThresholdOperations` (Vector of Strings) A list of the operations on a region entry that this test is allowed to do when the region size falls below lowerThresold.
`static Long`	`lowerThresholdServerOperations` (Vector of Strings) A list of the operations on a region entry that this test is allowed to do when the region size falls below lowerThresold in a bridge server.
`static Long`	`maxPutAllSize` (int) used to determine the maximum size of the putAllMap.
`static Long`	`minPutAllSize` (int) used to determine the mininum size of putAllMap.
`static Long`	`numBridges` (int) The number of bridge vms.
`static Long`	`numKeys` (int) The number of keys in the region.
`static Long`	`numNewKeys` (int) The number of new keys to add to the region.
`static Long`	`numOpsPerTask` (int) The global size of the partitioned region that will trigger the test to choose its operations from thresholdOperations.
`static Long`	`numQueriesPerClientVM` (String) The number of queries to execute per client VM in this test run.
`static Long`	`numVMsToStop` (int) The number of VMs to stop at a time during an HA test.
`static Long`	`objectType`
`static Long`	`primary` (String) used for query purpose, only entry operations on this key will be a qualified cq event
`static Long`	`queryDepth` (String) The number of levels in a QueryObject, which implies the number of levels in a query.
`static Long`	`QueryServicePoolName`
`static Long`	`QueryServiceUsingPool` (boolean) If true, then the test is run by obtaining QueryService from Pool, false the QueryService will be obtained using Cache.
`static Long`	`registerInterest` (boolean) Whether or not the CQEventTest initializeClientRegion method will also registerInterest (in all keys)
`static Long`	`secondsToRun` (int) The number of seconds to run a test (currently used for concurrent tests) to terminate the test.
`static Long`	`serverEntryOperations` (Vector of Strings) A list of entry operations allowed on a server, as long as the region size is < regionSizeThreshold.
`static Long`	`stopModes` (String) The possible stop modes for stopping a VM.
`static Long`	`testPrimaryIndex` (boolean) use certain query strings to test primary index.
`static Long`	`upperThreshold` (int) The upper size of the partitioned region that will trigger the test to choose its operations from upperThresholdOperations.
`static Long`	`upperThresholdClientOperations` (Vector of Strings) A list of the operations on a region entry that this test is allowed to do when the region exceeds upperThresold in a bridge client.
`static Long`	`upperThresholdOperations` (Vector of Strings) A list of the operations on a region entry that this test is allowed to do when the region exceeds upperThresold.
`static Long`	`upperThresholdServerOperations` (Vector of Strings) A list of the operations on a region entry that this test is allowed to do when the region exceeds upperThresold in a bridge server.
`static Long`	`useCQ` (boolean) Whether or not to execute CQ related operations Defaults to false
`static Long`	`useDeltaObjects` (boolean) True if the test should use delta objects.
`static Long`	`useUniqueKeys` (boolean) If true, then each thread uses a unique set of keys for its operations, false otherwise.
`static Long`	`valueConstraint` (String) valueConstraint class name

Fields inherited from class hydra.BasePrms
DASH, DEFAULT, NONE

Constructor Summary

Constructors
Constructor and Description

CQUtilPrms()

Constructors
Constructor and Description
`CQUtilPrms()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static com.gemstone.gemfire.cache.query.CqListener`	`getCQListener()` Returns the `CQListener` to be used in registering CQs via CQUtil
`static String`	`getQueryServicePoolName()`
`static String`	`getRegionPoolName()`
`static void`	`main(String[] args)`

Methods inherited from class hydra.BasePrms
dumpKeys, keyForName, nameForKey, setValues, tab, tasktab

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

- Field Detail
  - useCQ
```
public static Long useCQ
```
    (boolean) Whether or not to execute CQ related operations Defaults to false
  - cqListener
```
public static Long cqListener
```
    (String) ClassName for CQListener
  - logCQOperations
```
public static Long logCQOperations
```
    (boolean) Whether or not to log the results of operations initiated by doCQOperations(). Defaults to false
  - entryOperations
```
public static Long entryOperations
```
    (Vector of Strings) A list of the operations on a region entry that this test is allowed to do, as long as the region size is < regionSizeThreshold.
  - serverEntryOperations
```
public static Long serverEntryOperations
```
    (Vector of Strings) A list of entry operations allowed on a server, as long as the region size is < regionSizeThreshold.
  - clientEntryOperations
```
public static Long clientEntryOperations
```
    (Vector of Strings) A list of entry operations allowed on a client, as long as the region size is < regionSizeThreshold.
  - lowerThreshold
```
public static Long lowerThreshold
```
    (int) The size of the partitioned region that will trigger the test to choose its operations from lowerThresholdOperations.
  - lowerThresholdOperations
```
public static Long lowerThresholdOperations
```
    (Vector of Strings) A list of the operations on a region entry that this test is allowed to do when the region size falls below lowerThresold.
  - lowerThresholdServerOperations
```
public static Long lowerThresholdServerOperations
```
    (Vector of Strings) A list of the operations on a region entry that this test is allowed to do when the region size falls below lowerThresold in a bridge server.
  - lowerThresholdClientOperations
```
public static long lowerThresholdClientOperations
```
    (Vector of Strings) A list of the operations on a region entry that this test is allowed to do when the region size falls below lowerThresold in a bridge client.
  - upperThreshold
```
public static Long upperThreshold
```
    (int) The upper size of the partitioned region that will trigger the test to choose its operations from upperThresholdOperations.
  - upperThresholdOperations
```
public static Long upperThresholdOperations
```
    (Vector of Strings) A list of the operations on a region entry that this test is allowed to do when the region exceeds upperThresold.
  - upperThresholdServerOperations
```
public static Long upperThresholdServerOperations
```
    (Vector of Strings) A list of the operations on a region entry that this test is allowed to do when the region exceeds upperThresold in a bridge server.
  - upperThresholdClientOperations
```
public static Long upperThresholdClientOperations
```
    (Vector of Strings) A list of the operations on a region entry that this test is allowed to do when the region exceeds upperThresold in a bridge client.
  - numOpsPerTask
```
public static Long numOpsPerTask
```
    (int) The global size of the partitioned region that will trigger the test to choose its operations from thresholdOperations.
  - highAvailability
```
public static Long highAvailability
```
    (boolean) True if the test is doing high availability, false otherwise.
  - secondsToRun
```
public static Long secondsToRun
```
    (int) The number of seconds to run a test (currently used for concurrent tests) to terminate the test. 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.
  - numVMsToStop
```
public static Long numVMsToStop
```
    (int) The number of VMs to stop at a time during an HA test.
  - stopModes
```
public static Long stopModes
```
    (String) The possible stop modes for stopping a VM. Can be any of MEAN_EXIT, MEAN_KILL, NICE_EXIT, NICE_KILL.
  - queryDepth
```
public static Long queryDepth
```
    (String) The number of levels in a QueryObject, which implies the number of levels in a query.
  - numBridges
```
public static Long numBridges
```
    (int) The number of bridge vms.
  - feederThreads
```
public static Long feederThreads
```
    (int) The number of feeder threads.
  - edgeThreads
```
public static Long edgeThreads
```
    (int) The number of edge threads.
  - edgeThreadsPerVM
```
public static Long edgeThreadsPerVM
```
    (int) The number of edge threads per vm
  - edgePutAndVerify
```
public static Long edgePutAndVerify
```
    (boolean) edges perform put operation and verify results
  - testPrimaryIndex
```
public static Long testPrimaryIndex
```
    (boolean) use certain query strings to test primary index.
  - primary
```
public static Long primary
```
    (String) used for query purpose, only entry operations on this key will be a qualified cq event
  - createPrimaryIndex
```
public static Long createPrimaryIndex
```
    (boolean) if true, bridges will create primary index on secId.
  - createQtyIndex
```
public static Long createQtyIndex
```
    (boolean) if true, bridges will create functional index on qty.
  - createMktValueIndex
```
public static Long createMktValueIndex
```
    (boolean) if true, bridges will create functional index on mktValue.
  - createIndex
```
public static Long createIndex
```
    (boolean) if true, bridges will create index.
  - minPutAllSize
```
public static Long minPutAllSize
```
    (int) used to determine the mininum size of putAllMap.
  - maxPutAllSize
```
public static Long maxPutAllSize
```
    (int) used to determine the maximum size of the putAllMap.
  - useUniqueKeys
```
public static Long useUniqueKeys
```
    (boolean) If true, then each thread uses a unique set of keys for its operations, false otherwise. This is used to workaround ordering problems so verification can be done.
  - numQueriesPerClientVM
```
public static Long numQueriesPerClientVM
```
    (String) The number of queries to execute per client VM in this test run.
  - valueConstraint
```
public static Long valueConstraint
```
    (String) valueConstraint class name
  - registerInterest
```
public static Long registerInterest
```
    (boolean) Whether or not the CQEventTest initializeClientRegion method will also registerInterest (in all keys)
  - clientInFeederVm
```
public static Long clientInFeederVm
```
    (boolean) Whether or not the ops client is in a feeder task (in same DS w/bridge) Used to determine if INVALIDATE events should be seen in client VMs
  - numNewKeys
```
public static Long numNewKeys
```
    (int) The number of new keys to add to the region.
  - CQsOn
```
public static Long CQsOn
```
    (boolean) If true (the default), then the test is run with cqs executing, false otherwise. This is only used to isolate problems for debugging purposes.
  - useDeltaObjects
```
public static Long useDeltaObjects
```
    (boolean) True if the test should use delta objects.
  - numKeys
```
public static Long numKeys
```
    (int) The number of keys in the region.
  - exactCounterValue
```
public static Long exactCounterValue
```
    (boolean) Whether or not to require the exact CQEvent count (vs. a minimum value). Used by validation method (for cq/hct tests) in CQUtil.
  - QueryServiceUsingPool
```
public static Long QueryServiceUsingPool
```
    (boolean) If true, then the test is run by obtaining QueryService from Pool, false the QueryService will be obtained using Cache.
  - QueryServicePoolName
```
public static Long QueryServicePoolName
```
  - objectType
```
public static Long objectType
```
- Constructor Detail
  - CQUtilPrms
```
public CQUtilPrms()
```
- Method Detail
  - getCQListener
```
public static com.gemstone.gemfire.cache.query.CqListener getCQListener()
```
    Returns the CQListener to be used in registering CQs via CQUtil
    
    See Also:
    
    CQListener
  - getQueryServicePoolName
```
public static String getQueryServicePoolName()
```
  - getRegionPoolName
```
public static String getRegionPoolName()
```
  - main
```
public static void main(String[] args)
```

Class CQUtilPrms

Field Summary

Fields inherited from class hydra.BasePrms

Constructor Summary

Method Summary

Methods inherited from class hydra.BasePrms

Methods inherited from class java.lang.Object

Field Detail

useCQ

cqListener

logCQOperations

entryOperations

serverEntryOperations

clientEntryOperations

lowerThreshold

lowerThresholdOperations

lowerThresholdServerOperations

lowerThresholdClientOperations

upperThreshold

upperThresholdOperations

upperThresholdServerOperations

upperThresholdClientOperations

numOpsPerTask

highAvailability

secondsToRun

numVMsToStop

stopModes

queryDepth

numBridges

feederThreads

edgeThreads

edgeThreadsPerVM

edgePutAndVerify

testPrimaryIndex

primary

createPrimaryIndex

createQtyIndex

createMktValueIndex

createIndex

minPutAllSize

maxPutAllSize

useUniqueKeys

numQueriesPerClientVM

valueConstraint

registerInterest

clientInFeederVm

numNewKeys

CQsOn

useDeltaObjects

numKeys

exactCounterValue

QueryServiceUsingPool

QueryServicePoolName

objectType

Constructor Detail

CQUtilPrms

Method Detail

getCQListener

getQueryServicePoolName

getRegionPoolName

main