org.safs.selenium.rmi.server

Class SeleniumServer

java.lang.Object

java.rmi.server.RemoteObject

java.rmi.server.RemoteServer

java.rmi.server.UnicastRemoteObject

org.safs.rmi.engine.RemoteRoot

org.safs.selenium.rmi.server.SeleniumServer

All Implemented Interfaces:

java.io.Serializable, java.rmi.Remote, SeleniumRMIServer

public class SeleniumServer
extends RemoteRoot
implements SeleniumRMIServer

Default SAFS SeleniumPlus RMI Server normally embedded inside a remote standalone Selenium Server JVM.

Because this is an RMI implementation, an additional Java rmic build process is necessary prior to creating the JAR file containing all classes. The Java rmic program creates the Skeletons and Stubs needed by Java RMI.

Execute Java rmic from the root directory of the Java project:

rmic -d . org.safs.selenium.rmi.server.SeleniumServer

Note: For consistent operation the property java.rmi.server.hostname needs to be set in code or on the command line before launching an RMI Server:

• In Code:
  System.setProperty("java.rmi.server.hostname", "<rmi server ip>");
  System.setProperty("java.rmi.server.hostname", "hostname.company.internal.net");

• Command line:
  -Djava.rmi.server.hostname=<rmi server ip>
  -Djava.rmi.server.hostname=hostname.company.internal.net

Note: Normally Java exports a new RMI Object object using an anonymous port. If you want an explicit port, please set property server.port in code or on the command line:

-Dserver.port=<RMI server port>

System.setProperty("server.port", "8900");

Note: Normally Java creates a registry Object object using a konwn port 1099. If you want an other port for the registry, please set property registry.port in code or on the command line:

-Dregistry.port=<Remote Registry port>

System.setProperty("registry.port", "1100");

Author:

Carl Nagle MAR 03, 2015 Original Release

See Also:

SeleniumServerRunner, SeleniumRMIAgent, SeleniumAgent, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.safs.rmi.engine.RemoteRoot

RemoteRoot.ShutdownHook

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CMD_CLICK
static java.lang.String	CMD_CLICK_WITH_KEY
static java.lang.String	CMD_CLIPBOARD_CLEAR
static java.lang.String	CMD_CLIPBOARD_GET
static java.lang.String	CMD_CLIPBOARD_SET
static java.lang.String	CMD_KEYPRESS
static java.lang.String	CMD_KEYRELEASE
static java.lang.String	CMD_MOUSEWHEEL
static java.lang.String	CMD_SET_KEY_DELAY
static java.lang.String	CMD_SET_WAIT_REACTION
static java.lang.String	CMD_TYPECHARS
static java.lang.String	CMD_TYPEKEYS
protected java.lang.String	serverName Name of Server object in rmi Naming registry.

Fields inherited from class org.safs.rmi.engine.RemoteRoot

DEFAULT_RMI_SERVER_HOST, PROPERTY_REGISTRY_PORT, PROPERTY_SERVER_PORT, registryPort, remoteType, serverHost

Fields inherited from class java.rmi.server.RemoteObject

ref

Fields inherited from interface org.safs.selenium.rmi.server.SeleniumRMIServer

DEFAULT_RMI_SERVER, JAVA_RMI_SERVER_HOSTNAME_PROPERTY, SERVER_SYSTEM_PROPERTY

Constructor Summary

Constructors

Constructor and Description
SeleniumServer()
SeleniumServer(int serverPort)

Method Summary

