util

Class StopStartVMs

java.lang.Object

java.lang.Thread

util.StopStartVMs

All Implemented Interfaces:

Runnable

public class StopStartVMs
extends Thread

This class is a thread that will stop a VM, wait for it to stop, then start another VM and wait for it to start. This is useful for concurrently stopping more than 1 VM, but with the ability to wait for a restart.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
StopStartVMs(ClientVmInfo aVmId, int howToStop) Constructor to specify stop and start.
StopStartVMs(ClientVmInfo aVmId, int howToStop, boolean doStop, boolean doStart) Constructor to specify stop only or start only or both.

Method Summary

Modifier and Type	Method and Description
static List	getAllVMs() Return a List of all ClientVmInfo instances in the StopStartVMs blackboard.
static String	getClientName(Integer vmID) Get the client name for the given vmID, by looking in the StopStartBB blackboard shared map.
static List	getMatchVMs(List vmInfoList, String matchStr) Get the vms whose client names contain matchStr
static Object[]	getOtherVMs(int numToTarget) Get a list of "other" vms, along with stop modes.
static Object[]	getOtherVMs(int numToTarget, String clientMatchStr) Get a list of "other" vms, along with stop modes.
static Object[]	getOtherVMsDivided() Return a List of all other vms except for one along with a parallel stop mode list, and also return the one vm not in the list.
static Object[]	getOtherVMsDivided(String[] excludedClientNames) Return a List of all other vms except for one along with a parallel stop mode list, and also return the one vm not in the list.
static Object[]	getOtherVMsWithExclude(int numToTarget, String clientExcludeStr) Get a list of "other" vms, along with stop modes.
static Object[]	getOtherVMsWithExcludeVmid(int numToTarget, String clientMatchStr, ArrayList<Integer> vmIds) Get a list of "other" vms, along with stop modes.
static void	joinStopStart(List targetVmList, List threadList) Waits for a List of threads concurrently stopping and starting Vms to finish, as returned by stopStartAsync(List,List).
static boolean	niceKillInProgress() Returns true if a NICE_KILL is in progress in this VM, false otherwise
void	run() Run method for this thread: if this thread is set to stop, then stop a VM and wait for it to stop.
static Object[]	shutDownAllMembers(com.gemstone.gemfire.admin.AdminDistributedSystem adminDS) Invokes AdminDistributedSystem.shutDownAllMembers() which disconnects all members but leaves the vms up (because hydra threads remain) including the possibility of this vm being disconnected, then this actually stops those vms (except this vm if it was targeted in the shutDownAllMembers...this vm will remain up but disconnect).
static Object[]	shutDownAllMembers(com.gemstone.gemfire.admin.AdminDistributedSystem adminDS, List<String> stopModes) Invokes AdminDistributedSystem.shutDownAllMembers() which disconnects all members but leaves the vms up (because hydra threads remain) including the possibility of this vm being disconnected, then this actually stops those vms (except this vm if it was targeted in the shutDownAllMembers...this vm will remain up but disconnect).
static List	startAsync(List targetVmList) Asynchronously start the given vms and return a List of threads that spawned the start.
static void	startVM(ClientVmInfo vm) Start a single vm.
static void	startVMs(ClientVmInfo aVM) Start a single vm.
static void	startVMs(List targetVmList) Concurrently start a List of Vms.
static void	StopStart_initTask() An init task to write ClientVmInfo instances to the blackboard, for use later in choosing vms to stop/start.
static List	stopStartAsync(List targetVmList, List stopModeList) Concurrently stops a List of Vms, then restart them.
static void	stopStartOtherVMs(int numToTarget) Concurrently stop and restart the specified number of VMs, other than this VM.
static void	stopStartVMs(List targetVmList, List stopModeList) Concurrently stops a List of VMs, then restarts them.
static void	stopVM(ClientVmInfo vm, String stopMode) Stop a single vm.
static List	stopVMs(int numVMsToStop) Concurrently stop the given number of vms other than this vm.
static void	stopVMs(List targetVmList, List stopModeList) Concurrently stop a List of Vms.

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Constructor Detail

