util

Class PRObserver

java.lang.Object

com.gemstone.gemfire.internal.cache.control.InternalResourceManager.ResourceObserverAdapter

util.PRObserver

All Implemented Interfaces:

com.gemstone.gemfire.internal.cache.control.InternalResourceManager.ResourceObserver

Direct Known Subclasses:

EventPRObserver

public class PRObserver
extends com.gemstone.gemfire.internal.cache.control.InternalResourceManager.ResourceObserverAdapter

Class to observe when recovery or rebalancing occurs. The callbacks implemented here are called for both recovery and rebalancing.

Field Summary

Fields

Modifier and Type	Field and Description
static String	activityListKey
static String	movingBucket
static String	movingPrimary
static String	rebalRecovFinished
static String	rebalRecovStarted
static String	recoveryConflated

Constructor Summary

Constructors

Constructor and Description
PRObserver()

Method Summary

Modifier and Type	Method and Description
protected void	_addToActivityList(String activityStr) Add an activity to the activity List in the blackboard for this vm
protected static String	activityListToString(List activityList) Return a string representation of an activityList
protected void	addFinishToActivityList(Date finishDate, long finishTime, com.gemstone.gemfire.cache.Region aRegion) Add a conflated recovery activity to the activity List in the blackboard for this vm
protected static boolean	completedActivities(List activityList, int expectedNumActivities, boolean allowConflatedActivities, int numPRs, List prNames, int vmID) Given a list of recovery activites, determine whether a certain number has occurred for each of numPRs.
protected static String	getRegionNameFromActivity(String activityStr)
static void	initialize() Initialize counters.
static void	initialize(int vmId) Initialize counters for a particular vmid.
static void	installObserverHook() Install a hook to determine when rebalancing/recovery starts/stops
static void	installObserverHook(boolean recordBucketMovesArg, boolean recordPrimaryMovesArg) Install a hook to determine when rebalancing/recovery starts/stops
void	movingBucket(com.gemstone.gemfire.cache.Region region, int bucketId, com.gemstone.gemfire.distributed.DistributedMember source, com.gemstone.gemfire.distributed.DistributedMember target) Callback for moving a bucket
void	movingPrimary(com.gemstone.gemfire.cache.Region region, int bucketId, com.gemstone.gemfire.distributed.DistributedMember source, com.gemstone.gemfire.distributed.DistributedMember target) Callback for moving a primary
void	rebalancingOrRecoveryFinished(com.gemstone.gemfire.cache.Region region) Log that rebalancing/recovery has finished.
void	rebalancingOrRecoveryStarted(com.gemstone.gemfire.cache.Region region) Log that rebalancing/recovery has started.
void	recoveryConflated(com.gemstone.gemfire.internal.cache.PartitionedRegion region) Log that recovery was rejected because it was already in progress.
static void	verifyNoRebalRecov(Object noRebalRecovVMs) Verify rebalancing/recovery has not run for the given vms.
static boolean	waitForAnyRebalRecovToStart(long millisToWait, int millisToSleep) Wait for rebalancing/recovery to start in ANY vm.
protected static void	waitForEachVMToFinish(Object rebalRecovVMs, int numExpectedActivities, int numPRsToRebalRecov, List prNames, boolean allowConflation) Wait for vm(s) to finish rebalancing/recovery.
static void	waitForRebalRecov(Object rebalRecovVMs, int numRecovRebalActivities, int numPRsToRebalRecov, List prNames, Object noRebalRecovVMs, boolean allowRecovConflation) Wait for rebalanc/recovery to finish.
static boolean	waitForRebalRecovToStart(int vmID, long millisToWait, int millisToSleep) Wait for rebalancing/recovery to start in a particular vm.
static void	waitForRecovery(long recoveryDelay, long startupRecoveryDelay, Object startupRecoveryVMs, Object departedRecoveryVMs, int numDepartedRecoveries, int numPRsToRecover, List prNames, Object noRecoveryVMs) Wait for recovery after a stop and restart.
protected static void	waitForVMToFinish(Object rebalRecovVM, int numExpectedActivities, int numPRsToRebalRecov, List prNames, boolean allowConflation) Wait for a vm to finish rebalancing/recovery.

Methods inherited from class com.gemstone.gemfire.internal.cache.control.InternalResourceManager.ResourceObserverAdapter

rebalancingFinished, rebalancingStarted, recoveryFinished, recoveryStarted

Methods inherited from class java.lang.Object

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

Field Detail

activityListKey

public static final String activityListKey

See Also:

Constant Field Values

rebalRecovStarted

public static final String rebalRecovStarted

See Also:

Constant Field Values

rebalRecovFinished

public static final String rebalRecovFinished

See Also:

Constant Field Values

movingBucket

public static final String movingBucket

See Also:

Constant Field Values

movingPrimary

public static final String movingPrimary

See Also:

Constant Field Values

recoveryConflated

public static final String recoveryConflated

See Also:

Constant Field Values

Constructor Detail

PRObserver

public PRObserver()

Method Detail

rebalancingOrRecoveryStarted

