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