org.safs.selenium.util

Class SeleniumServerRunner

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

org.safs.tools.consoles.JavaJVMConsole

org.safs.selenium.util.SeleniumServerRunner

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

public class SeleniumServerRunner
extends JavaJVMConsole

This class is used to provide a special Java console for the Selenium Server (standalone, hub, node) process. This is essential for the following cases (server will be launched on local machine):

• Launching a standalone Selenium Server.
• Launching a standalone Selenium Server supporting SeleniumPlus RMI.
• Launching a hub (in grid mode) Selenium Server.
• Launching a hub (in grid mode) Selenium Server supporting SeleniumPlus RMI.
• Launching a node (in grid mode) Selenium Server.
• Launching a node (in grid mode) Selenium Server supporting SeleniumPlus RMI.

Required parameters:
-jar fullpath/to/selenium-server-standalone-<version>.jar
-timeout=N Controls how long (in seconds) the client is allowed to be gone before the session is reclaimed
-browserTimeout=N Controls how long (in seconds) the browser is allowed to hang

Optional parameters:
-port N, optional, the port number for Selenium Server. If not provided, the default port will be used. For "standalone" and "hub" the default port number is 4444; While for "node", it is 5555.
-role TheServerRole, optional, if not provided, a standalone server will be launched.
TheServerRole could be "hub", and selenium server will be launched as a hub (in grid mode) for other node to connect.
TheServerRole could be "node", and selenium server will be launched as a node (in grid mode) to connect a hub. **Note** Hub's information must also be provided. Ex: -role node -hub http://hub.machine:port/grid/register

-outputToConsole, optional, if provided, the console message will also be printed to standard out/err.
-state MAX|MIN|NORMAL, optional, the console windows will be maximized, minimized or as it is.

Other JVM params--including those needed by Selenium Server ( -Dwebdriver...)--must also be provided and will have already been applied to this JVM process.

Consequently, a typical command-line invocation of this Java program would look like:

 <pathTo>/bin/java 
 
     -Xms51m -Xmx1g (or -Xmx2g)
     -cp <pathTo>/seleniumplus.jar;<pathTo>/JSTAFEmbedded.jar;<pathTo>selenium-server-standalone-<version>.jar
     
     -Dwebdriver.log.file="webdriver.console" 
     -Dwebdriver.firefox.logfile="firefox.console" 
     -Dwebdriver.safari.logfile="safari.console" 
     -Dwebdriver.ie.logfile="ie.console" 
     -Dwebdriver.opera.logfile="opera.console" 
     -Dwebdriver.chrome.logfile="chrome.console" 
     -Dwebdriver.chrome.driver="<pathTo/chromedriver.exe" 
     -Dwebdriver.ie.driver="<pathTo/IEDriverServer.exe"
     
     org.safs.selenium.util.SeleniumServerRunner 
     
     -jar <pathTo>/selenium-server-standalone-<version>.jar;
     -timeout=20
     -browserTimeout=60
 

When being used as the SeleniumPlus RMI bootstrap mechanism on a remote standalone/node Selenium Server, the following additional command-line arguments are necessary:

     -Djava.rmi.server.hostname=<full hostname or ip address>
     
       The correct hostname is imperative as later versions of Java seem to resolve the 
       our hostname to "localhost" or "127.0.0.1" which will cause connection failures on 
       remote systems trying to communicate with this RMI Server.)

     One of the following:
     
     -safs.rmi.server  (no arg: default SeleniumPlus RMI Server)
     -safs.rmi.server <full.package.classname>   (alternative/custom RMI Server)  
     -Dsafs.rmi.server <full.package.classname>  (alternative/custom RMI Server)  

Author:

Carl Nagle

See Also:

SeleniumRMIServer, SeleniumServer, SeleniumRMIAgent, SeleniumAgent, 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
protected static boolean	isRMIServer
static java.lang.String	PARAM_JAR '-jar' specifies the jar file to put dynamically in the classpath. -jar fullpath/to/selenium-server-standalone*.jar
static java.lang.String	PARAM_OUTPUTCONSOLE '-outputToConsole' specifies if the 'execution message' will also be printed to standard out/err.
static java.lang.String	PARAM_RMI '-safs.rmi.server' specifies the name of RMI server class to start with. '-safs.rmi.server', without value the default RMI DriverConstant.DEFAULT_RMISERVER_CLASSNAME will be used. '-safs.rmi.server full.pacakge.RMIServer', 'full.pacakge.RMIServer' will start with this console.
protected static java.lang.String	rmiServerClassname The default value is null, so the console start without RMI server.
static java.lang.String	TITLE "Selenium Server", The title will be shown.

Fields inherited from class org.safs.tools.consoles.JavaJVMConsole

