org.safs.rmi.engine

Class RemoteRoot

java.lang.Object

java.rmi.server.RemoteObject

java.rmi.server.RemoteServer

java.rmi.server.UnicastRemoteObject

org.safs.rmi.engine.RemoteRoot

All Implemented Interfaces:

java.io.Serializable, java.rmi.Remote

Direct Known Subclasses:

AgentImpl, SeleniumAgent, SeleniumServer, ServerImpl

public class RemoteRoot
extends java.rmi.server.UnicastRemoteObject

Root RMI class for many RMI Server/Agent classes. Because this superclass does not implement any Remote calls, we do not have to build Skels or Stubs with rmic.

Subclasses will generally extend this class while implementing a Remote interface.

Ex: public class ServerImpl extends RemoteRoot implements Server
public class AgentImpl extends RemoteRoot implements Agent

Author:

Carl Nagle

See Also:

ServerImpl, AgentImpl, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	RemoteRoot.ShutdownHook This is how we try to ensure our finalize method is called at JVM shutdown.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_RMI_SERVER_HOST 'localhost'
static java.lang.String	PROPERTY_REGISTRY_PORT "registry.port", used to set registry port on which the registry is created.
static java.lang.String	PROPERTY_SERVER_PORT "server.port", used to set server port number on which to export the remote object, on which the remote object receives calls.
protected int	registryPort the port used by the registry for looking up the RMI server, the default is 1099
protected java.lang.String	remoteType 'Remote':Override to indicate Remote RMI type in RMI and debug messages.
protected static java.lang.String	serverHost defaults to 'localhost'

Fields inherited from class java.rmi.server.RemoteObject

ref

Constructor Summary

Constructors

Constructor and Description
RemoteRoot() Constructor for RemoteRoot Subclasses should call super() for this superclass and should also set the remoteType to whatever they need.
RemoteRoot(int port)

Method Summary

Modifier and Type	Method and Description
protected void	finalize() without this the bootstrap loading mechanism of the JVMAgent class fails with some VerifyError this occurs on some computer environments in not clarified circumstances
void	init()
protected void	rebindLocalRMIRegistry(java.lang.String serverName, java.rmi.Remote server) rebind a RMI server object to the localhost RMI Registry.

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_RMI_SERVER_HOST

public static final java.lang.String DEFAULT_RMI_SERVER_HOST

'localhost'

See Also:

Constant Field Values

serverHost

protected static java.lang.String serverHost

defaults to 'localhost'

PROPERTY_REGISTRY_PORT

public static final java.lang.String PROPERTY_REGISTRY_PORT

"registry.port", used to set registry port on which the registry is created.

See Also:

Constant Field Values

PROPERTY_SERVER_PORT

public static final java.lang.String PROPERTY_SERVER_PORT

"server.port", used to set server port number on which to export the remote object, on which the remote object receives calls.

See Also:

Constant Field Values

registryPort

protected int registryPort

the port used by the registry for looking up the RMI server, the default is 1099

remoteType

protected java.lang.String remoteType

'Remote':Override to indicate Remote RMI type in RMI and debug messages. Each subclass will normally set this to a unique value for the subclass during the construction of a new subclass instance.

Constructor Detail

RemoteRoot

public RemoteRoot()
           throws java.rmi.RemoteException

Constructor for RemoteRoot Subclasses should call super() for this superclass and should also set the remoteType to whatever they need.

Throws:

java.rmi.RemoteException

RemoteRoot

public RemoteRoot(int port)
           throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

Method Detail

init

public void init()

rebindLocalRMIRegistry

protected void rebindLocalRMIRegistry(java.lang.String serverName,
                                      java.rmi.Remote server)
                               throws java.rmi.RemoteException

rebind a RMI server object to the localhost RMI Registry. This is only needed by server objects calling any form of Registry.rebind(). Client objects don't normally call this.

If no valid localhost registry is found then we will attempt to create one. Currently, we attempt to create one on port registryPort , which is the Java RMI default port for RMI.

The security policy for the JVM running this RMI Registry may need the additional permissions specified in:

SAFS\lib\java.policy

Throws:

java.rmi.RemoteException

finalize

protected void finalize()
                 throws java.lang.Throwable

without this the bootstrap loading mechanism of the JVMAgent class fails with some VerifyError this occurs on some computer environments in not clarified circumstances

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable