org.safs.rmi.engine

Interface Server

All Superinterfaces:

java.rmi.Remote

All Known Implementing Classes:

ServerImpl

public interface Server
extends java.rmi.Remote

Defines a generic SAFS Engine RMI Server to communicate with multiple SAFS Engine RMI Agents.

A SAFS Engine RMI Server is the centralized controller that will talk with each RMI Agent embedded within each enabled JVM--local or remote. This provides an RMI alternative to STAF for multi-JVM communications between the very visible SAFS Engine and the invisible Agents in each JVM.

The typical scenario here would be that a SAFS Engine like SAFS/Abbot would still present a single STAF-based event-driven interface for the TID and any other Driver wishing to use it, but underneath the engine will be communicating with multiple JVMs over RMI.

This is somewhat analogous to how other tools like RobotJ, Robot, and WinRunner communicate with all running JVMs through a single script engine or controller.

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 JAN 25, 2005 Original Release

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	JAVA_RMI_SERVER_HOSTNAME_PROPERTY "java.rmi.server.hostname" System property or command-line JVM setting 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 RMI Agents should shutdown and not attempt to connect to the RMI Server.

Method Summary

Modifier and Type	Method and Description
void	register(Agent anAgent) A JVM Agent will register with the RMI Server after it has become available in the RMI Naming registry.
java.lang.Object	runCommand(java.lang.Object command) This is a "do anything" function that the Server and Clients have a private contract to implement.
void	unRegister(Agent anAgent) Unregisters the JVM Agent from the Server.

Field Detail

SERVER_SYSTEM_PROPERTY

static final java.lang.String SERVER_SYSTEM_PROPERTY

'safs.server.running' System Property signifying this JVM contains the RMI Server and 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 specifying the IP address to be used by the RMI Server.

See Also:

Constant Field Values

Method Detail

register

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

A JVM Agent will register with the RMI Server after it has become available in the RMI Naming registry. The Agent usually is polling the registry at regular intervals waiting for the appropriate Server object to exist. The Server object is not created until the actual controlling SAFS Engine is launched.

Registering with the Server makes that remote JVM available for testing through the controlling SAFS Engine.

Throws:

java.rmi.RemoteException

unRegister

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

Unregisters the JVM 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

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