DEFAULT_RMISERVER_CLASSNAME, DEFAULT_SEARCH_MATCH_CASE, display, keep_mode, KEEP_MODE_FIFO, lastFoundPosition, MENU_EDIT, MENU_FILE, MENU_ITEM_CLEAR, MENU_ITEM_EXIT, MENU_ITEM_FIND, MENU_ITEM_FIND_NEXT, MENU_ITEM_FIND_PREVIOUS, MENU_ITEM_SAVE, MENU_SEARCH, numberOfrows, outputToConsole, PARAM_STATE, PAUSE_BEFORE_OUTPUT_READY, pauseBeforeReady, PROPERTY_RMISERVER, shutdown, state, STATE_DEFAULT, STATE_MAX, STATE_MAXIMIZE, STATE_MIN, STATE_MINIMIZE, STATE_NORMAL, token, tokenCombobox, tokenMatchCaseCheckbox

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

Method Summary

Modifier and Type	Method and Description
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.
protected static void	launchRMIServer() Start an RMI Server class specified on the command-line, if any.
static void	main(java.lang.String[] args) Is expected to be able to run in its own standalone Java process.
protected static java.lang.String[]	processArgs(java.lang.String[] args)

Methods inherited from class org.safs.tools.consoles.JavaJVMConsole

actionPerformed, addFile, addFile, addURL, clearHighLight, createJMenuItem, displayLine, getPauseBeforeReady, highLight, highlightInDispaly, maximize, minimize, restore, run, search, setPauseBeforeReady, setState, showSearchDialog

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

isRMIServer

protected static boolean isRMIServer

rmiServerClassname

protected static java.lang.String rmiServerClassname

The default value is null, so the console start without RMI server.

TITLE

public static final java.lang.String TITLE

"Selenium Server", The title will be shown.

See Also:

Constant Field Values

PARAM_OUTPUTCONSOLE

public static final java.lang.String PARAM_OUTPUTCONSOLE

'-outputToConsole' specifies if the 'execution message' will also be printed to standard out/err.

See Also:

Constant Field Values

PARAM_JAR

public static final java.lang.String PARAM_JAR

'-jar' specifies the jar file to put dynamically in the classpath.
-jar fullpath/to/selenium-server-standalone*.jar

See Also:

Constant Field Values

PARAM_RMI

public static final java.lang.String PARAM_RMI

'-safs.rmi.server' specifies the name of RMI server class to start with.
'-safs.rmi.server', without value the default RMI DriverConstant.DEFAULT_RMISERVER_CLASSNAME will be used.
'-safs.rmi.server full.pacakge.RMIServer', 'full.pacakge.RMIServer' will start with this console.

See Also:

Constant Field Values

Method Detail

init

public void init()

Description copied from class: JavaJVMConsole

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

Overrides:

init in class JavaJVMConsole

processArgs

protected static java.lang.String[] processArgs(java.lang.String[] args)
                                         throws java.io.IOException

Throws:

java.io.IOException

launchRMIServer

protected static void launchRMIServer()
                               throws java.lang.InstantiationException,
                                      java.lang.IllegalAccessException,
                                      java.lang.ClassNotFoundException

Start an RMI Server class specified on the command-line, if any. If none was specified, then nothing happens.

Throws:

java.lang.ClassNotFoundException

java.lang.IllegalAccessException

java.lang.InstantiationException

main

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

Is expected to be able to run in its own standalone Java process.

Parameters:

args - expects:

-jar fullpath/to/selenium-server-standalone*.jar
-timeout=N Controls how long (in seconds) the client is allowed to be gone before the session is reclaimed
-browserTimeout=N Controls how long (in seconds) the browser is allowed to hang
-port N, optional, the port number for Selenium Server. If not provided, the default port will be used. For "standalone" and "hub" the default port number is 4444; While for "node", it is 5555.
-role TheServerRole, optional, if not provided, a standalone server will be launched.
TheServerRole could be "hub", and selenium server will be launched as a hub (in grid mode) for other node to connect.
TheServerRole could be "node", and selenium server will be launched as a node (in grid mode) to connect a hub. **Note** Hub's information must also be provided. Ex: -role node -hub http://hub.machine:port/grid/register

-outputToConsole, optional, if provided, the console message will also be printed to standard out/err.
-state MAX|MIN|NORMAL, optional, the console windows will be maximized, minimized or as it is.

Other JVM params--including those needed by standalone Selenium Server ( -Dwebdriver...)--must also be provided and will have already been applied to this JVM process.

When being used as the SeleniumPlus RMI bootstrap mechanism on a remote standalone/node Selenium Server, the following additional command-line arguments are necessary:

     -Djava.rmi.server.hostname=<full hostname or ip address>
     
       The correct hostname is imperative as later versions of Java seem to resolve the 
       our hostname to "localhost" or "127.0.0.1" which will cause connection failures on 
       remote systems trying to communicate with this RMI Server.)

     One of the following:
     
     -safs.rmi.server  (no arg: default SeleniumPlus RMI Server)
     -safs.rmi.server <full.package.classname>   (alternative/custom RMI Server)  
     -Dsafs.rmi.server <full.package.classname>  (alternative/custom RMI Server)