org.safs.rmi.engine

Class AgentImpl

java.lang.Object

java.rmi.server.RemoteObject

java.rmi.server.RemoteServer

java.rmi.server.UnicastRemoteObject

org.safs.rmi.engine.RemoteRoot

org.safs.rmi.engine.AgentImpl

All Implemented Interfaces:

java.io.Serializable, java.rmi.Remote, Agent, SubItemsAgent

public class AgentImpl
extends RemoteRoot
implements Agent, SubItemsAgent

This is an initial concrete implementation of our RMI Agent Interface. This class can be inserted into each JVM by our Bootstrap AgentClassLoader and subsequently communicates with a local or remote SAFS RMI server for automated testing.

To insert this class via the AgentClassLoader the following minimum settings must appear in the safsjvmagent.properties file:

safsjvmagent.properties:

safs.jvmagent.classes=org.safs.rmi.engine.AgentImpl
safs.jvmagent.classpath=c:/safs/lib/jaccess.jar;c:/safs/lib/safs.jar

To seek a remote SAFS RMI Server the System Property 'sas.server.hostname' must be set and contain the hostname of the machine expected to contain the RMI Server.

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.rmi.engine.AgentImpl

Minimum java.policy permissions needed for successful execution:

      // Allow RMI server objects to receive requests on this machine on port 1024 or higher.
      permission java.net.SocketPermission "*:1024-", "connect,accept,resolve";
      permission java.lang.RuntimePermission "shutdownHooks";
 

Author:

Carl Nagle FEB 01, 2005 Original, Carl Nagle MAR 23, 2006 added debugLogSystemProperties, Carl Nagle FEB 18, 2015 added RMI support to remote hosts

See Also:

Agent, Server, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AgentImpl.ServerMonitor Polls the server host for a Java Registry every few seconds until one with the proper server object is found.
protected class	AgentImpl.STAFMonitor Polls for the existence of STAF every few seconds until 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_RMI_AGENT 'Agent':Subclasses will override to provide unique Agent remoteType.
static java.lang.String	DEFAULT_RMI_SERVER
protected AgentImpl.ServerMonitor	monitor
protected boolean	no_staf
protected java.rmi.server.ObjID	objID
protected Server	server
protected java.lang.String	serverName Subclasses will override to seek out different RMI Server Objects.
protected boolean	shutdown
protected STAFHelper	stafHelper
protected AgentImpl.STAFMonitor	stafmonitor
protected boolean	stafshutdown

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

DEFAULT_RMI_SERVER_HOST, PROPERTY_REGISTRY_PORT, PROPERTY_SERVER_PORT, registryPort, remoteType, serverHost

Fields inherited from class java.rmi.server.RemoteObject

ref

Fields inherited from interface org.safs.rmi.engine.Agent

SERVER_HOSTNAME_SYSTEM_PROPERTY

Constructor Summary

Constructors

Constructor and Description
AgentImpl() Constructor for AgentImpl.

Method Summary