Modifier and Type	Method and Description
protected java.lang.Boolean	clearClipboard() Clear the clipboard.
protected java.lang.Object	click(java.lang.String[] params) Robot.click(x, y, mouseButton, nclicks);
protected java.lang.Object	clickWithKeyPress(java.lang.String[] params) Robot.clickWithKeyPress(x, y, mouseButton, keyCode, nclicks);
java.lang.Object	execute(java.lang.Object command, java.lang.Object... parameters) Called by an RMI Agent.
protected java.lang.Object	getClipboard(java.lang.Object... params) Get clipboard's content.
void	init()
protected java.lang.Object	keyPress(java.lang.String[] params) Robot.keyPress(keyCode);
protected java.lang.Object	keyRelease(java.lang.String[] params) Robot.keyRelease(keyCode);
static void	main(java.lang.String[] args) Note: For consistent operation the property java.rmi.server.hostname needs to be set in code or on the command line before launching an RMI Server:
protected java.lang.Object	mouseWheel(java.lang.String[] params) Robot.mouseWheel(keyCode);
protected void	pingAgents() Simple routine to ping each registered agent to see if it is actually still there.
void	register(SeleniumRMIAgent anAgent) Called by an RMI Agent.
java.lang.Object	runCommand(java.lang.Object commandAndParameters) Called by an RMI Agent.
protected java.lang.Boolean	setClipboard(java.lang.Object... params) Set string content to clipboard.
protected java.lang.Object	setMillisBetweenKeystrokes(java.lang.String[] params) Robot.setMillisBetweenKeystrokes(string);
protected java.lang.Object	setWaitReaction(java.lang.String[] params) Robot.setWaitReaction(boolean) and Robot.setWaitReaction(boolean, int, int, int).
protected java.lang.Object	typeChars(java.lang.String[] params) Robot.inputChars(string);
protected java.lang.Object	typeKeys(java.lang.String[] params) Robot.inputKeys(string);
void	unRegister(SeleniumRMIAgent anAgent) Called by an RMI Agent.

Methods inherited from class org.safs.rmi.engine.RemoteRoot

finalize, rebindLocalRMIRegistry

Methods inherited from class java.rmi.server.UnicastRemoteObject

clone, exportObject, exportObject, exportObject, unexportObject

Methods inherited from class java.rmi.server.RemoteServer

getClientHost, getLog, setLog

Methods inherited from class java.rmi.server.RemoteObject

equals, getRef, hashCode, toString, toStub

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

CMD_CLICK

public static final java.lang.String CMD_CLICK

See Also:

Constant Field Values

CMD_CLICK_WITH_KEY

public static final java.lang.String CMD_CLICK_WITH_KEY

See Also:

Constant Field Values

CMD_KEYPRESS

public static final java.lang.String CMD_KEYPRESS

See Also:

Constant Field Values

CMD_KEYRELEASE

public static final java.lang.String CMD_KEYRELEASE

See Also:

Constant Field Values

CMD_MOUSEWHEEL

public static final java.lang.String CMD_MOUSEWHEEL

See Also:

Constant Field Values

CMD_TYPEKEYS

public static final java.lang.String CMD_TYPEKEYS

See Also:

Constant Field Values

CMD_TYPECHARS

public static final java.lang.String CMD_TYPECHARS

See Also:

Constant Field Values

CMD_SET_KEY_DELAY

public static final java.lang.String CMD_SET_KEY_DELAY

See Also:

Constant Field Values

CMD_SET_WAIT_REACTION

public static final java.lang.String CMD_SET_WAIT_REACTION

See Also:

Constant Field Values

CMD_CLIPBOARD_CLEAR

public static final java.lang.String CMD_CLIPBOARD_CLEAR

See Also:

Constant Field Values

CMD_CLIPBOARD_SET

public static final java.lang.String CMD_CLIPBOARD_SET

See Also:

Constant Field Values

CMD_CLIPBOARD_GET

public static final java.lang.String CMD_CLIPBOARD_GET

See Also:

Constant Field Values

serverName

protected java.lang.String serverName

Name of Server object in rmi Naming registry. Subclasses should override the value. Defaults to DEFAULT_RMI_SERVER

Constructor Detail

SeleniumServer

public SeleniumServer()
               throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

SeleniumServer

public SeleniumServer(int serverPort)
               throws java.rmi.RemoteException

Parameters:

serverPort -

Throws:

java.rmi.RemoteException

Method Detail

init

public void init()

Overrides:

init in class RemoteRoot

register

public void register(SeleniumRMIAgent anAgent)
              throws java.rmi.RemoteException

Description copied from interface: SeleniumRMIServer

Called by an RMI Agent. A RMI Agent must register with the RMI Server to commence test coordination. The Agent usually is polling the registry at regular intervals waiting for the appropriate Server object to exist.

Specified by:

register in interface SeleniumRMIServer

Throws:

java.rmi.RemoteException

unRegister