StopStartVMs

public StopStartVMs(ClientVmInfo aVmId,
                    int howToStop)

Constructor to specify stop and start.

Parameters:

aVmId - The VmId of the VM to stop then restart.

howToStop - The hydra.ClientVmMgr stopMode (unused if stop is false).

StopStartVMs

public StopStartVMs(ClientVmInfo aVmId,
                    int howToStop,
                    boolean doStop,
                    boolean doStart)

Constructor to specify stop only or start only or both.

Parameters:

aVmId - The VmId of the VM to stop then restart.

howToStop - The hydra.ClientVmMgr stopMode (unused if stop is false).

Method Detail

run

public void run()

Run method for this thread: if this thread is set to stop, then stop a VM and wait for it to stop. If this thread is set to start then start a VM and wait for it to start. Any errors are placed in the blackboard errStr.

Specified by:

run in interface Runnable

Overrides:

run in class Thread

getOtherVMs

public static Object[] getOtherVMs(int numToTarget)

Get a list of "other" vms, along with stop modes. The "other" vms are any vms other than the currently executing vm. The stop mode for each VM is chosen from util.StopStartPrms.stopMode.

Parameters:

numToTarget - The number of VMs to target for a stop/start.

Throws:

TestException - if there aren't numVMsToStop VMs available.

getOtherVMs

public static Object[] getOtherVMs(int numToTarget,
                                   String clientMatchStr)

Get a list of "other" vms, along with stop modes. The "other" vms are any vms other than the currently executing vm. The stop mode for each VM is chosen from util.StopStartPrms.stopMode.

Parameters:

numVMsToTarget - The number of VMs to target for a stop/start.

clientMatchStr - A string the must be contained in the client name to be included in the vms to target, or null.

Throws:

TestException - if there aren't numToTarget VMs available.

getOtherVMsWithExclude

public static Object[] getOtherVMsWithExclude(int numToTarget,
                                              String clientExcludeStr)

Get a list of "other" vms, along with stop modes. The "other" vms are any vms other than the currently executing vm. The stop mode for each VM is chosen from util.StopStartPrms.stopMode.

Parameters:

numVMsToTarget - The number of VMs to target for a stop/start.

clientExcludeStr - Any vm name that contains this string as a substring is excluded from consideration.

Throws:

TestException - if there aren't numToTarget VMs available.

getOtherVMsWithExcludeVmid

public static Object[] getOtherVMsWithExcludeVmid(int numToTarget,
                                                  String clientMatchStr,
                                                  ArrayList<Integer> vmIds)

Get a list of "other" vms, along with stop modes. The "other" vms are any vms other than the currently executing vm and matching vmIds. The stop mode for each VM is chosen from util.StopStartPrms.stopMode.

Parameters:

numVMsToTarget - The number of VMs to target for a stop/start.

clientMatchStr - A string the must be contained in the client name to be included in the vms to target, or null.

vmIds - An ArrayList of Integer contains the vmIds not targeted to be stopped

Throws:

TestException - if there aren't numToTarget VMs available.

stopStartOtherVMs

public static void stopStartOtherVMs(int numToTarget)

Concurrently stop and restart the specified number of VMs, other than this VM. The stop mode for each VM is chosen from util.StopStartPrms.stopMode. Side effects: see stopStartVMs(List, List).

Parameters:

numToTarget - The number of VMs, other than this VM, to stop and restart.

Throws:

TestException - if there aren't numToTarget VMs available for stopping.

stopStartVMs

public static void stopStartVMs(List targetVmList,
                                List stopModeList)

Concurrently stops a List of VMs, then restarts them. Waits for the restart to complete before returning. Executes stopStartAsync(List,List) followed by joinStopStart(List,List).

Parameters:

targetVmList - A list of hydra.ClientVmInfos to stop then restart.

stopModeList - A parallel list of stop modes (Strings).

stopStartAsync

public static List stopStartAsync(List targetVmList,
                                  List stopModeList)