Modifier and Type	Method and Description
protected static void	debugLogSystemProperties() Log.debug all available Java System Properties.
protected void	finalize() If we have registered with a RMI Server object then unRegister with that object.
java.rmi.server.ObjID	getAgentID() Returns an ObjID to uniquely identify the JVM Agent.
java.lang.String	getAgentName() Returns the name or remoteType of the JVM Agent.
java.lang.String	getCaption(java.lang.Object object) Default implementation throws SAFSActionUnsupportedRuntimeException("Caption Unsupported").
int	getChildCount(java.lang.Object parent) Default implementation simply throws SAFSActionUnsupportedRuntimeException("ChildCount Unsupported").
java.lang.Object[]	getChildren(java.lang.Object parent) Default implementation simply throws SAFSActionUnsupportedRuntimeException("Children Unsupported").
java.lang.String	getClassName(java.lang.Object object) Default implementation throws SAFSActionUnsupportedRuntimeException("ClassName Unsupported").
java.lang.String	getID(java.lang.Object object) Default implementation throws SAFSActionUnsupportedRuntimeException("ID Unsupported").
int	getLevel(java.lang.Object object) Default implementation throws SAFSActionUnsupportedRuntimeException("Levelv").
java.lang.Object	getMatchingPathObject(java.lang.Object theObject, java.lang.String thePath) Mechanism to retrieve a subitem/object identified by the provided Path.
java.lang.String	getName(java.lang.Object object) Default implementation throws SAFSActionUnsupportedRuntimeException("Name Unsupported").
java.lang.String	getProperty(java.lang.Object object, java.lang.String property) Default implementation throws SAFSActionUnsupportedRuntimeException("Property Unsupported").
java.lang.String[]	getPropertyNames(java.lang.Object object) Default implementation throws SAFSActionUnsupportedRuntimeException("PropertyNames Unsupported").
java.lang.String[][]	getStringData(java.lang.Object object, java.lang.Object dataInfo) Default implementation throws SAFSActionUnsupportedRuntimeException("StringData Unsupported").
java.lang.Object	getSubItemAtIndex(java.lang.Object object, int index) Default no-op simply throws SAFSSubItemsAgentUnsupportedRuntimeException("SubItemAtIndex Unsupported").
java.lang.String[]	getSuperClassNames(java.lang.Object object) Default implementation throws SAFSActionUnsupportedRuntimeException("SuperClassNames Unsupported").
java.lang.String	getText(java.lang.Object object) Default implementation throws SAFSActionUnsupportedRuntimeException("Text Unsupported").
int	getTopLevelCount() Default implementation simply throws SAFSActionUnsupportedRuntimeException("TopLevelCount Unsupported").
java.lang.Object[]	getTopLevelWindows() Default implementation simply throws SAFSActionUnsupportedRuntimeException("TopLevelWindows Unsupported").
protected void	initialize() MUST be called by subclasses after object creation
boolean	isMatchingPath(java.lang.Object theObject, java.lang.String thePath) Mechanism to determine if the object contains a subitem/object identified by the provided Path.
boolean	isShowing(java.lang.Object object) Default implementation throws SAFSActionUnsupportedRuntimeException("Showing Unsupported").
boolean	isValid(java.lang.Object object) Default implementation throws SAFSActionUnsupportedRuntimeException("Valid Unsupported").
static void	main(java.lang.String[] args) Primarily just a test instantiation to seek an RMI server.
void	ping() Does nothing but verify the integrity of the RMI connection and log entry.
TestRecordData	process(java.lang.Object object, TestRecordData testRecordData) Default implementation simply throws a SAFSActionUnsupportedRuntimeException("process Unsupported").
java.lang.Object	runCommand(java.lang.Object command) Default implementation throws SAFSActionUnsupportedRuntimeException("runCommand Unsupported").
void	setActiveWindow(java.lang.Object theObject) Attempts to set theObject as the active (topmost?) Window or Component in the JVM.
void	shutdown() Removes any RMI server reference we might already have and restarts a new ServerMonitor to watch for a new RMI server object.

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

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_RMI_SERVER

public static final java.lang.String DEFAULT_RMI_SERVER

See Also:

ServerImpl.DEFAULT_RMI_SERVER, Constant Field Values

DEFAULT_RMI_AGENT

public static final java.lang.String DEFAULT_RMI_AGENT

'Agent':Subclasses will override to provide unique Agent remoteType.

See Also:

Constant Field Values

serverName

protected java.lang.String serverName

Subclasses will override to seek out different RMI Server Objects.

server

protected Server server

shutdown

protected boolean shutdown

stafshutdown

protected boolean stafshutdown

monitor

protected AgentImpl.ServerMonitor monitor

stafmonitor

protected AgentImpl.STAFMonitor stafmonitor

objID

protected java.rmi.server.ObjID objID

no_staf

protected boolean no_staf

stafHelper

protected STAFHelper stafHelper

Constructor Detail

AgentImpl

public AgentImpl()
          throws java.rmi.RemoteException

Constructor for AgentImpl. This will create a ServerMonitor object that will periodically poll for the localhost RMI Server object with serverName. The class will also attempt to register a ShutdownHook in the Java Runtime so that we can try to gracefully unregister from the RMI Server object when the JVM is shutting down.

Some web browsers launching a JVM may allow us to register a shutdown hook but may not actually execute the hook upon JVM shutdown.

Throws:

java.rmi.RemoteException

Method Detail

initialize

protected void initialize()

MUST be called by subclasses after object creation

ping

public void ping()
          throws java.rmi.RemoteException