public void rebalancingOrRecoveryStarted(com.gemstone.gemfire.cache.Region region)

Log that rebalancing/recovery has started. Mark in the blackboard the earliest start time for recovery. Record in the blackboard that a recovery has started. Note that for the earliest start time to be accurate, initialize() must have been called prior to expecting rebalancing/recovery.

Overrides:

rebalancingOrRecoveryStarted in class com.gemstone.gemfire.internal.cache.control.InternalResourceManager.ResourceObserverAdapter

Parameters:

region - The region that is undergoing rebalancing/recovery.

rebalancingOrRecoveryFinished

public void rebalancingOrRecoveryFinished(com.gemstone.gemfire.cache.Region region)

Log that rebalancing/recovery has finished. Mark in the blackboard the latest finish time for recovery. Record in the blackboard that a recovery has finished. Note that for the latest finish time to be accurate, initialize() must have been called prior to expecting rebalancing/recovery.

Overrides:

rebalancingOrRecoveryFinished in class com.gemstone.gemfire.internal.cache.control.InternalResourceManager.ResourceObserverAdapter

Parameters:

region - The region that finished rebalancing/recovery.

recoveryConflated

public void recoveryConflated(com.gemstone.gemfire.internal.cache.PartitionedRegion region)

Log that recovery was rejected because it was already in progress. Increment a counter that this vm rejected recovery.

Specified by:

recoveryConflated in interface com.gemstone.gemfire.internal.cache.control.InternalResourceManager.ResourceObserver

Overrides:

recoveryConflated in class com.gemstone.gemfire.internal.cache.control.InternalResourceManager.ResourceObserverAdapter

movingBucket

public void movingBucket(com.gemstone.gemfire.cache.Region region,
                         int bucketId,
                         com.gemstone.gemfire.distributed.DistributedMember source,
                         com.gemstone.gemfire.distributed.DistributedMember target)

Callback for moving a bucket

Specified by:

movingBucket in interface com.gemstone.gemfire.internal.cache.control.InternalResourceManager.ResourceObserver

Overrides:

movingBucket in class com.gemstone.gemfire.internal.cache.control.InternalResourceManager.ResourceObserverAdapter

movingPrimary

public void movingPrimary(com.gemstone.gemfire.cache.Region region,
                          int bucketId,
                          com.gemstone.gemfire.distributed.DistributedMember source,
                          com.gemstone.gemfire.distributed.DistributedMember target)

Callback for moving a primary

Specified by:

movingPrimary in interface com.gemstone.gemfire.internal.cache.control.InternalResourceManager.ResourceObserver

Overrides:

movingPrimary in class com.gemstone.gemfire.internal.cache.control.InternalResourceManager.ResourceObserverAdapter

installObserverHook

public static void installObserverHook()

Install a hook to determine when rebalancing/recovery starts/stops

installObserverHook

public static void installObserverHook(boolean recordBucketMovesArg,
                                       boolean recordPrimaryMovesArg)

Install a hook to determine when rebalancing/recovery starts/stops

initialize

public static void initialize()

Initialize counters. This should be called prior to every rebalance/recovery.

initialize

public static void initialize(int vmId)

Initialize counters for a particular vmid.

waitForRebalRecovToStart

public static boolean waitForRebalRecovToStart(int vmID,
                                               long millisToWait,
                                               int millisToSleep)

Wait for rebalancing/recovery to start in a particular vm.

Parameters:

vmID - Wait for this vmID to start rebalancing/recovery.

millisToWait - The number of milliseconds to wait for rebalancing/recovery to start.

millisToSleep - The number of milliseconds to sleep between polling for rebalancing/recovery.

Returns:

True if rebalancing/recovery started, false if not.

waitForAnyRebalRecovToStart

public static boolean waitForAnyRebalRecovToStart(long millisToWait,
                                                  int millisToSleep)

Wait for rebalancing/recovery to start in ANY vm.

Parameters:

millisToWait - The number of milliseconds to wait for rebalancing/recovery to start.

millisToSleep - The number of milliseconds to sleep between polling for rebalancing/recovery.

Returns:

True if rebalancing/recovery started, false if not.

waitForRebalRecov

public static void waitForRebalRecov(Object rebalRecovVMs,
                                     int numRecovRebalActivities,
                                     int numPRsToRebalRecov,
                                     List prNames,
                                     Object noRebalRecovVMs,
                                     boolean allowRecovConflation)

Wait for rebalanc/recovery to finish.

Parameters:

rebalRecovVMs - The vm(s) expecting rebalancing/recovery. This can either be a an Integer (a vmID), a ClientVmInfo containing a vmID, or a List of Integers or ClientVmInfo instances.

numRecovRebalActivities - The number of recovery/rebalance activities each vm should receive.

numPRsToRebalRecov - The number of PRs to rebalance/recover in each VM.

prNames - A List of Strings, where each string is the name of the PR to experience rebalanc/recovery. This is optional and can be null.

noRebalRecovVMs - The vm(s) expecting no rebalancing/recovery. This can either be a an Integer (a vmID), a ClientVmInfo containing a vmID, or a List of Integers or ClientVmInfo instances. This is optional and can be ull.

