org.safs.selenium.rmi.agent

Class SeleniumAgent

java.lang.Object

java.rmi.server.RemoteObject

java.rmi.server.RemoteServer

java.rmi.server.UnicastRemoteObject

org.safs.rmi.engine.RemoteRoot

org.safs.selenium.rmi.agent.SeleniumAgent

All Implemented Interfaces:

java.io.Serializable, java.rmi.Remote, SeleniumRMIAgent

public class SeleniumAgent
extends RemoteRoot
implements SeleniumRMIAgent

Default Selenium RMI Agent intended to communicate with 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.agent.SeleniumAgent

Note: For consistent operation the safs.server.hostname needs to be set in code or on the command line before launching an Agent connecting to a remote Selenium RMI Server:

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

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

Author:

Carl Nagle MAR 03, 2015 Original Release

See Also:

SeleniumServerRunner, SeleniumRMIServer, SeleniumServer, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	SeleniumAgent.ServerMonitor Polls the server host for a Java Registry every few seconds until one with the proper server object is found.

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	DEFAULT_COMMAND_SEPARATOR
protected boolean	hostOverride If the user sets the serverHost then we won't look for System Properties.
protected SeleniumAgent.ServerMonitor	monitor
protected java.rmi.server.ObjID	objID
SeleniumRMIServer	server The remote SAFS RMI SeleniumServer reference.
protected java.lang.String	serverHost Each Agent may have a different RMI Server (Mac, Unix, Windows, Android, etc..) This setting "overrides/hides" the static serverHost of the RemoteRoot superclass.
protected java.lang.String	serverName Subclasses will override to seek out different RMI Server Objects.
protected boolean	shutdown

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

DEFAULT_RMI_SERVER_HOST, PROPERTY_REGISTRY_PORT, PROPERTY_SERVER_PORT, registryPort, remoteType

Fields inherited from class java.rmi.server.RemoteObject

ref

Fields inherited from interface org.safs.selenium.rmi.agent.SeleniumRMIAgent

DEFAULT_RMI_AGENT, SERVER_HOSTNAME_SYSTEM_PROPERTY

Constructor Summary

Constructors

Constructor and Description
SeleniumAgent()

Method Summary

Modifier and Type	Method and Description
void	clearClipboard() Clear the clipboard on the machine where the RMI server is running.
void	disconnect() Used locally to cease all agent operations with any server and commence a complete RMI disconnect.
java.rmi.server.ObjID	getAgentID() Called by an RMI Server.
java.lang.String	getAgentName() Called by an RMI Server.
java.lang.Object	getClipboard(java.awt.datatransfer.DataFlavor dataFlavor) Get content of the clipboard on the machine where the RMI server is running.
void	initialize() MUST be called by instances after object construction. If dynamically setting the desire selenium server host you must set that prior to initialization.
static void	main(java.lang.String[] args) For test purposes only.
void	ping() Does nothing but verify the integrity of the RMI connection and log entry.
void	remoteClick(int screen_x, int screen_y, int mouseButtonNumber, int nclicks)
void	remoteClickWithKeyPress(int screen_x, int screen_y, int mouseButtonNumber, int keyCode, int nclicks)
void	remoteKeyPress(int keycode)
void	remoteKeyRelease(int keycode)
void	remoteMouseWheel(int wheelAmt)
void	remoteSetKeyDelay(int millisDelay)
void	remoteTypeChars(java.lang.String keys)
void	remoteTypeKeys(java.lang.String keys)
void	remoteWaitReaction(boolean wait) Set if wait for reaction to "input keys/chars" for remote server.
void	remoteWaitReaction(boolean wait, int tokenLength, int dealyForToken, int dealy) Set if wait for reaction to "input keys/chars" for remote server.
java.lang.Object	runCommand(java.lang.Object command) Called by an RMI Server.
void	setClipboard(java.lang.String content) Set content to the clipboard on the machine where the RMI server is running.
void	setRegistryPort(int registryPort) This overrides System Properties settings for 'registry.port'. MUST be called before initialize().
void	setSeparator(java.lang.String separator) Set the separator to separate command and parameters.
void	setServerHost(java.lang.String hostname) Provide a runtime override of the target selenium server hostname. This overrides System Properties settings for 'safs.server.hostname'. MUST be called before initialize().
void	shutdown() Called from the remote RMI Server.

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

finalize, init, 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

DEFAULT_COMMAND_SEPARATOR

public static final java.lang.String DEFAULT_COMMAND_SEPARATOR

See Also:

Constant Field Values

server

public SeleniumRMIServer server

The remote SAFS RMI SeleniumServer reference.

shutdown

protected boolean shutdown

monitor

protected SeleniumAgent.ServerMonitor monitor

objID

protected java.rmi.server.ObjID objID

hostOverride

protected boolean hostOverride

If the user sets the serverHost then we won't look for System Properties.

See Also:

setServerHost(String)

serverName

protected java.lang.String serverName

Subclasses will override to seek out different RMI Server Objects.

serverHost

protected java.lang.String serverHost

Each Agent may have a different RMI Server (Mac, Unix, Windows, Android, etc..) This setting "overrides/hides" the static serverHost of the RemoteRoot superclass.

Constructor Detail

SeleniumAgent

public SeleniumAgent()
              throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

Method Detail

setServerHost

public void setServerHost(java.lang.String hostname)

Provide a runtime override of the target selenium server hostname.
This overrides System Properties settings for 'safs.server.hostname'.
MUST be called before initialize().

Parameters:

hostname -

See Also:

RemoteRoot.serverHost

setRegistryPort

public void setRegistryPort(int registryPort)

This overrides System Properties settings for 'registry.port'.
MUST be called before initialize().

Parameters:

registryPort - int, the port from where to get the registry for getting RMI server.

initialize

public void initialize()

MUST be called by instances after object construction.
If dynamically setting the desire selenium server host you must set that prior to initialization.

See Also:

setServerHost(String)

ping

public void ping()
          throws java.rmi.RemoteException

Does nothing but verify the integrity of the RMI connection and log entry. The call normally comes from the RMI Server.

Specified by:

ping in interface SeleniumRMIAgent

Throws:

java.rmi.RemoteException

See Also:

Agent.ping()

getAgentID

public java.rmi.server.ObjID getAgentID()
                                 throws java.rmi.RemoteException

Description copied from interface: SeleniumRMIAgent

Called by an RMI Server. Returns an ObjID to uniquely identify the RMI Agent.

Specified by:

getAgentID in interface SeleniumRMIAgent

Throws:

java.rmi.RemoteException

See Also:

Agent.getAgentID()

getAgentName

public java.lang.String getAgentName()
                              throws java.rmi.RemoteException

Description copied from interface: SeleniumRMIAgent

Called by an RMI Server. Returns the name or remoteType of the RMI Agent.

Specified by:

getAgentName in interface SeleniumRMIAgent

Throws:

java.rmi.RemoteException

See Also:

Agent.getAgentName()

disconnect

public void disconnect()

Used locally to cease all agent operations with any server and commence a complete RMI disconnect. This is necessary to allow the RMI threads to allow the JVM to exit.

shutdown

public void shutdown()
              throws java.rmi.RemoteException

Called from the remote RMI Server. Removes any RMI server reference we might already have and restarts a new ServerMonitor to watch for a new RMI server object.

Specified by:

shutdown in interface SeleniumRMIAgent

Throws:

java.rmi.RemoteException

See Also:

Agent.shutdown()

runCommand

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

Description copied from interface: SeleniumRMIAgent

Called by an RMI Server. 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 the shared design.

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 SeleniumRMIAgent

Parameters:

command - Object of a type expected by the Client implementation for this method.

Returns:

Object of a type expected by the Server implementation calling this method.

Throws:

java.rmi.RemoteException

java.lang.Exception

setSeparator

public void setSeparator(java.lang.String separator)

Set the separator to separate command and parameters.

Parameters:

separator -

remoteClick

public void remoteClick(int screen_x,
                        int screen_y,
                        int mouseButtonNumber,
                        int nclicks)
                 throws java.rmi.ServerException,
                        java.lang.Exception

Parameters:

screen_x -

screen_y -

mouseButtonNumber -

nclicks -

Throws:

java.rmi.ServerException - if the command did not execute successfully

java.lang.Exception

remoteClickWithKeyPress

public void remoteClickWithKeyPress(int screen_x,
                                    int screen_y,
                                    int mouseButtonNumber,
                                    int keyCode,
                                    int nclicks)
                             throws java.rmi.ServerException,
                                    java.lang.Exception

Parameters:

screen_x -

screen_y -

mouseButtonNumber -

keyCode -

nclicks -

Throws:

java.rmi.ServerException - if the command did not execute successfully

java.lang.Exception

remoteKeyPress