Does nothing but verify the integrity of the RMI connection and log entry.

Specified by:

ping in interface Agent

Throws:

java.rmi.RemoteException

See Also:

Agent.ping()

getAgentID

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

Description copied from interface: Agent

Returns an ObjID to uniquely identify the JVM Agent.

Specified by:

getAgentID in interface Agent

Throws:

java.rmi.RemoteException

See Also:

Agent.getAgentID()

getAgentName

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

Description copied from interface: Agent

Returns the name or remoteType of the JVM Agent.

Specified by:

getAgentName in interface Agent

Throws:

java.rmi.RemoteException

See Also:

Agent.getAgentName()

process

public TestRecordData process(java.lang.Object object,
                              TestRecordData testRecordData)
                       throws java.rmi.RemoteException,
                              java.lang.Exception

Default implementation simply throws a SAFSActionUnsupportedRuntimeException("process Unsupported"). An Agent may throw various types of Agent-specific RuntimeExceptions depending upon failure modes. A Server should catch the RemoteException and Exception but test for subclasses of RuntimeException and possibly let them through.

Specified by:

process in interface Agent

testRecordData - provides all the information needed by the Agent to perform an action. The RMI version of TestRecordData is likely going to be much sparser than the typical TestRecordHelper. It will also be pretty specific to the concrete implementations for the Server and Agent.

Returns:

TestRecordData which includes the statuscode

Throws:

SAFSActionUnsupportedRuntimeException("process - Unsupported")

java.rmi.RemoteException

java.lang.Exception

See Also:

Agent.process(Object,TestRecordData)

shutdown

public void shutdown()
              throws java.rmi.RemoteException

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 Agent

Throws:

java.rmi.RemoteException

See Also:

Agent.shutdown()

getTopLevelCount

public int getTopLevelCount()
                     throws java.rmi.RemoteException,
                            java.lang.Exception

Default implementation simply throws SAFSActionUnsupportedRuntimeException("TopLevelCount Unsupported").

Specified by:

getTopLevelCount in interface Agent

Throws:

SAFSActionUnsupportedRuntimeException("TopLevelCount - Unsupported")

java.rmi.RemoteException

java.lang.Exception

See Also:

Agent.getTopLevelCount()

getTopLevelWindows

public java.lang.Object[] getTopLevelWindows()
                                      throws java.rmi.RemoteException,
                                             java.lang.Exception

Default implementation simply throws SAFSActionUnsupportedRuntimeException("TopLevelWindows Unsupported").

Specified by:

getTopLevelWindows in interface Agent

Returns:

Object[] representing all active top level windows in the Agent JVM. This array will be Server/Agent specific and may be nothing more than arrays of the hashcodes used to uniquely identify objects in an Agent-maintained Hashtable. A zero-length array will be returned if no Top Level Windows are active.

Throws:

SAFSActionUnsupportedRuntimeException("TopLevelWindows - Unsupported")

java.rmi.RemoteException

java.lang.Exception

See Also:

Agent.getTopLevelWindows()

getChildCount

public int getChildCount(java.lang.Object parent)
                  throws java.rmi.RemoteException,
                         java.lang.Exception

Default implementation simply throws SAFSActionUnsupportedRuntimeException("ChildCount Unsupported").

Specified by:

getChildCount in interface Agent

Throws:

SAFSActionUnsupportedRuntimeException("ChildCount - Unsupported")

java.rmi.RemoteException

java.lang.Exception

See Also:

Agent.getChildCount(Object)

getChildren

public java.lang.Object[] getChildren(java.lang.Object parent)
                               throws java.rmi.RemoteException,
                                      java.lang.Exception

Default implementation simply throws SAFSActionUnsupportedRuntimeException("Children Unsupported").

Specified by:

getChildren in interface Agent

Parameters:

parent - An object from getTopLevelWindows or from a previous call to getChildren. The parent is often one of the elements of the TopLevelWindow array or somewhere lower in that same hierarchy.

Returns:

Object[] representing all known children of the provided parent. This array will be Server/Agent specific and may be nothing more than arrays of the hashcodes used to uniquely identify objects in an Agent-maintained Hashtable. A zero-length array will be returned if the parent has no children.

Throws:

SAFSActionUnsupportedRuntimeException("Children - Unsupported")

