org.safs.tools.consoles

Class SAFSMonitorFrame

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

org.safs.tools.consoles.SAFSMonitorFrame

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.event.KeyListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class SAFSMonitorFrame
extends javax.swing.JFrame
implements java.awt.event.ActionListener, java.awt.event.KeyListener

A class to monitor and potentially abort running SAFS tests. This class leverages functionality built into the SAFS DefaultDriver. The default driver monitors the SAFSVARS variables:

'SAFS_DRIVER_CONTROL'
'SAFS_DRIVER_CONTROL_POF'

The driver can be shutdown by setting 'SAFS_DRIVER_CONTROL' to 'SHUTDOWN_HOOK'.
The driver can Pause On Failure by setting 'SAFS_DRIVER_CONTROL_POF' to 'ON'.

Author:

Carl Nagle, JunwuMa SEP 27, 2010 Added step retry feature.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SAFSMonitorFrame.debugAppMap a inner class to manage a temporary app map, adding it to chained maps or remove it from chained maps.
class	SAFSMonitorFrame.MonitorThread Routinely places the value of the SAFS_DRIVER_CONTROL variable into the status field.

Nested classes/interfaces inherited from class javax.swing.JFrame

javax.swing.JFrame.AccessibleJFrame

Nested classes/interfaces inherited from class java.awt.Frame

java.awt.Frame.AccessibleAWTFrame

Nested classes/interfaces inherited from class java.awt.Window

java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
(package private) javax.swing.JPanel	buttons
(package private) SAFSMonitorFrame.MonitorThread	monitor
(package private) java.lang.Thread	monitorthread
(package private) javax.swing.JButton	pause
static java.lang.String	PAUSE_ACTION
static java.lang.String	POF_ACTION
static java.lang.String	POW_ACTION
(package private) javax.swing.JButton	run
static java.lang.String	RUN_ACTION
static java.lang.String	SAVE_EDIT_ACTION
static boolean	shownOnFrontWhenPause If shownOnFrontWhenPause is true, the monitor window will be shown on top when test state is PAUSE, the monitor will be at back when state is not PAUSE.
(package private) STAFHelper	staf
static java.lang.String	STAF_PROCESS_ID
(package private) javax.swing.JTextField	status
(package private) javax.swing.JButton	step
static java.lang.String	STEP_ACTION
(package private) javax.swing.JButton	step_retry
static java.lang.String	STEP_RETRY_ACTION
(package private) javax.swing.JButton	stop
static java.lang.String	STOP_ACTION
(package private) javax.swing.JCheckBox	switchOfPOF
(package private) javax.swing.JCheckBox	switchOfPOW
(package private) javax.swing.JScrollPane	watchPane
(package private) javax.swing.JTable	watchTable
(package private) javax.swing.table.DefaultTableModel	watchTableModel
(package private) javax.swing.JToggleButton	weditToggle

Fields inherited from class javax.swing.JFrame

accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
SAFSMonitorFrame() A small monitor window allowing a user to abort SAFS tests run by a typical SAFS Driver.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent event)
void	dispose() Stops our MonitorThread prior to normal JFrame shutdown procedures.
protected void	init()
void	keyPressed(java.awt.event.KeyEvent e) Monitors the F11 key and initiates a driver shutdown if received.
void	keyReleased(java.awt.event.KeyEvent e)
void	keyTyped(java.awt.event.KeyEvent e)
static void	main(java.lang.String[] args) Used to run a SAFS Monitor independent of a running Driver.
void	setDriver(DriverInterface driver) set DriverInterface that is running the test.
void	setStatus() Set SAFS_DRIVER_CONTROL status information in the monitor window.
void	setSwitchOfPause(boolean turnon, java.lang.String controlVarName) Note: Set the 'POF CheckBox' and STAF Variable 'SAFS_DRIVER_CONTROL_POF' Note: Set the 'POW CheckBox' and STAF Variable 'SAFS_DRIVER_CONTROL_POW'

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, setVisible, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Detail

STOP_ACTION

