org.safs.selenium.rmi.server

Interface SeleniumRMIServer

All Superinterfaces:

java.rmi.Remote

All Known Implementing Classes:

SeleniumServer

public interface SeleniumRMIServer
extends java.rmi.Remote

Defines a generic Selenium RMI Server to communicate with multiple Selenium RMI Agents.

A Selenium RMI Server is the centralized controller embedded within each remote Selenium Standalone Server. This provides an RMI gateway to the remote host machines running a Selenium Server allowing us to provide additional functional features on the machine hosting the browsers of a Selenium test.

Note: For consistent operation the 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

Author:

Carl Nagle MAR 03, 2015 Original Release

See Also:

SeleniumServerRunner, SeleniumRMIAgent, SeleniumAgent

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_RMI_SERVER 'SAFS/SeleniumRMIServer'
static java.lang.String	JAVA_RMI_SERVER_HOSTNAME_PROPERTY "java.rmi.server.hostname" System property or command-line JVM setting (-Djava.rmi.server.hostname=) specifying the IP address to be used by the RMI Server.
static java.lang.String	SERVER_SYSTEM_PROPERTY 'safs.server.running' System Property signifying this JVM contains the RMI Server and any RMI Agents should shutdown and not attempt to connect to the RMI Server.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	execute(java.lang.Object command, java.lang.Object... parameters) Called by an RMI Agent.
void	register(SeleniumRMIAgent anAgent) Called by an RMI Agent.
java.lang.Object	runCommand(java.lang.Object command) Called by an RMI Agent.
void	unRegister(SeleniumRMIAgent anAgent) Called by an RMI Agent.

Field Detail

DEFAULT_RMI_SERVER

static final java.lang.String DEFAULT_RMI_SERVER

'SAFS/SeleniumRMIServer'

See Also:

Constant Field Values

SERVER_SYSTEM_PROPERTY

static final java.lang.String SERVER_SYSTEM_PROPERTY

'safs.server.running' System Property signifying this JVM contains the RMI Server and any RMI Agents should shutdown and not attempt to connect to the RMI Server. Concrete implementation of this interface should set this System Property to some value (not null) to disable local Agents from running.

See Also:

Constant Field Values

JAVA_RMI_SERVER_HOSTNAME_PROPERTY

static final java.lang.String JAVA_RMI_SERVER_HOSTNAME_PROPERTY

"java.rmi.server.hostname"
System property or command-line JVM setting (-Djava.rmi.server.hostname=) specifying the IP address to be used by the RMI Server.

This property MUST be set prior to starting the RMI Server/Registry or the RMI Server object will set its IP to 127.0.01 "localhost"--which will prevent remote Agents from properly finding it.

See Also:

Constant Field Values

Method Detail

register

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

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.

Throws:

java.rmi.RemoteException

unRegister

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

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.

Throws:

java.rmi.RemoteException

runCommand

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

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.

Parameters:

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

Returns:

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

Throws:

java.rmi.RemoteException

java.lang.Exception

execute

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

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.

Parameters:

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

parameters - Object... of a type expected by the Server implementation for this method.

Returns:

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

Throws:

java.rmi.RemoteException

java.lang.Exception