org.safs.tools.consoles

Class JavaJVMConsole

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

org.safs.tools.consoles.JavaJVMConsole

All Implemented Interfaces:

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

Direct Known Subclasses:

GenericJavaConsoleRunner, SeleniumServerRunner

public abstract class JavaJVMConsole
extends javax.swing.JFrame
implements java.lang.Runnable, java.awt.event.ActionListener

Provides a JFrame console as the main application to be run. Subclasses will provide a public static void main(String[]) and any associated methods that will know how to "run" their specific Java application in this JVM with the JFrame console this class automatically provides.

This is done for cases when Eclipse and other processes want to launch a Java Process but have no visible console.

Example usage (from org.safs.selenium.utils.SeleniumServerRunner):

 public class SeleniumServerRunner extends JavaJVMConsole{
 
        public static void main(String[] args) {
   
            String[] passArgs = new String[0];
                SeleniumServerRunner console;
                try{
                    console = new SeleniumServerRunner();
                    passArgs = processArgs(args); // -jar path/To/selenium-server-standalone.jar passed in args
                    Class aclass = Class.forName("org.openqa.grid.selenium.GridLauncher");
                    Method main = aclass.getMethod("main", String[].class);
                    main.invoke(null, new Object[]{passArgs});
                }
                catch(Throwable everything){ ...
 

Author:

Carl Nagle, Carl Nagle NOV 19, 2014 Fix performance issues slowing down contained processes.

See Also:

Serialized Form

Nested Class Summary

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
static java.lang.String	DEFAULT_RMISERVER_CLASSNAME 'org.safs.selenium.rmi.server.SeleniumServer'
static boolean	DEFAULT_SEARCH_MATCH_CASE
protected javax.swing.JTextArea	display JTextArea containing the text data normally sent to System.out and System.err.
protected int	keep_mode
static int	KEEP_MODE_FIFO Limit the number of text lines kept and displayed to the numberOfRows in the textarea.
protected int	lastFoundPosition The position of the token found last time in the text area 'display'.
static java.lang.String	MENU_EDIT
static java.lang.String	MENU_FILE
static java.lang.String	MENU_ITEM_CLEAR
static java.lang.String	MENU_ITEM_EXIT
static java.lang.String	MENU_ITEM_FIND
static java.lang.String	MENU_ITEM_FIND_NEXT
static java.lang.String	MENU_ITEM_FIND_PREVIOUS
static java.lang.String	MENU_ITEM_SAVE
static java.lang.String	MENU_SEARCH
(package private) static java.lang.String	nl
protected int	numberOfrows
protected boolean	outputToConsole As the STANDARD out/err has been redirected to this JavaJVMConsole, we need a way to get the 'execution message' on STANDARD out/err. If outputToConsole is true, the 'execution message' will also be printed to STANDARD out/err.
static java.lang.String	PARAM_STATE '-state' specifies the console window's state. "-state MIN|MAX|NORMAL|MINIMIZE|MAXIMIZE"
static int	PAUSE_BEFORE_OUTPUT_READY The default time (in milliseconds) to sleep before the out/err output-stream is ready
protected int	pauseBeforeReady This field represents the time (in milliseconds) to sleep before the out/err output-stream is ready. The default value is 100 milliseconds.
static java.lang.String	PROPERTY_RMISERVER 'safs.rmi.server' JVM command line: -Dsafs.rmi.server=org.safs.selenium.rmi.server.SeleniumServer
protected boolean	shutdown Set this true to allow the monitoring thread to shutdown.
protected java.lang.String	state The console winodw's state to set.
static java.lang.String	STATE_DEFAULT
static java.lang.String	STATE_MAX
static java.lang.String	STATE_MAXIMIZE
static java.lang.String	STATE_MIN
static java.lang.String	STATE_MINIMIZE
static java.lang.String	STATE_NORMAL
protected java.lang.String	token The text to search in the text area 'display'.
protected javax.swing.JComboBox<java.lang.String>	tokenCombobox The combo-box for containing the search history in search dialog.
protected javax.swing.JCheckBox	tokenMatchCaseCheckbox The check-box to tell if the search is case sensitive in search dialog.

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

Modifier	Constructor and Description
protected	JavaJVMConsole()
protected	JavaJVMConsole(boolean outputToConsole)
protected	JavaJVMConsole(boolean outputToConsole, java.lang.String state)

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent event)
static void	addFile(java.io.File f) Adds a File to the System runtime classpath. Calls addURL(URL)
static void	addFile(java.lang.String s) Adds a file to the System runtime classpath. Calls addFile(File).
static void	addURL(java.net.URL u) Adds the content pointed by the URL to the System runtime classpath.
static void	clearHighLight(javax.swing.JTextArea display, java.lang.Object tag) Clear highlight in the text area.
protected javax.swing.JMenuItem	createJMenuItem(java.lang.String name, int mnemonicKeyIndex, int accelerateKey, int accelerateModifier) Create menu item with mnemonic and accelerate key. Add ActionListener for the menu item.
protected void	displayLine(java.lang.String message) DO NOT USE.
int	getPauseBeforeReady()
static void	highLight(javax.swing.JTextArea display, int position, int length) Highlight some text in the text area.
protected boolean	highlightInDispaly(boolean forwardSearch) Find a token within Text Area 'display', if found then highlight it.
void	init() Initialize the console's UI elements. Start a thread to redirect the stdout/stderr. This method MUST be called after calling the constructors.
void	maximize() Maximize the console window.
void	minimize() Minimize the console window.
void	restore() Restore the console window to its normal size.
void	run() Continuously monitors the JVM out and err streams routing them to the local JFrame display.
static boolean	search(javax.swing.text.Document document, int position, java.lang.String token, boolean caseSensitive) Search a token within a Document, return true if found.
void	setPauseBeforeReady(int pauseBeforeReady)
protected void	setState(java.lang.String state) Set the console window's state.
protected boolean	showSearchDialog() Show the dialog for searching token.

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, dispose, 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

display

protected javax.swing.JTextArea display

JTextArea containing the text data normally sent to System.out and System.err. It may not have ALL of the data if the output has exceeded the 200 lines provided.

shutdown

protected boolean shutdown

Set this true to allow the monitoring thread to shutdown. This would normally be done by subclasses that actually monitor external processes. For example, when launching and providing a console for some other process--like STAF. In that scenario, we have to monitor the process to know when it has exited so that we know we can shutdown our Console window and this Java JVM.

outputToConsole

protected boolean outputToConsole

As the STANDARD out/err has been redirected to this JavaJVMConsole, we need a way to get the 'execution message' on STANDARD out/err.
If outputToConsole is true, the 'execution message' will also be printed to STANDARD out/err.

PAUSE_BEFORE_OUTPUT_READY

public static final int PAUSE_BEFORE_OUTPUT_READY

The default time (in milliseconds) to sleep before the out/err output-stream is ready

See Also:

Constant Field Values

pauseBeforeReady

protected int pauseBeforeReady

This field represents the time (in milliseconds) to sleep before the out/err output-stream is ready.
The default value is 100 milliseconds.

KEEP_MODE_FIFO

public static final int KEEP_MODE_FIFO

Limit the number of text lines kept and displayed to the numberOfRows in the textarea. When the number of lines exceeds the number of rows the oldest line is removed as the newest line is added.

See Also:

Constant Field Values

numberOfrows

protected int numberOfrows

keep_mode

protected int keep_mode

nl

static final java.lang.String nl

See Also:

Constant Field Values

MENU_FILE

public static final java.lang.String MENU_FILE

See Also:

Constant Field Values

MENU_ITEM_SAVE

public static final java.lang.String MENU_ITEM_SAVE

See Also:

Constant Field Values

MENU_ITEM_EXIT

public static final java.lang.String MENU_ITEM_EXIT

See Also:

Constant Field Values

MENU_EDIT

public static final java.lang.String MENU_EDIT

See Also:

Constant Field Values

MENU_ITEM_CLEAR

public static final java.lang.String MENU_ITEM_CLEAR

See Also:

Constant Field Values

MENU_SEARCH

public static final java.lang.String MENU_SEARCH

See Also:

Constant Field Values

MENU_ITEM_FIND

public static final java.lang.String MENU_ITEM_FIND

See Also:

Constant Field Values

MENU_ITEM_FIND_NEXT

public static final java.lang.String MENU_ITEM_FIND_NEXT

See Also:

Constant Field Values

MENU_ITEM_FIND_PREVIOUS

public static final java.lang.String MENU_ITEM_FIND_PREVIOUS

See Also:

Constant Field Values

DEFAULT_SEARCH_MATCH_CASE

public static final boolean DEFAULT_SEARCH_MATCH_CASE

See Also:

Constant Field Values

token

protected java.lang.String token

The text to search in the text area 'display'.

lastFoundPosition

protected int lastFoundPosition

The position of the token found last time in the text area 'display'.

PARAM_STATE

public static final java.lang.String PARAM_STATE

'-state' specifies the console window's state.
"-state MIN|MAX|NORMAL|MINIMIZE|MAXIMIZE"

See Also:

Constant Field Values

STATE_MAX

public static final java.lang.String STATE_MAX

See Also:

Constant Field Values

STATE_MAXIMIZE

public static final java.lang.String STATE_MAXIMIZE

See Also:

Constant Field Values

STATE_MIN

public static final java.lang.String STATE_MIN

See Also:

Constant Field Values

STATE_MINIMIZE

public static final java.lang.String STATE_MINIMIZE

See Also:

Constant Field Values

STATE_NORMAL

public static final java.lang.String STATE_NORMAL

See Also:

Constant Field Values

STATE_DEFAULT

public static final java.lang.String STATE_DEFAULT

See Also:

Constant Field Values

state

protected java.lang.String state

The console winodw's state to set. The default is STATE_NORMAL.
It could also be STATE_MAX or STATE_MIN.

tokenCombobox

protected javax.swing.JComboBox<java.lang.String> tokenCombobox

The combo-box for containing the search history in search dialog.

tokenMatchCaseCheckbox

protected javax.swing.JCheckBox tokenMatchCaseCheckbox

The check-box to tell if the search is case sensitive in search dialog.

PROPERTY_RMISERVER

public static final java.lang.String PROPERTY_RMISERVER

'safs.rmi.server'
JVM command line: -Dsafs.rmi.server=org.safs.selenium.rmi.server.SeleniumServer

See Also:

Constant Field Values

DEFAULT_RMISERVER_CLASSNAME

public static final java.lang.String DEFAULT_RMISERVER_CLASSNAME

'org.safs.selenium.rmi.server.SeleniumServer'

See Also:

Constant Field Values

Constructor Detail

JavaJVMConsole

protected JavaJVMConsole()

JavaJVMConsole

protected JavaJVMConsole(boolean outputToConsole)

Parameters:

outputToConsole - boolean, if true the message will also be output to Standard out/err.

JavaJVMConsole

protected JavaJVMConsole(boolean outputToConsole,
                         java.lang.String state)

Parameters:

outputToConsole - boolean, if true the message will also be output to Standard out/err.

state - String, The console winodw's state to set. See state.

Method Detail

init

public void init()

Initialize the console's UI elements.
Start a thread to redirect the stdout/stderr.
This method MUST be called after calling the constructors.

minimize

public void minimize()

Minimize the console window.

restore

public void restore()

Restore the console window to its normal size.

maximize

public void maximize()

Maximize the console window.

setState

protected void setState(java.lang.String state)

Set the console window's state. Maximized, Minimized or Normal.

Parameters:

state - String, the state to set. It could be "MAX", "MIN" or "NORMAL".

createJMenuItem

protected javax.swing.JMenuItem createJMenuItem(java.lang.String name,
                                                int mnemonicKeyIndex,
                                                int accelerateKey,
                                                int accelerateModifier)

Create menu item with mnemonic and accelerate key.
Add ActionListener for the menu item.

Parameters:

name - String, the menu item's name

mnemonicKeyIndex - int, the mnemonic key's index in the menu item's name.

accelerateKey - int, the accelerate key.

accelerateModifier - int, the accelerate modifier. It could be 'ctrl', 'shift', 'alt' defined ActionEvent; 0 means no modifier.

Returns:

JMenuItem

actionPerformed

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

Specified by:

actionPerformed in interface java.awt.event.ActionListener

showSearchDialog

protected boolean showSearchDialog()

Show the dialog for searching token.

Returns:

boolean, true if the 'OK' button of the dialog has been clicked and an item has been selected in the combo box 'tokenCombobox'.

highlightInDispaly

protected boolean highlightInDispaly(boolean forwardSearch)

Find a token within Text Area 'display', if found then highlight it.

Parameters:

forwardSearch - boolean, search forward or backward

Returns:

boolean true if the token is found.

search

public static boolean search(javax.swing.text.Document document,
                             int position,
                             java.lang.String token,
                             boolean caseSensitive)

Search a token within a Document, return true if found.

Parameters:

document - Document, within which to find a match.

position - int, the start position to find a match.

token - String, the token to match.

caseSensitive - boolean, if true the token will be matched case sensitively.

Returns:

boolean true if found.

highLight

public static void highLight(javax.swing.JTextArea display,
                             int position,
                             int length)

Highlight some text in the text area.

Parameters:

display - JTextArea, the text area where to highlight some text.

position - int, the beginning position to start the highlight.

length - int, the length of text to highlight.

clearHighLight

public static void clearHighLight(javax.swing.JTextArea display,
                                  java.lang.Object tag)

Clear highlight in the text area.

Parameters:

display - JTextArea, the text area where to highlight some text.

tag - Object, the tag name of highlight to clear.

addFile

public static void addFile(java.lang.String s)
                    throws java.io.IOException

Adds a file to the System runtime classpath.
Calls addFile(File).

Parameters:

s - a String fullpath pointing to the file

Throws:

java.io.IOException

See Also:

addFile(File), addURL(URL)

addFile

public static void addFile(java.io.File f)
                    throws java.io.IOException

Adds a File to the System runtime classpath.
Calls addURL(URL)

Parameters:

f - the file to be added

Throws:

java.io.IOException

See Also:

addFile(String), addURL(URL)

addURL

public static void addURL(java.net.URL u)
                   throws java.io.IOException

Adds the content pointed by the URL to the System runtime classpath.

Parameters:

u - the URL pointing to the content to be added

Throws:

java.io.IOException

See Also:

addFile(String), addFile(File)

displayLine

protected void displayLine(java.lang.String message)

DO NOT USE. Poor Performance.

Displays the message in the text area. A newline is added to the message so each is printed on a separate line. Limits the number of lines displayed to the last numberOfrows via KEEP_MODE_INFO as keep_mode. Right now, setting any other keep_mode value will retain and append ALL messages received without limiting the size displayed, or the amount of memory used.

Parameters:

message -

getPauseBeforeReady

public int getPauseBeforeReady()

Returns:

int, The time (in milliseconds) to sleep before the out/err output-stream is ready.

See Also:

run()

setPauseBeforeReady

public void setPauseBeforeReady(int pauseBeforeReady)

Parameters:

pauseBeforeReady - int, The time (in milliseconds) to sleep before the out/err output-stream is ready.

See Also:

run()

run

public void run()

Continuously monitors the JVM out and err streams routing them to the local JFrame display. Will run indefinitely until the JVM exits unless a subclass sets the "shutdown" field to true. If JFrame.EXIT_ON_CLOSE (default) is true then closing the JFrame will also terminate the JVM process. This is the default behavior.
However, JVM Consoles that are actually monitoring a separate Process must monitor that process and should set the protected "shutdown" field to true when that Process has exited.

Specified by:

run in interface java.lang.Runnable