java.rmi.RemoteException

java.lang.Exception

See Also:

Agent.getChildren(Object)

getCaption

public java.lang.String getCaption(java.lang.Object object)
                            throws java.rmi.RemoteException,
                                   java.lang.Exception

Default implementation throws SAFSActionUnsupportedRuntimeException("Caption Unsupported").

Specified by:

getCaption in interface Agent

Parameters:

object - An object from getTopLevelWindows or from a previous call to getChildren.

Returns:

String the caption of the object.

Throws:

SAFSActionUnsupportedRuntimeException("Caption - Unsupported")

java.lang.NoSuchFieldException - if the object does not provide a caption.

java.rmi.RemoteException

java.lang.Exception

See Also:

Agent.getCaption(Object)

getName

public java.lang.String getName(java.lang.Object object)
                         throws java.rmi.RemoteException,
                                java.lang.Exception

Default implementation throws SAFSActionUnsupportedRuntimeException("Name Unsupported").

Specified by:

getName in interface Agent

Parameters:

object - An object from getTopLevelWindows or from a previous call to getChildren.

Returns:

String the name of the object.

Throws:

SAFSActionUnsupportedRuntimeException("Name - Unsupported")

java.lang.NoSuchFieldException - if the object does not provide a name.

java.rmi.RemoteException

java.lang.Exception

See Also:

Agent.getName(Object)

getID

public java.lang.String getID(java.lang.Object object)
                       throws java.rmi.RemoteException,
                              java.lang.Exception

Default implementation throws SAFSActionUnsupportedRuntimeException("ID Unsupported").

Specified by:

getID in interface Agent

Parameters:

object - An object from getTopLevelWindows or from a previous call to getChildren.

Returns:

String the ID of the object.

Throws:

SAFSActionUnsupportedRuntimeException("ID - Unsupported")

java.lang.NoSuchFieldException - if the object does not provide an ID.

java.rmi.RemoteException

java.lang.Exception

See Also:

Agent.getID(Object)

getText

public java.lang.String getText(java.lang.Object object)
                         throws java.rmi.RemoteException,
                                java.lang.Exception

Default implementation throws SAFSActionUnsupportedRuntimeException("Text Unsupported").

Specified by:

getText in interface Agent

Parameters:

object - An object from getTopLevelWindows or from a previous call to getChildren.

Returns:

String the text value of the object. Since text values can theoretically legally be zero-length, a null value will be returned if no value exists for the object.

Throws:

SAFSActionUnsupportedRuntimeException("Text - Unsupported")

java.rmi.RemoteException

java.lang.Exception

See Also:

Agent.getText(Object)

getPropertyNames

public java.lang.String[] getPropertyNames(java.lang.Object object)
                                    throws java.rmi.RemoteException,
                                           java.lang.Exception

Default implementation throws SAFSActionUnsupportedRuntimeException("PropertyNames Unsupported").

Specified by:

getPropertyNames in interface Agent

Parameters:

object - An object from getTopLevelWindows or from a previous call to getChildren.

Returns:

String[] the names of available properties.

Throws:

SAFSActionUnsupportedRuntimeException("PropertyNames - Unsupported")

java.rmi.RemoteException

java.lang.Exception

See Also:

Agent.getProperty(Object, String)

getProperty

public java.lang.String getProperty(java.lang.Object object,
                                    java.lang.String property)
                             throws java.rmi.RemoteException,
                                    java.lang.Exception

Default implementation throws SAFSActionUnsupportedRuntimeException("Property Unsupported").

Specified by:

getProperty in interface Agent

Parameters:

object - -- An object from getTopLevelWindows or from a previous call to getChildren.

property - -- the case-sensitive name of the property to seek.

Returns:

String the text value of the object property. Since property values can theoretically legally be zero-length, a null value will be returned if no value exists for the object.

Throws:

SAFSActionUnsupportedRuntimeException("Property - Unsupported")

java.rmi.RemoteException

java.lang.Exception

See Also:

Agent.getProperty(Object, String)

getClassName

public java.lang.String getClassName(java.lang.Object object)
                              throws java.rmi.RemoteException,
                                     java.lang.Exception

Default implementation throws SAFSActionUnsupportedRuntimeException("ClassName Unsupported").

Specified by:

getClassName in interface Agent

Parameters:

object - An object from getTopLevelWindows or from a previous call to getChildren.

Returns:

String Class name of the object.

Throws:

SAFSActionUnsupportedRuntimeException("ClassName - Unsupported")

java.rmi.RemoteException

java.lang.Exception

See Also:

Agent.getClassName(Object)

getLevel

public int getLevel(java.lang.Object object)
             throws java.rmi.RemoteException,
                    java.lang.Exception

Default implementation throws SAFSActionUnsupportedRuntimeException("Levelv").

Specified by:

getLevel in interface Agent

Parameters:

object - An object from getTopLevelWindows or from a previous call to getChildren.

Returns:

int z-order value of the object among all objects if this can be determined. 0 normally indicates the topmost Window. 1 is normally the Window behind that, etc..

Throws:

SAFSActionUnsupportedRuntimeException("Level - Unsupported")

java.rmi.RemoteException

java.lang.Exception

See Also:

Agent.getLevel(Object)

isShowing

public boolean isShowing(java.lang.Object object)
                  throws java.rmi.RemoteException,
                         java.lang.Exception

Default implementation throws SAFSActionUnsupportedRuntimeException("Showing Unsupported").

Specified by:

isShowing in interface Agent

Parameters:

object - An object from getTopLevelWindows or from a previous call to getChildren.

Returns:

boolean

Throws:

SAFSActionUnsupportedRuntimeException("Showing - Unsupported")

java.rmi.RemoteException

java.lang.Exception

See Also:

Agent.isShowing(Object)

isValid

public boolean isValid(java.lang.Object object)
                throws java.rmi.RemoteException,
                       java.lang.Exception

Default implementation throws SAFSActionUnsupportedRuntimeException("Valid Unsupported").

Specified by:

isValid in interface Agent

Parameters:

object - An object from getTopLevelWindows or from a previous call to getChildren.

Returns:

boolean true if the object is still valid/findable.

Throws:

SAFSActionUnsupportedRuntimeException("Valid - Unsupported")

java.rmi.RemoteException

java.lang.Exception

getSuperClassNames

public java.lang.String[] getSuperClassNames(java.lang.Object object)
                                      throws java.rmi.RemoteException,
                                             java.lang.Exception

Default implementation throws SAFSActionUnsupportedRuntimeException("SuperClassNames Unsupported").

Specified by:

getSuperClassNames in interface Agent

Parameters:

object - An object from getTopLevelWindows or from a previous call to getChildren.

Returns:

String[] Class names for the superclass hierarchy.

Throws:

SAFSActionUnsupportedRuntimeException("SuperClassNames - Unsupported")

java.rmi.RemoteException

java.lang.Exception

See Also:

Agent.getSuperClassNames(Object)

getStringData

public java.lang.String[][] getStringData(java.lang.Object object,
                                          java.lang.Object dataInfo)
                                   throws java.rmi.RemoteException,
                                          java.lang.NoSuchMethodException,
                                          java.lang.Exception

Default implementation throws SAFSActionUnsupportedRuntimeException("StringData Unsupported").

Specified by:

getStringData in interface Agent

Parameters:

object - An object from getTopLevelWindows or from a previous call to getChildren.

dataInfo - Allows us to specify what type of data we want returned. This will be specific to the types of objects from which we extract data. For example, Tables might provide "Contents" or "Headers" or other different types of data.

Returns:

String[][] 2D array of extracted data. 0-length arrays if no data is available or the ability to extract data is not supported.

Throws:

SAFSActionUnsupportedRuntimeException("StringData - Unsupported")

java.lang.NoSuchMethodException - if the object type does not support the extraction of data or the specific type of data requested.

java.rmi.RemoteException

java.lang.Exception

See Also:

Agent.getStringData(Object, Object)

getMatchingPathObject

public java.lang.Object getMatchingPathObject(java.lang.Object theObject,
                                              java.lang.String thePath)
                                       throws java.rmi.RemoteException,
                                              java.lang.Exception

Mechanism to retrieve a subitem/object identified by the provided Path. Path is hierarchical information showing parent->child relationships separated by '->'. This is often used in Menus and Trees.

Ex:

File->Exit
Root->Branch->Leaf Default implementation throws SAFSSubItemsAgentUnsupportedRuntimeException("MatchingPathObject Unsupported").