Concurrently stops a List of Vms, then restart them. Does not wait for the restart to complete before returning. This allows the caller to carry out operations concurrent with the stop and start activity, then wait for the restart to complete using #joinStopStartThreads(List,List). Side effects: For any VM which is performing a NICE_KILL because of this call, it is marked as such in the StopStartBB (blackboard). The blackboard will contain a key prefixed with util.StopStartVMs.NiceKillInProgress and appended to with its VmId. The value of this key is the true. This blackboard entry is for the convenience of the caller, and it is up to the caller to look for it or not. When a VM undergoes a NICE_KILL, the VM closes the cache and disconnects from the distributed system. Any threads in that VM doing work can get exceptions during the close and/or disconnect step. This blackboard entry is useful for those threads to allow exceptions when they know an exception is possible.

Parameters:

targetVmList - A list of hydra.ClientVmInfos to stop then restart.

stopModeList - A parallel list of stop modes (Strings).

Returns:

threadList The threads created to stop the VMs.

startAsync

public static List startAsync(List targetVmList)

Asynchronously start the given vms and return a List of threads that spawned the start. This allows the caller to carry out operations concurrent with the start activity, then wait for the start to complete using #joinStopStartThreads(List,List).

Parameters:

targetVmList - A list of hydra.ClientVmInfos to start.

Returns:

threadList The threads created to start the VMs.

joinStopStart

public static void joinStopStart(List targetVmList,
                                 List threadList)

Waits for a List of threads concurrently stopping and starting Vms to finish, as returned by stopStartAsync(List,List). Resets the niceKill blackboard entry for each vm is set to false.

Parameters:

targetVmList - A list of hydra.ClientVmInfos to stop then restart.

threadList - A parallel list of threads on whom to wait.

niceKillInProgress

public static boolean niceKillInProgress()

Returns true if a NICE_KILL is in progress in this VM, false otherwise

StopStart_initTask

public static void StopStart_initTask()

An init task to write ClientVmInfo instances to the blackboard, for use later in choosing vms to stop/start. This is only necessary if getOtherVMs(numToTarget, clientMatchStr) is used.

getAllVMs

public static List getAllVMs()

Return a List of all ClientVmInfo instances in the StopStartVMs blackboard.

stopVMs

public static void stopVMs(List targetVmList,
                           List stopModeList)

Concurrently stop a List of Vms. Wait for the operations to complete before returning. Side effects: For any VM which is performing a NICE_KILL because of this call, it is marked as such in the StopStartBB (blackboard). The blackboard will contain a key prefixed with util.StopStartVMs.NiceKillInProgress and appended to with its VmId. The value of this key is the true. This blackboard entry is for the convenience of the caller, and it is up to the caller to look for it or not. When a VM undergoes a NICE_KILL, the VM closes the cache and disconnects from the distributed system. Any threads in that VM doing work can get exceptions during the close and/or disconnect step. This blackboard entry is useful for those threads to allow exceptions when they know an exception is possible.

Parameters:

targetVmList - A list of hydra.ClientVmInfos to stop and/or start.

stopModeList - A parallel list of stop modes (Strings), if doStop is true.

stopVMs

public static List stopVMs(int numVMsToStop)

Concurrently stop the given number of vms other than this vm. Wait for the operations to complete before returning. Side effects: For any VM which is performing a NICE_KILL because of this call, it is marked as such in the StopStartBB (blackboard). The blackboard will contain a key prefixed with util.StopStartVMs.NiceKillInProgress and appended to with its VmId. The value of this key is the true. This blackboard entry is for the convenience of the caller, and it is up to the caller to look for it or not. When a VM undergoes a NICE_KILL, the VM closes the cache and disconnects from the distributed system. Any threads in that VM doing work can get exceptions during the close and/or disconnect step. This blackboard entry is useful for those threads to allow exceptions when they know an exception is possible.

Parameters:

numVMsToStop - The number of vms other than this vm to stop.

startVMs

public static void startVMs(List targetVmList)

Concurrently start a List of Vms. Wait for the operations to complete before returning.

Parameters:

targetVmList - A list of hydra.ClientVmInfos to stop and/or start.

startVMs

public static void startVMs(ClientVmInfo aVM)

Start a single vm. Wait for the operation to complete before returning.