allowRebalRecovConflation - True if rebalancing/recovery conflation is allowed to have occurred in the rbalRecovVMs, false otherwise.

waitForRecovery

public static void waitForRecovery(long recoveryDelay,
                                   long startupRecoveryDelay,
                                   Object startupRecoveryVMs,
                                   Object departedRecoveryVMs,
                                   int numDepartedRecoveries,
                                   int numPRsToRecover,
                                   List prNames,
                                   Object noRecoveryVMs)

Wait for recovery after a stop and restart.

Parameters:

recoveryDelay - The recovery delay setting for departed vms.

startupRecoveryDelay - The startup recovery delay setting.

startupRecoveryVMs - The vm(s) expecting startup recovery. This can either be a an Integer (a vmID), a ClientVmInfo containing a vmID, or a List of Integers or ClientVmInfo instances.

departedRecoveryVMs - The vm(s) expecting departed recovery. This can either be a an Integer (a vmID), a ClientVmInfo containing a vmID, or a List of Integers or ClientVmInfo instances.

numDepartedRecoveries - The number of recovery activities the departedRecoveryVMs should receive (usually the number of vms that departed).

numPRsToRecovery - The number of PRs to recovery in the vm.

prNames - A List of Strings, where each string is the name of the PR to experience recovery. This is optional and can be null.

noRecoveryVMs - The vm(s) expecting no recovery. This can either be a an Integer (a vmID), a ClientVmInfo containing a vmID, or a List of Integers or ClientVmInfo instances. This is optional and can be ull.

verifyNoRebalRecov

public static void verifyNoRebalRecov(Object noRebalRecovVMs)

Verify rebalancing/recovery has not run for the given vms.

Parameters:

noRebalRecovVMs - The vm(s) expecting no rebalancing/recovery. This can either be a an Integer (a vmID), a ClientVmInfo containing a vmID, or a List of Integers or ClientVmInfo instances.

waitForVMToFinish

protected static void waitForVMToFinish(Object rebalRecovVM,
                                        int numExpectedActivities,
                                        int numPRsToRebalRecov,
                                        List prNames,
                                        boolean allowConflation)

Wait for a vm to finish rebalancing/recovery.

Parameters:

rebalRecovVM - A VM expected to rebalance/recover. This is either an Integer (vmId) or an instance of ClientVmInfo containing a vmId.

numExpectedActivities - The number of times rebalancing/recovery should either start/finish, or be conflated.

numPRsToRebalRecov - The number of PRs expected to rebalance/recover in recovRebalVMs.

prNames - A List of Strings, which are the names of the PRs expected for recovery. This is optional and can be null.

allowConflation - True if recovery conflation is allowed in the recoveryVM, false otherwise.

waitForEachVMToFinish

protected static void waitForEachVMToFinish(Object rebalRecovVMs,
                                            int numExpectedActivities,
                                            int numPRsToRebalRecov,
                                            List prNames,
                                            boolean allowConflation)

Wait for vm(s) to finish rebalancing/recovery.

Parameters:

rebalRecovVMs - The vm(s) expecting rebalancing/recovery. This can either be a an Integer (a vmID), a ClientVmInfo containing a vmID, or a List of Integers or ClientVmInfo instances.

numExpectedActivities - The number of times rebalancing/recovery should either start/finish, or be conflated for each PR in numPRsToRebalRecov.

numPRsToRebalRecov - The number of PRs expected to rebalance/recover in each vm in rebalRecovVMs.

prNames - A List of Strings, which are the names of the PRs expected for rebalancing/recovery. This is optional and can be null.

allowConflation - True if recovery conflation is allowed in the rebalRecovVMs, false otherwise.

completedActivities

protected static boolean completedActivities(List activityList,
                                             int expectedNumActivities,
                                             boolean allowConflatedActivities,
                                             int numPRs,
                                             List prNames,
                                             int vmID)

Given a list of recovery activites, determine whether a certain number has occurred for each of numPRs.

Parameters:

activityList - A List of Strings containing information about recovery activities (start/finish/conflated).

expectedNumActivities - The number of expected recovery activities.

allowConflatedActivities - True if the activities are allowed to be conflated activities, false otherwise.

numPRs - The number of distinct PRs that should rebalance/recover.

prNames - A List of PR names the activities must occur for, or null.

vmID - The vmID that we are checking activities for.

Returns:

true if the activityList contains expectedNumActivities, false otherwise.

addFinishToActivityList

protected void addFinishToActivityList(Date finishDate,
                                       long finishTime,
                                       com.gemstone.gemfire.cache.Region aRegion)

Add a conflated recovery activity to the activity List in the blackboard for this vm

_addToActivityList

protected void _addToActivityList(String activityStr)

Add an activity to the activity List in the blackboard for this vm

activityListToString

protected static String activityListToString(List activityList)

Return a string representation of an activityList

Parameters:

activityList - A list of rebalancing/recovery activites.

getRegionNameFromActivity

protected static String getRegionNameFromActivity(String activityStr)