public static final java.lang.String STOP_ACTION

See Also:

Constant Field Values

PAUSE_ACTION

public static final java.lang.String PAUSE_ACTION

See Also:

Constant Field Values

STEP_ACTION

public static final java.lang.String STEP_ACTION

See Also:

Constant Field Values

RUN_ACTION

public static final java.lang.String RUN_ACTION

See Also:

Constant Field Values

STEP_RETRY_ACTION

public static final java.lang.String STEP_RETRY_ACTION

See Also:

Constant Field Values

POF_ACTION

public static final java.lang.String POF_ACTION

See Also:

Constant Field Values

POW_ACTION

public static final java.lang.String POW_ACTION

See Also:

Constant Field Values

SAVE_EDIT_ACTION

public static final java.lang.String SAVE_EDIT_ACTION

See Also:

Constant Field Values

STAF_PROCESS_ID

public static final java.lang.String STAF_PROCESS_ID

See Also:

Constant Field Values

staf

STAFHelper staf

stop

javax.swing.JButton stop

pause

javax.swing.JButton pause

step

javax.swing.JButton step

run

javax.swing.JButton run

buttons

javax.swing.JPanel buttons

status

javax.swing.JTextField status

monitor

SAFSMonitorFrame.MonitorThread monitor

monitorthread

java.lang.Thread monitorthread

switchOfPOF

javax.swing.JCheckBox switchOfPOF

switchOfPOW

javax.swing.JCheckBox switchOfPOW

step_retry

javax.swing.JButton step_retry

weditToggle

javax.swing.JToggleButton weditToggle

watchTable

javax.swing.JTable watchTable

watchTableModel

javax.swing.table.DefaultTableModel watchTableModel

watchPane

javax.swing.JScrollPane watchPane

shownOnFrontWhenPause

public static boolean shownOnFrontWhenPause

If shownOnFrontWhenPause is true, the monitor window will be shown on top when test state is PAUSE, the monitor will be at back when state is not PAUSE. Otherwise, the monitor will stay at back whatever the test state is.

Constructor Detail

SAFSMonitorFrame

public SAFSMonitorFrame()

A small monitor window allowing a user to abort SAFS tests run by a typical SAFS Driver.

Method Detail

init

protected void init()

setDriver

public void setDriver(DriverInterface driver)

set DriverInterface that is running the test. Retry is forbidden without calling this.

Parameters:

driver, - the DriverInterface that is running the test

setStatus

public void setStatus()

Set SAFS_DRIVER_CONTROL status information in the monitor window.

main

public static void main(java.lang.String[] args)

Used to run a SAFS Monitor independent of a running Driver.

Parameters:

args - accepts and processes no args

keyPressed

public void keyPressed(java.awt.event.KeyEvent e)

Monitors the F11 key and initiates a driver shutdown if received.

Specified by:

keyPressed in interface java.awt.event.KeyListener

See Also:

sendShutdown()

keyReleased

public void keyReleased(java.awt.event.KeyEvent e)

Specified by:

keyReleased in interface java.awt.event.KeyListener

keyTyped

public void keyTyped(java.awt.event.KeyEvent e)

Specified by:

keyTyped in interface java.awt.event.KeyListener

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent event)

Specified by:

actionPerformed in interface java.awt.event.ActionListener

dispose

public void dispose()

Stops our MonitorThread prior to normal JFrame shutdown procedures.

Overrides:

dispose in class java.awt.Window

setSwitchOfPause

public void setSwitchOfPause(boolean turnon,
                             java.lang.String controlVarName)

Note: Set the 'POF CheckBox' and STAF Variable 'SAFS_DRIVER_CONTROL_POF' Note: Set the 'POW CheckBox' and STAF Variable 'SAFS_DRIVER_CONTROL_POW'

Parameters:

turnOn, - boolean, true->turn on the control variable; fasle->turn off.

controlVarName, - String, the control variable name. DriverInterface.DRIVER_CONTROL_POF_VAR DriverInterface.DRIVER_CONTROL_POW_VAR