org.safs.selenium.rmi.agent

Interface SeleniumRMIAgent

All Superinterfaces:

java.rmi.Remote

All Known Implementing Classes:

SeleniumAgent

public interface SeleniumRMIAgent
extends java.rmi.Remote

Defines a generic Selenium RMI Agent communicating with a Selenium RMI Server.

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.

The Selenium RMI Agent is typically started automatically by SAFS/Selenium classes needing to communicate with the remote SAFS RMI Server.

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_RMI_AGENT 'SeleniumAgent'
static java.lang.String	SERVER_HOSTNAME_SYSTEM_PROPERTY 'safs.server.hostname' Name of the System Property signifying a remote SAFS RMI Server hostname to seek for a SAFS RMI Server.

Method Summary

Modifier and Type	Method and Description
java.rmi.server.ObjID	getAgentID() Called by an RMI Server.
java.lang.String	getAgentName() Called by an RMI Server.
void	ping() Called by an RMI Server.
java.lang.Object	runCommand(java.lang.Object command) Called by an RMI Server.
void	shutdown() Called by an RMI Server.

Field Detail

DEFAULT_RMI_AGENT

static final java.lang.String DEFAULT_RMI_AGENT

'SeleniumAgent'

See Also:

Constant Field Values

SERVER_HOSTNAME_SYSTEM_PROPERTY

static final java.lang.String SERVER_HOSTNAME_SYSTEM_PROPERTY

'safs.server.hostname' Name of the System Property signifying a remote SAFS RMI Server hostname to seek for a SAFS RMI Server.

See Also:

Constant Field Values

Method Detail

ping

void ping()
   throws java.rmi.RemoteException

Called by an RMI Server. A simple RUThere call. The server will generally receive a ConnectException thrown by RMI if the Agent cannot be called because it has gone away.

Throws:

java.rmi.RemoteException

getAgentID

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

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

Throws:

java.rmi.RemoteException

getAgentName

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

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

Throws:

java.rmi.RemoteException

shutdown

void shutdown()
       throws java.rmi.RemoteException

Called by an RMI Server. The RMI Server will instruct the Agent to shutdown when the Server itself is being shutdown or finalized. The Agent does not have to unRegister from the Server in this case because the Server will already be disconnecting from the Agent.

The Agent should accept the shutdown request and initiate a new shutdown Thread so that the call to shutdown from the Server can immediately return.

The Agent might normally reset itself to an idle state where it is polling once again for the existence of another RMI Server.

Throws:

java.rmi.RemoteException

runCommand

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

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.

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