util

Class OperationsClient

java.lang.Object

util.OperationsClient

Direct Known Subclasses:

ColocatedTxTest, CustomPartitionTest, ExecuteTx, MLRioTest, NetworkPartitionTest, Operations, Operations, RollingUpgradeTest, TxTest, WANOperationsClient, WANRecoveryTest

public class OperationsClient
extends Object

Utility class to provide doEntryOperations() functionality on a single region. Other classes may extend this class in order to provide basic operation coverage.

Since:

5.5

See Also:

OperationsClientPrms

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	createCallbackPrefix
protected static String	destroyCallbackPrefix
protected com.gemstone.gemfire.distributed.DistributedLockService	distLockService
protected static int	ENTRY_ADD_OPERATION
protected static int	ENTRY_DESTROY_OPERATION
protected static int	ENTRY_GET_NEW_OPERATION
protected static int	ENTRY_GET_OPERATION
protected static int	ENTRY_INVALIDATE_OPERATION
protected static int	ENTRY_LOCAL_DESTROY_OPERATION
protected static int	ENTRY_LOCAL_INVALIDATE_OPERATION
protected static int	ENTRY_PUTALL_OPERATION
protected static int	ENTRY_UPDATE_OPERATION
protected static String	getCallbackPrefix
protected static String	invalidateCallbackPrefix
protected static String	LOCK_NAME
protected static String	LOCK_SERVICE_NAME
protected boolean	lockOperations
protected int	lowerThreshold
protected long	minTaskGranularityMS
protected long	minTaskGranularitySec
protected int	numOpsPerTask
protected static int	PUT_IF_ABSENT_OPERATION
protected RandomValues	randomValues
protected static String	regionDestroyCallbackPrefix
protected static String	regionInvalidateCallbackPrefix
protected static int	REMOVE_OPERATION
protected static int	REPLACE_OPERATION
protected static String	updateCallbackPrefix
protected int	upperThreshold
protected boolean	useTransactions
protected static String	VmIDStr

Constructor Summary

Constructors

Constructor and Description
OperationsClient()

Method Summary

Modifier and Type	Method and Description
protected void	addEntry(com.gemstone.gemfire.cache.Region aRegion) Add a new entry to the given region.
static void	createLocatorTask() Creates a (disconnected) locator.
protected void	destroyEntry(com.gemstone.gemfire.cache.Region aRegion, boolean isLocalDestroy) Destroy an entry in the given region.
protected void	doEntryOperations(com.gemstone.gemfire.cache.Region aRegion) Do random entry operations on the given region ending either with minTaskGranularityMS or numOpsPerTask.
protected Object	getExistingKey(com.gemstone.gemfire.cache.Region aRegion) Return a random key currently in the given region.
protected List	getExistingKeys(com.gemstone.gemfire.cache.Region aRegion, int numKeysToGet)
protected void	getKey(com.gemstone.gemfire.cache.Region aRegion) Get an existing key in the given region if one is available, otherwise get a new key.
protected Object	getNewKey() Return a new key, never before used in the test.
protected void	getNewKey(com.gemstone.gemfire.cache.Region aRegion) Get a new key int the given region.
protected int	getOperation(Long whichPrm) Get a random operation using the given hydra parameter.
protected Object	getRecentKey(com.gemstone.gemfire.cache.Region aRegion, int recentHistory) Return a random recently used key.
protected BaseValueHolder	getUpdateObject(com.gemstone.gemfire.cache.Region aRegion, Object key) Return an object to be used to update the given key.
BaseValueHolder	getValueForKey(Object key) Return a value for the given key
void	initializeOperationsClient()
protected void	invalidateEntry(com.gemstone.gemfire.cache.Region aRegion, boolean isLocalInvalidate) Invalidate an entry in the given region.
protected void	putAll(com.gemstone.gemfire.cache.Region r) putall a map to the given region.
protected void	putIfAbsent(com.gemstone.gemfire.cache.Region aRegion, boolean logAddition) ConcurrentMap API testing
protected void	remove(com.gemstone.gemfire.cache.Region aRegion) ConcurrentMap API testing
protected void	remove(com.gemstone.gemfire.cache.Region aRegion, Object name, Object oldVal)
protected void	replace(com.gemstone.gemfire.cache.Region aRegion) Updates the "first" entry in a given region
protected void	replace(com.gemstone.gemfire.cache.Region aRegion, Object name) Updates the entry with the given key (name) in the given region.
static void	startAndConnectLocatorTask() Connects a locator to its (admin-only) distributed system.
static void	stopLocatorTask() Stops a locator.
protected void	updateEntry(com.gemstone.gemfire.cache.Region aRegion) Update an existing entry in the given region.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ENTRY_ADD_OPERATION

protected static final int ENTRY_ADD_OPERATION

See Also:

Constant Field Values

ENTRY_DESTROY_OPERATION

protected static final int ENTRY_DESTROY_OPERATION

See Also:

Constant Field Values

ENTRY_INVALIDATE_OPERATION

protected static final int ENTRY_INVALIDATE_OPERATION

See Also:

Constant Field Values

ENTRY_LOCAL_DESTROY_OPERATION

protected static final int ENTRY_LOCAL_DESTROY_OPERATION

See Also:

Constant Field Values

ENTRY_LOCAL_INVALIDATE_OPERATION

protected static final int ENTRY_LOCAL_INVALIDATE_OPERATION

See Also:

Constant Field Values

ENTRY_UPDATE_OPERATION

protected static final int ENTRY_UPDATE_OPERATION

See Also:

Constant Field Values

ENTRY_GET_OPERATION

protected static final int ENTRY_GET_OPERATION

See Also:

