ProxyEventTest (GemFire XD Java API Documentation)

java.lang.Object
- event.ProxyEventTest

Direct Known Subclasses:

ProxySerialEntryEventTest, ProxySerialRegionEventTest
```
public class ProxyEventTest
extends Object
```
A Hydra test that concurrently performs a number of cache-related (both entry and region) operations. Along the way, it uses the 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.

Since:

5.0

See Also:

EventPrms

Field Summary

Fields
Modifier and Type	Field and Description
`protected static int`	`ADD_OPERATION`
`protected static int`	`CLEAR_OPERATION`
`protected String`	`clientName`
`protected static String`	`createCallbackPrefix`
`protected static int`	`DESTROY_OPERATION`
`protected static String`	`destroyCallbackPrefix`
`protected com.gemstone.gemfire.distributed.DistributedLockService`	`distLockService`
`protected static ProxyEventTest`	`eventTest`
`protected static int`	`INVALIDATE_OPERATION`
`protected static String`	`invalidateCallbackPrefix`
`protected boolean`	`isCarefulValidation`
`protected boolean`	`isMirrored`
`protected boolean`	`isSerialExecution`
`protected boolean`	`isSerialRR`
`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`
`protected int`	`maxRegions`
`protected static String`	`memberIdString`
`static int`	`MILLIS_TO_WAIT`
`protected long`	`minTaskGranularityMS`
`protected long`	`minTaskGranularitySec`
`protected static int`	`NO_OPERATION`
`protected int`	`numVMs`
`protected RandomValues`	`randomValues`
`protected static int`	`READ_OPERATION`
`protected static int`	`REGION_CLOSE_OPERATION`
`protected static String`	`regionDestroyCallbackPrefix`
`protected static String`	`regionInvalidateCallbackPrefix`
`protected String`	`regionName`
`protected com.gemstone.gemfire.cache.Region`	`shadow`
`String`	`shadowRegionName`
`protected static int`	`UPDATE_OPERATION`
`protected static String`	`updateCallbackPrefix`
`protected boolean`	`useEvictionController`
`protected boolean`	`useTransactions`

Constructor Summary

Constructors
Constructor and Description

ProxyEventTest()