public void remoteKeyPress(int keycode)
                    throws java.rmi.ServerException,
                           java.lang.Exception

Parameters:

keycode - int, the key to press

Throws:

java.rmi.ServerException - if the command did not execute successfully

java.lang.Exception

remoteKeyRelease

public void remoteKeyRelease(int keycode)
                      throws java.rmi.ServerException,
                             java.lang.Exception

Parameters:

keycode - int, the key to release

Throws:

java.rmi.ServerException - if the command did not execute successfully

java.lang.Exception

remoteMouseWheel

public void remoteMouseWheel(int wheelAmt)
                      throws java.rmi.ServerException,
                             java.lang.Exception

Parameters:

wheelAmt - int, the mouse wheel to scroll

Throws:

java.rmi.ServerException - if the command did not execute successfully

java.lang.Exception

remoteTypeKeys

public void remoteTypeKeys(java.lang.String keys)
                    throws java.rmi.ServerException,
                           java.lang.Exception

Parameters:

keys -

Throws:

java.rmi.ServerException - if the command did not execute successfully

java.lang.Exception

remoteSetKeyDelay

public void remoteSetKeyDelay(int millisDelay)
                       throws java.rmi.ServerException,
                              java.lang.Exception

Parameters:

millisDelay - between keystrokes

Throws:

java.rmi.ServerException - if the command did not execute successfully

java.lang.Exception

remoteWaitReaction

public void remoteWaitReaction(boolean wait)
                        throws java.rmi.ServerException,
                               java.lang.Exception

Set if wait for reaction to "input keys/chars" for remote server.

Parameters:

wait - boolean if wait or not.

Throws:

java.rmi.ServerException - if the command did not execute successfully

java.lang.Exception

See Also:

Robot.setWaitReaction(boolean)

remoteWaitReaction

public void remoteWaitReaction(boolean wait,
                               int tokenLength,
                               int dealyForToken,
                               int dealy)
                        throws java.rmi.ServerException,
                               java.lang.Exception

Set if wait for reaction to "input keys/chars" for remote server.

Parameters:

wait - boolean, if wait or not.

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.

dealyForToken - int, The delay in millisecond to wait the reaction after input-keys for the string as long as a token.

dealy - int, The constant delay in millisecond to wait the reaction after input-keys.

Throws:

java.rmi.ServerException - if the command did not execute successfully

java.lang.Exception

See Also:

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

remoteTypeChars

public void remoteTypeChars(java.lang.String keys)
                     throws java.rmi.ServerException,
                            java.lang.Exception

Parameters:

String - char

Throws:

java.rmi.ServerException - if the command did not execute successfully

java.lang.Exception

clearClipboard

public void clearClipboard()
                    throws java.rmi.ServerException,
                           java.lang.Exception

Clear the clipboard on the machine where the RMI server is running.

Throws:

java.rmi.ServerException - if the command did not execute successfully

java.lang.Exception - for other problems

setClipboard

public void setClipboard(java.lang.String content)
                  throws java.rmi.ServerException,
                         java.lang.Exception

Set content to the clipboard on the machine where the RMI server is running.

Parameters:

content - String, the string content to set to clipboard

Throws:

java.rmi.ServerException - if the command did not execute successfully

java.lang.Exception - for other problems

getClipboard

public java.lang.Object getClipboard(java.awt.datatransfer.DataFlavor dataFlavor)
                              throws java.rmi.ServerException,
                                     java.lang.Exception

Get content of the clipboard on the machine where the RMI server is running.

Parameters:

dataFlavor - DataFlavor, the data flavor for the content in clipboard

Returns:

Object, the content of the clipboard

Throws:

java.rmi.ServerException - if the command did not execute successfully

java.lang.Exception - for other problems

main

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

For test purposes only.

Parameters:

args - String[]

• args[0] command
• args[1] parameter
• args[2] parameter

For example we can call a "click" command by giving the following parameters:
//screen_x, screen_y, mouseButtonNumber, nclicks
click 300 500 16 1

Use -Dsafs.server.hostname on command-line to specify the RMI host to contact.

-Dsafs.server.hostname=<Remote Server host>

Note: Normally Java creates a registry Object object using a konwn port 1099. The "SAFS RMI server" has been registered on the RMI host by that registry. If the registry is created on an other port, we need to set registry.port in code or on the command line so that we can find the the "SAFS RMI server".

-Dregistry.port=<Remote Registry port>

Throws:

java.rmi.RemoteException