Constant Field Values

ENTRY_GET_NEW_OPERATION

protected static final int ENTRY_GET_NEW_OPERATION

See Also:

Constant Field Values

PUT_IF_ABSENT_OPERATION

protected static final int PUT_IF_ABSENT_OPERATION

See Also:

Constant Field Values

REMOVE_OPERATION

protected static final int REMOVE_OPERATION

See Also:

Constant Field Values

REPLACE_OPERATION

protected static final int REPLACE_OPERATION

See Also:

Constant Field Values

ENTRY_PUTALL_OPERATION

protected static final int ENTRY_PUTALL_OPERATION

See Also:

Constant Field Values

LOCK_SERVICE_NAME

protected static String LOCK_SERVICE_NAME

LOCK_NAME

protected static String LOCK_NAME

getCallbackPrefix

protected static final String getCallbackPrefix

See Also:

Constant Field Values

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

VmIDStr

protected static final String VmIDStr

See Also:

Constant Field Values

minTaskGranularitySec

protected long minTaskGranularitySec

minTaskGranularityMS

protected long minTaskGranularityMS

numOpsPerTask

protected int numOpsPerTask

randomValues

protected RandomValues randomValues

upperThreshold

protected int upperThreshold

lowerThreshold

protected int lowerThreshold

lockOperations

protected boolean lockOperations

distLockService

protected com.gemstone.gemfire.distributed.DistributedLockService distLockService

useTransactions

protected boolean useTransactions

Constructor Detail

OperationsClient

public OperationsClient()

Method Detail

createLocatorTask

public static void createLocatorTask()

Creates a (disconnected) locator.

startAndConnectLocatorTask

public static void startAndConnectLocatorTask()

Connects a locator to its (admin-only) distributed system.

stopLocatorTask

public static void stopLocatorTask()

Stops a locator.

initializeOperationsClient

public void initializeOperationsClient()

doEntryOperations

protected void doEntryOperations(com.gemstone.gemfire.cache.Region aRegion)

Do random entry operations on the given region ending either with minTaskGranularityMS or numOpsPerTask.

addEntry

protected void addEntry(com.gemstone.gemfire.cache.Region aRegion)

Add a new entry to the given region.

Parameters:

aRegion - The region to use for adding a new entry.

putIfAbsent

protected void putIfAbsent(com.gemstone.gemfire.cache.Region aRegion,
                           boolean logAddition)

ConcurrentMap API testing

putAll

protected void putAll(com.gemstone.gemfire.cache.Region r)

putall a map to the given region.

Parameters:

aRegion - The region to use for putall a map.

invalidateEntry

protected void invalidateEntry(com.gemstone.gemfire.cache.Region aRegion,
                               boolean isLocalInvalidate)

Invalidate an entry in the given region.

Parameters:

aRegion - The region to use for invalidating an entry.

isLocalInvalidate - True if the invalidate should be local, false otherwise.

destroyEntry

protected void destroyEntry(com.gemstone.gemfire.cache.Region aRegion,
                            boolean isLocalDestroy)

Destroy an entry in the given region.

Parameters:

aRegion - The region to use for destroying an entry.

isLocalDestroy - True if the destroy should be local, false otherwise.

remove

protected void remove(com.gemstone.gemfire.cache.Region aRegion)

ConcurrentMap API testing

remove

protected void remove(com.gemstone.gemfire.cache.Region aRegion,
                      Object name,
                      Object oldVal)

updateEntry

protected void updateEntry(com.gemstone.gemfire.cache.Region aRegion)

Update an existing entry in the given region. If there are no available keys in the region, then this is a noop.

Parameters:

aRegion - The region to use for updating an entry.

replace

protected void replace(com.gemstone.gemfire.cache.Region aRegion)

Updates the "first" entry in a given region

replace

protected void replace(com.gemstone.gemfire.cache.Region aRegion,
                       Object name)

Updates the entry with the given key (name) in the given region.

getKey

protected void getKey(com.gemstone.gemfire.cache.Region aRegion)

Get an existing key in the given region if one is available, otherwise get a new key.

Parameters:

aRegion - The region to use for getting an entry.

getNewKey

protected void getNewKey(com.gemstone.gemfire.cache.Region aRegion)

Get a new key int the given region.

Parameters:

aRegion - The region to use for getting an entry.

getValueForKey

public BaseValueHolder getValueForKey(Object key)

Return a value for the given key

getNewKey

protected Object getNewKey()

Return a new key, never before used in the test.

getRecentKey

protected Object getRecentKey(com.gemstone.gemfire.cache.Region aRegion,
                              int recentHistory)

Return a random recently used key.

Parameters:

aRegion - The region to use for getting a recently used key.

recentHistory - The number of most recently used keys to consider for returning.

getUpdateObject

protected BaseValueHolder getUpdateObject(com.gemstone.gemfire.cache.Region aRegion,
                                          Object key)

Return an object to be used to update the given key. If the value for the key is a ValueHolder, then get an alternate value which is similar to it's previous value (see ValueHolder.getAlternateValueHolder()).

Parameters:

aRegion - The region which possible contains key.

key - The key to get a new value for.

getOperation

protected int getOperation(Long whichPrm)

Get a random operation using the given hydra parameter.

Parameters:

whichPrm - A hydra parameter which specifies random operations.

getExistingKey

protected Object getExistingKey(com.gemstone.gemfire.cache.Region aRegion)

Return a random key currently in the given region.

Parameters:

aRegion - The region to use for getting an existing key (may or may not be a partitioned region).

getExistingKeys

protected List getExistingKeys(com.gemstone.gemfire.cache.Region aRegion,
                               int numKeysToGet)