Constructors
Constructor and Description
`ProxyEventTest()`

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`	`addRegion()` Creates a new subregion of a randomly-selected parent region (which could be the root region).
`protected void`	`addRegion(com.gemstone.gemfire.cache.Region parentRegion, String regionName)`
`protected void`	`addToRegion()` Random choose a region and add an object to it for the duration of minTaskGranularity hydra param
`protected void`	`checkEventCounters()` Must overridden in a subclass
`protected int`	`clearRegion()`
`protected int`	`clearRegion(com.gemstone.gemfire.cache.Region aRegion)` clears a specified region
`protected int`	`closeRegion()` Close a random region.
`protected int`	`closeRegion(com.gemstone.gemfire.cache.Region aRegion)`
`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 int`	`destroyRegion(boolean isLocalDestroy)` Destroys a random region.
`protected int`	`destroyRegion(boolean isLocalDestroy, com.gemstone.gemfire.cache.Region aRegion)`
`protected void`	`doEntryOperations(com.gemstone.gemfire.cache.Region aRegion)`
`protected void`	`doRegionOperations()`
`protected void`	`executeRegionOp()`
`protected int`	`faultInNewRegions()` Find regions created during the test (in any cache) using the `EventBB` and create those regions in this cache also.
`protected Object[]`	`faultInRegion(com.gemstone.gemfire.cache.Region parentRegion, String newRegionName, com.gemstone.gemfire.cache.RegionAttributes attr)` Create a region in this cache, which was previously created in another cache.
`protected long`	`getNumNonRootRegions()` Return the current number of non-root regions.
`protected int`	`getNumVMsWithListeners()`
`protected Object`	`getObjectToAdd(String name)` 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.
`protected com.gemstone.gemfire.cache.Region`	`getRandomRegion(boolean allowRootRegion)` Return a currently existing random region.
`protected Object`	`getUpdateObject(String name)` 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_addToRegion()` Adds new entries to randomly selected regions until the minimum task granularity has been reached.
`static void`	`HydraTask_doEntryOperations()` Performs randomly selected operations (add, invalidate, etc.) on the root region based on the weightings in `EventPrms.entryOperations`.
`static void`	`HydraTask_doRegionOperations()` Performs randomly selected operations (create new region, invalidate an entire randomly selected region, etc.) based on the weightings in `EventPrms.regionOperations`.The operations will continue to be performed until the minimum task granularity has been reached.
`static void`	`HydraTask_endTask()`
`static void`	`HydraTask_executeRegionOp()` For use in SerialRoundRobin (Region) Tests Duplicates the single Region Operation performed in the first member of the RoundRobin; validates counters appropriately
`static void`	`HydraTask_initialize()` Creates and initializes the singleton instance of `ProxyEventTest` in this VM.
`static void`	`HydraTask_iterate()`
`static void`	`HydraTask_printBB()`
`protected void`	`initialize()`
`protected void`	`invalidateObject(com.gemstone.gemfire.cache.Region aRegion, boolean isLocalInvalidate)`
`protected int`	`invalidateRegion(boolean isLocalInvalidate)` Invalidate a random region.
`protected int`	`invalidateRegion(boolean isLocalInvalidate, com.gemstone.gemfire.cache.Region aRegion)` Invalidate a specific region
`protected Object[]`	`iterateRegion(com.gemstone.gemfire.cache.Region aRegion, boolean allowZeroKeys, boolean allowZeroNonNullValues)` Used for end task validation, iterate the keys/values in the given region, checking that the key/value match according to the test strategy.
`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).
`protected void`	`writeMyRegionNames()`
`protected void`	`writeMyRegionNames(com.gemstone.gemfire.cache.Region excludeRegion)`

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

- Field Detail
  - eventTest
```
protected static ProxyEventTest eventTest
```
  - 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
  - REGION_CLOSE_OPERATION
```
protected static final int REGION_CLOSE_OPERATION
```
    See Also:
    
    Constant Field Values
  - CLEAR_OPERATION
```
protected static final int CLEAR_OPERATION
```
    See Also:
    
    Constant Field Values
  - NO_OPERATION
```
protected static final int NO_OPERATION
```
    See Also:
    
    Constant Field Values
  - useTransactions
```
protected boolean useTransactions
```
  - isSerialExecution
```
protected boolean isSerialExecution
```
  - isCarefulValidation
```
protected boolean isCarefulValidation
```
  - 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
```
  - useEvictionController
```
protected boolean useEvictionController
```
  - maxObjects
```
protected int maxObjects
```
  - maxRegions
```
protected int maxRegions
```
  - distLockService
```
protected com.gemstone.gemfire.distributed.DistributedLockService distLockService
```
  - isMirrored
```
protected boolean isMirrored
```
  - clientName
```
protected String clientName
```
  - shadow
```
protected com.gemstone.gemfire.cache.Region shadow
```
  - regionName
```
protected String regionName
```
  - shadowRegionName
```
public String shadowRegionName
```
  - isSerialRR
```
protected boolean isSerialRR
```
  - 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
  - memberIdString
```
protected static final String memberIdString
```
    See Also:
    
    Constant Field Values
  - LOCK_SERVICE_NAME
```
protected static String LOCK_SERVICE_NAME
```
  - LOCK_NAME
```
protected static String LOCK_NAME
```
- Constructor Detail
  - ProxyEventTest
```
public ProxyEventTest()
```
- Method Detail
  - HydraTask_initialize
```
public static void HydraTask_initialize()
```
    Creates and initializes the singleton instance of ProxyEventTest in this VM.
  - initialize
```
protected void initialize()
```
    See Also:
    
    HydraTask_initialize()
  - HydraTask_doEntryOperations
```
public static void HydraTask_doEntryOperations()
```
    Performs randomly selected operations (add, invalidate, etc.) on the root region based on the weightings in EventPrms.entryOperations. The operations will continue to be performed until the minimum task granularity has been reached.
  - HydraTask_doRegionOperations
```
public static void HydraTask_doRegionOperations()
```
    Performs randomly selected operations (create new region, invalidate an entire randomly selected region, etc.) based on the weightings in EventPrms.regionOperations.The operations will continue to be performed until the minimum task granularity has been reached.
  - HydraTask_addToRegion
```
public static void HydraTask_addToRegion()
```
    Adds new entries to randomly selected regions until the minimum task granularity has been reached.
  - doEntryOperations
```
protected void doEntryOperations(com.gemstone.gemfire.cache.Region aRegion)
```
    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.
  - doRegionOperations
```
protected void doRegionOperations()
```
    See Also:
    
    HydraTask_doRegionOperations()
  - HydraTask_executeRegionOp
```
public static void HydraTask_executeRegionOp()
```
    For use in SerialRoundRobin (Region) Tests Duplicates the single Region Operation performed in the first member of the RoundRobin; validates counters appropriately
  - executeRegionOp
```
protected void executeRegionOp()
```
    See Also:
    
    HydraTask_executeRegionOp()
  - addRegion
```
protected void addRegion()
```
    Creates a new subregion of a randomly-selected parent region (which could be the root region). The child region will have the same (or equivalent) region attributes as its parent.
  - addRegion
```
protected void addRegion(com.gemstone.gemfire.cache.Region parentRegion,
                         String regionName)
```
  - invalidateRegion
```
protected int invalidateRegion(boolean isLocalInvalidate)
```
    Invalidate a random region.
    
    Parameters:
    
    isLocalInvalidate - true if the invalidate should be a local invalidate, false otherwise.
  - invalidateRegion
```
protected int invalidateRegion(boolean isLocalInvalidate,
                               com.gemstone.gemfire.cache.Region aRegion)
```
    Invalidate a specific region
    
    Parameters:
    
    isLocalInvalidate - true if the invalidate should be a local invalidate, false otherwise.
    
    aRegion - - target region (for invalidation)
  - closeRegion
```
protected int closeRegion()
```
    Close a random region.
  - closeRegion
```
protected int closeRegion(com.gemstone.gemfire.cache.Region aRegion)
```
  - destroyRegion
```
protected int destroyRegion(boolean isLocalDestroy)
```
    Destroys a random region.
    
    Parameters:
    
    isLocalDestroy - true if the destroy should be a local destroy, false otherwise.
  - destroyRegion
```
protected int destroyRegion(boolean isLocalDestroy,
                            com.gemstone.gemfire.cache.Region aRegion)
```
  - clearRegion
```
protected int clearRegion()
```
  - clearRegion
```
protected int clearRegion(com.gemstone.gemfire.cache.Region aRegion)
```
    clears a specified region
    
    Parameters:
    
    aRegion - - target region (to clear)
  - addToRegion
```
protected void addToRegion()
```
    Random choose a region and add an object to it for the duration of minTaskGranularity hydra param
  - faultInNewRegions
```
protected int faultInNewRegions()
```
    Find regions created during the test (in any cache) using the EventBB and create those regions in this cache also. By doing this, a cache which did not originally create a region will be able to invalidate or destroy it.
    
    Returns:
    
    The number of regions created
  - faultInRegion
```
protected Object[] faultInRegion(com.gemstone.gemfire.cache.Region parentRegion,
                                 String newRegionName,
                                 com.gemstone.gemfire.cache.RegionAttributes attr)
```
    Create a region in this cache, which was previously created in another cache. Allow that the region to create may already exist or may have been destroyed.
    
    Parameters:
    
    parentRegion - The parent region of the region to create.
    
    newRegionName - The new of the new subregion of parentRegion.
    
    attr - The region attributes for the new region.
  - checkEventCounters
```
protected void checkEventCounters()
```
    Must overridden in a subclass
  - getObjectToAdd