Specified by:

getMatchingPathObject in interface Agent

Specified by:

getMatchingPathObject in interface SubItemsAgent

Parameters:

theObject--Object - proxy for the object to be evaluated.

thePath - information to locate another object or subitem relative to theObject. this is usually something like a menuitem or tree node where supported.

Returns:

Object child sub-object found relative to theObject

Throws:

SAFSSubItemsAgentUnsupportedRuntimeException("MatchingPathObject - Unsupported")

java.rmi.RemoteException

java.lang.Exception

See Also:

Agent.getMatchingPathObject(Object, String)

isMatchingPath

public boolean isMatchingPath(java.lang.Object theObject,
                              java.lang.String thePath)
                       throws java.rmi.RemoteException,
                              java.lang.Exception

Mechanism to determine if the object contains a subitem/object identified by the provided Path. Path is hierarchical information showing parent->child relationships separated by '->'. This is often used in Menus and Trees.

Ex:

File->Exit
Root->Branch->Leaf Default implementation throws SAFSSubItemsAgentUnsupportedRuntimeException("MatchingPath Unsupported").

Specified by:

isMatchingPath in interface Agent

Specified by:

isMatchingPath in interface SubItemsAgent

Parameters:

theObject--Object - proxy for the object to be evaluated.

thePath - information to locate another object or subitem relative to theObject. this is usually something like a menuitem or tree node where supported.

Returns:

true if the child sub-object was found relative to theObject.

Throws:

SAFSSubItemsAgentUnsupportedRuntimeException("MatchingPath - Unsupported")

java.rmi.RemoteException

java.lang.Exception

See Also:

org.safs.rmi.engine.Agent#getMatchingPath(Object, String)

runCommand

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

Default implementation throws SAFSActionUnsupportedRuntimeException("runCommand Unsupported").

Specified by:

runCommand in interface Agent

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:

SAFSActionUnsupportedRuntimeException("runCommand - Unsupported");

java.rmi.RemoteException

java.lang.Exception

See Also:

Agent.runCommand(Object)

setActiveWindow

public void setActiveWindow(java.lang.Object theObject)
                     throws java.rmi.RemoteException,
                            java.lang.Exception

Attempts to set theObject as the active (topmost?) Window or Component in the JVM. Default implementation throws SAFSActionUnsupportedRuntimeException("runCommand Unsupported").

Specified by:

setActiveWindow in interface Agent

Parameters:

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

Throws:

SAFSActionUnsupportedRuntimeException("ActiveWindow - Unsupported");

java.rmi.RemoteException

java.lang.Exception

getSubItemAtIndex

public java.lang.Object getSubItemAtIndex(java.lang.Object object,
                                          int index)
                                   throws java.rmi.RemoteException,
                                          java.lang.Exception

Default no-op simply throws SAFSSubItemsAgentUnsupportedRuntimeException("SubItemAtIndex Unsupported").

Specified by:

getSubItemAtIndex in interface SubItemsAgent

Parameters:

object - reference from which to locate the subitem.

index - of the subitem to retrieve.

Returns:

subitem object or String

Throws:

java.lang.IndexOutOfBoundsException - if index is invalid

SAFSObjectNotFoundException - if subitem at index cannot be retrieved

SAFSSubItemsAgentUnsupportedRuntimeException("SubItemAtIndex - Unsupported") as necessay.

java.rmi.RemoteException

java.lang.Exception

See Also:

SubItemsAgent.getSubItemAtIndex(Object,int)

debugLogSystemProperties

protected static void debugLogSystemProperties()

Log.debug all available Java System Properties.

finalize

protected void finalize()
                 throws java.lang.Exception

If we have registered with a RMI Server object then unRegister with that object. If our ServerMonitor thread is still looking for a server then interrupt the thread and let the thread die.

Overrides:

finalize in class RemoteRoot

Throws:

java.lang.Exception

main

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

Primarily just a test instantiation to seek an RMI server. Example command-line invocation:

 java -cp %CLASSPATH% -Djava.security.policy=%SAFSDIR%\lib\java.policy
                      -Dsafs.server.hostname="hostname.internal.net" 
                      org.safs.rmi.engine.AgentImpl
 

Parameters:

args - -- none