public void unRegister(SeleniumRMIAgent anAgent)
                throws java.rmi.RemoteException

Description copied from interface: SeleniumRMIServer

Called by an RMI Agent. Unregisters the RMI Agent from the Server. Normally, this would only be done when the Agent is being finalized because its JVM is shutting down. The Agent does not need to unregister itself if the Server has initiated the Agent shutdown.

Specified by:

unRegister in interface SeleniumRMIServer

Throws:

java.rmi.RemoteException

pingAgents

protected void pingAgents()

Simple routine to ping each registered agent to see if it is actually still there. The routine will unregister an agent when the attempt to contact it throws an exception. This can happen when a remote Agent's JVM does not call registered shutdown hooks and allow the Agent to gracefully unregister with the RMI server.

click

protected java.lang.Object click(java.lang.String[] params)
                          throws java.rmi.ServerException

Robot.click(x, y, mouseButton, nclicks);

Parameters:

params - String[]

 field[0] int x            (default 0)
 field[1] int y            (default 0)
 field[2] int mouseButton  (default MOUSE_BUTTON_LEFT)
 field[3] int numClicks    (default 1)
 

Returns:

An empty String on success.

Throws:

java.rmi.ServerException

See Also:

Robot.click(int, int, int, int)

clickWithKeyPress

protected java.lang.Object clickWithKeyPress(java.lang.String[] params)
                                      throws java.rmi.ServerException

Robot.clickWithKeyPress(x, y, mouseButton, keyCode, nclicks);

Parameters:

params - String[]

 field[0] int x            (default 0)
 field[1] int y            (default 0)
 field[2] int mouseButton  (default MOUSE_BUTTON_LEFT )
 field[3] int keyCode      (default int 0 -- unknown)
 field[4] int numClicks    (default 1)
 

Returns:

An empty String on success.

Throws:

java.rmi.ServerException

See Also:

Robot.clickWithKeyPress(int, int, int, int, int)

keyPress

protected java.lang.Object keyPress(java.lang.String[] params)
                             throws java.rmi.ServerException

Robot.keyPress(keyCode);

Parameters:

params - String[]

 field[0] int keyCode
 

Returns:

An empty String on success.

Throws:

java.rmi.ServerException - if fail

See Also:

Robot.keyPress(int)

keyRelease

protected java.lang.Object keyRelease(java.lang.String[] params)
                               throws java.rmi.ServerException

Robot.keyRelease(keyCode);

Parameters:

params - String[]

 field[0] int keyCode
 

Returns:

An empty String on success.

Throws:

java.rmi.ServerException - if fail

See Also:

Robot.keyRelease(int)

mouseWheel

protected java.lang.Object mouseWheel(java.lang.String[] params)
                               throws java.rmi.ServerException

Robot.mouseWheel(keyCode);

Parameters:

params - String[]

 field[0] int, the wheel amount to scroll.
 

Returns:

An empty String on success.

Throws:

java.rmi.ServerException - if fail

See Also:

Robot.mouseWheel(int)

setMillisBetweenKeystrokes

protected java.lang.Object setMillisBetweenKeystrokes(java.lang.String[] params)
                                               throws java.rmi.ServerException

Robot.setMillisBetweenKeystrokes(string);

Parameters:

params - String[]

 field[0] int milliseconds between keystrokes delay.
 

Returns:

An empty String on success.

Throws:

java.rmi.ServerException - on failure.

See Also:

Robot.setMillisBetweenKeystrokes(int)

setWaitReaction

protected java.lang.Object setWaitReaction(java.lang.String[] params)
                                    throws java.rmi.ServerException

Robot.setWaitReaction(boolean) and Robot.setWaitReaction(boolean, int, int, int).

Parameters:

params - String[]

 params[0] wait boolean, if wait or not.
 params[1] tokenLength int, the length of a token. Only if the string is longer than this
                            then we wait the reaction after input-keys a certain time
                            indicated by the parameter dealyForToken.
 params[2] dealyForToken int, The delay in millisecond to wait the reaction after input-keys
                              for the string as long as a token.
 params[3] dealy int, The constant delay in millisecond to wait the reaction after input-keys.
 

Returns:

An empty String on success.

Throws:

java.rmi.ServerException - on failure.

See Also:

Robot.setWaitReaction(boolean), Robot.setWaitReaction(boolean, int, int, int)

typeKeys

protected java.lang.Object typeKeys(java.lang.String[] params)
                             throws java.rmi.ServerException

Robot.inputKeys(string);

Parameters:

params - String[]

 field[0] String input string.
 

Returns:

An empty String on success.

Throws:

java.rmi.ServerException - on failure.

See Also:

Robot.inputKeys(String)

typeChars

protected java.lang.Object typeChars(java.lang.String[] params)
                              throws java.rmi.ServerException

Robot.inputChars(string);

Parameters:

params - String[]

 field[0] String input string.
 

Returns:

An empty String on success.

Throws:

java.rmi.ServerException

See Also:

Robot.inputChars(String)

clearClipboard

protected java.lang.Boolean clearClipboard()
                                    throws java.rmi.ServerException

Clear the clipboard.

Returns:

A Boolean(true) on success.

Throws:

java.rmi.ServerException

See Also:

Robot.clearClipboard()

setClipboard

protected java.lang.Boolean setClipboard(java.lang.Object... params)
                                  throws java.rmi.ServerException

Set string content to clipboard.

Parameters:

params - Object...

 field[0] String content string to set to clipboard.
 

Returns:

A Boolean(true) on success.

Throws:

java.rmi.ServerException

See Also:

Robot#setClipboard(String)}

getClipboard

protected java.lang.Object getClipboard(java.lang.Object... params)
                                 throws java.rmi.ServerException

Get clipboard's content.

Parameters:

params - Object...

 field[0] DataFlavor the type of the content to get from clipboard
 

Returns:

Object, the content of the clipboard

Throws:

java.rmi.ServerException

See Also:

Robot#getClipboard(DataFlavor)}

runCommand

public java.lang.Object runCommand(java.lang.Object commandAndParameters)
                            throws java.rmi.RemoteException,
                                   java.lang.Exception

Description copied from interface: SeleniumRMIServer

Called by an RMI Agent. This is a "do anything" function that the Server and Clients have a private contract to implement. It essentially allows a Client/Server implementation to pass anything back and forth and act according to their shared designs.

For example, the Client and Server may have been coded to pass string commands back and forth and the string commands can be parsed to provide an unlimited number of command possibilities.

Specified by:

runCommand in interface SeleniumRMIServer

Parameters:

commandAndParameters - -- usually a String.

String commandAndParameters interpreted as:

 char[0] field separator for all subsequent fields
 field[1] -- command
 field[2-N] -- command parameters
 

Returns:

determined by individual commands. Usually a String.

Throws:

java.rmi.ServerException - if an error occurs or the requested command is not supported.

java.rmi.RemoteException

java.lang.Exception

execute

public java.lang.Object execute(java.lang.Object command,
                                java.lang.Object... parameters)
                         throws java.rmi.RemoteException,
                                java.lang.Exception

Description copied from interface: SeleniumRMIServer

Called by an RMI Agent. This is a "do anything" function that the Server and Clients have a private contract to implement. It essentially allows a Client/Server implementation to pass anything back and forth and act according to their shared designs.

The parameters should be Serializable.

Specified by:

execute in interface SeleniumRMIServer

Parameters:

command - -- usually a String representing the action's name

parameters - Object..., serializable parameters

Returns:

determined by individual commands.

Throws:

java.rmi.ServerException - if an error occurs or the requested command is not supported.

java.rmi.RemoteException

java.lang.Exception

main

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

Note: For consistent operation the property java.rmi.server.hostname needs to be set in code or on the command line before launching an RMI Server:

-Djava.rmi.server.hostname=<rmi server ip>

-Djava.rmi.server.hostname=hostname.company.internal.net

Note: Normally Java exports a new RMI Object object using an anonymous port. If you want an explicit port, please set property server.port in code or on the command line:

-Dserver.port=<RMI server port>

System.setProperty("server.port", "8900");

Note: Normally Java creates a registry Object object using a konwn port 1099. If you want an other port for the registry, please set property registry.port in code or on the command line:

-Dregistry.port=<Remote Registry port>

System.setProperty("registry.port", "1100");