Parameters:

targetVM - The VM to start.

getClientName

public static String getClientName(Integer vmID)

Get the client name for the given vmID, by looking in the StopStartBB blackboard shared map. The map must have been created by calling StopStart_initTask. If this method was never invoked, then null is returned as the clientName cannot be deteremined.

Parameters:

vmID - The vmID to get the client name for.

getMatchVMs

public static List getMatchVMs(List vmInfoList,
                               String matchStr)

Get the vms whose client names contain matchStr

Parameters:

vmInfoList - A List of ClientVmInfo instances.

matchStr - The string to check for in the client names.

startVM

public static void startVM(ClientVmInfo vm)

Start a single vm. This returns when the start is complete.

Parameters:

vm - The vm to start

stopVM

public static void stopVM(ClientVmInfo vm,
                          String stopMode)

Stop a single vm. This returns when the stop is complete.

Parameters:

vm - The vm to stop

stopMode - The stop mode to use when stopping the vm.

getOtherVMsDivided

public static Object[] getOtherVMsDivided()

Return a List of all other vms except for one along with a parallel stop mode list, and also return the one vm not in the list.

Returns:

[0] (List)A List of ClientVmInfo instances; this includes all vms except the current vm and except for one other vm. [1] (List) A parallel List to [0] containing stop modes. [2] (ClientVMInfo) The ClientVmInfo instance of the one vm excluded from [0] (other than this vm) [3] (String) The stop mode for [2] [4] (List) A List of ClientVmInfo instances for all vms except this one. [5] (List) A parallel List to [4] of stop modes.

getOtherVMsDivided

public static Object[] getOtherVMsDivided(String[] excludedClientNames)

Return a List of all other vms except for one along with a parallel stop mode list, and also return the one vm not in the list.

Returns:

[0] (List)A List of ClientVmInfo instances; this includes all vms except the current vm and except for one other vm. [1] (List) A parallel List to [0] containing stop modes. [2] (ClientVMInfo) The ClientVmInfo instance of the one vm excluded from [0] (other than this vm) [3] (String) The stop mode for [2] [4] (List) A List of ClientVmInfo instances for all vms except this one. [5] (List) A parallel List to [4] of stop modes.

shutDownAllMembers

public static Object[] shutDownAllMembers(com.gemstone.gemfire.admin.AdminDistributedSystem adminDS)

Invokes AdminDistributedSystem.shutDownAllMembers() which disconnects all members but leaves the vms up (because hydra threads remain) including the possibility of this vm being disconnected, then this actually stops those vms (except this vm if it was targeted in the shutDownAllMembers...this vm will remain up but disconnect). Stopped vms are stopped with ON_DEMAND restart. This returns when the vms disconnected by shutDownAllMembers() (other than this one) are all stopped .

Parameters:

adminDS - The admin distributed system instance to use to call shutdownAllMembers.

Returns:

An Array [0] List of ClientVmInfo instances describing the VMs that were stopped. [1] Set, the return from shutdownAllMembers()

Throws:

com.gemstone.gemfire.admin.AdminException - if the shutDownAllMembers call throws this exception.

shutDownAllMembers

public static Object[] shutDownAllMembers(com.gemstone.gemfire.admin.AdminDistributedSystem adminDS,
                                          List<String> stopModes)

Invokes AdminDistributedSystem.shutDownAllMembers() which disconnects all members but leaves the vms up (because hydra threads remain) including the possibility of this vm being disconnected, then this actually stops those vms (except this vm if it was targeted in the shutDownAllMembers...this vm will remain up but disconnect). Stopped vms are stopped with ON_DEMAND restart. This returns when the vms disconnected by shutDownAllMembers() (other than this one) are all stopped .

Parameters:

adminDS - The admin distributed system instance to use to call shutdownAllMembers.

stopModes - The stop modes to choose from.

Returns:

An Array [0] List of ClientVmInfo instances describing the VMs that were stopped. [1] Set, the return from shutdownAllMembers()

Throws:

com.gemstone.gemfire.admin.AdminException - if the shutDownAllMembers call throws this exception.