```
protected Object getObjectToAdd(String name)
```
    Creates a new object with the given name to add to a region.
    
    See Also:
    
    BaseValueHolder, RandomValues
  - getUpdateObject
```
protected Object getUpdateObject(String name)
```
    Returns the "updated" value of the object with the given name.
    
    See Also:
    
    BaseValueHolder.getAlternateValueHolder(util.RandomValues)
  - 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)
  - HydraTask_printBB
```
public static void HydraTask_printBB()
                              throws Throwable
```
    Throws:
    
    Throwable
  - HydraTask_iterate
```
public static void HydraTask_iterate()
                              throws Throwable
```
    Throws:
    
    Throwable
  - HydraTask_endTask
```
public static void HydraTask_endTask()
                              throws Throwable
```
    Throws:
    
    Throwable
  - iterateRegion
```
protected Object[] iterateRegion(com.gemstone.gemfire.cache.Region aRegion,
                                 boolean allowZeroKeys,
                                 boolean allowZeroNonNullValues)
```
    Used for end task validation, iterate the keys/values in the given region, checking that the key/value match according to the test strategy.
    
    Parameters:
    
    aRegion - - the region to iterate.
    
    allowZeroKeys - - If the number of keys in the region is 0, then allow it if this is true, otherwise log an error to the return string.
    
    allowZeroNonNullValues - - If the number of non-null values in the region is 0, then allow it if this is true, otherwise log an error to the return string.
    
    Returns:
    
    [0] the number of keys in aRegion [1] the number of non-null values in aRegion [2] a String containg a description of any errors detected, or "" if none.
  - 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()
```
  - writeMyRegionNames
```
protected void writeMyRegionNames()
```
  - writeMyRegionNames
```
protected void writeMyRegionNames(com.gemstone.gemfire.cache.Region excludeRegion)
```
  - getRandomRegion
```
protected com.gemstone.gemfire.cache.Region getRandomRegion(boolean allowRootRegion)
```
    Return a currently existing random region. Assumes the root region exists.
    
    Parameters:
    
    allowRootRegion - true if this call can return the root region, false otherwise.
    
    Returns:
    
    A random region, or null of none available. Null can only be returned if allowRootRegion is false.
  - 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.
  - getNumNonRootRegions
```
protected long getNumNonRootRegions()
```
    Return the current number of non-root regions.
  - 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 ProxyEventTest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

eventTest

ADD_OPERATION

UPDATE_OPERATION

INVALIDATE_OPERATION

DESTROY_OPERATION

READ_OPERATION

LOCAL_INVALIDATE_OPERATION

LOCAL_DESTROY_OPERATION

REGION_CLOSE_OPERATION

CLEAR_OPERATION

NO_OPERATION

useTransactions

isSerialExecution

isCarefulValidation

MILLIS_TO_WAIT

numVMs

minTaskGranularitySec

minTaskGranularityMS

randomValues

useEvictionController

maxObjects

maxRegions

distLockService

isMirrored

clientName

shadow

regionName

shadowRegionName

isSerialRR

createCallbackPrefix

updateCallbackPrefix

invalidateCallbackPrefix

destroyCallbackPrefix

regionInvalidateCallbackPrefix

regionDestroyCallbackPrefix

memberIdString

LOCK_SERVICE_NAME

LOCK_NAME

Constructor Detail

ProxyEventTest

Method Detail

HydraTask_initialize

initialize

HydraTask_doEntryOperations

HydraTask_doRegionOperations

HydraTask_addToRegion

doEntryOperations

addObject

invalidateObject

destroyObject

updateObject

updateObject

readObject

doRegionOperations

HydraTask_executeRegionOp

executeRegionOp

addRegion

addRegion

invalidateRegion

invalidateRegion

closeRegion

closeRegion

destroyRegion

destroyRegion

clearRegion

clearRegion

addToRegion

faultInNewRegions

faultInRegion

checkEventCounters

getObjectToAdd

getUpdateObject

getNumVMsWithListeners

createRootRegions