stella.rmi

Class TestReceiver

java.lang.Object

util.PropertyContainer

util.PropertyResources

util.rmi.RmiPropertyContainer

util.rmi.AbstractRmiListener

stella.rmi.AbstractRmiCasterAndListener

stella.rmi.ReceiverTorso

stella.rmi.GenericMaster

stella.rmi.TestReceiver

All Implemented Interfaces:

Cloneable, Remote, EventListener, Caster, ErrorSending, ErrorCaster, Alive, ListenerControlling, RmiAcknowledgeCaster, RmiCommandListener, RmiDoneCaster, RmiErrorCaster, RmiParameterClustering, AlarmHandler, ExitCleaning, PropertySupplying, ResourceSupplying, RmiCaster, RmiEventListener, RmiListener, RmiPropertyBearing, TriggerableReload, StepInitializable

public final class TestReceiver
extends GenericMaster

The receiver end to the test caster method. This class waits for command from the test caster and generates (sometimes multiple) acknowledge events and a done event as a return. To test the time-out capabilities of the caster, the processCommand(stella.CommandEvent, int) method has a 0.1 probablility to generate a time-out on the caster end.

Nested Class Summary

Nested classes/interfaces inherited from class stella.rmi.GenericMaster

GenericMaster.Standalone

Nested classes/interfaces inherited from class stella.rmi.ReceiverTorso

ReceiverTorso.CommandHandler

Nested classes/interfaces inherited from class util.PropertyResources

PropertyResources.Load, PropertyResources.URLResource

Field Summary

Fields

Modifier and Type	Field and Description
private static long	DEFACKMAX The default maximum acknowledge time.
private static long	DEFACKMIN The default minimum acknowledge time.
private static double	DEFCOMMANDFAIL The default probability of command execution failure.
private static double	DEFCOMMANDLONG The default probability of command execution time-out.
private static double	DEFSTATUSPROB The default probability of generating a status.
private List	errors The error classes available for this test receiver.
private Class	handles The class type of commands accepted.
static String	KEY_ACCEPTS The interface name of accepted commands.
static String	KEY_ACKMAX The maximum acknowledge time sent back.
static String	KEY_ACKMIN The minimum acknowledge time sent back.
static String	KEY_COMMANDFAIL The probability of command execution failure.
static String	KEY_COMMANDLONG The probability of command execution time-out.
static String	KEY_ERRORS A list of error classes that might be generated.
static String	KEY_STATUSPROB The probability of generating a status.

Fields inherited from class stella.rmi.GenericMaster

DEFUNIQUE, KEY_ABORTTIME, KEY_AUTOMATIC, KEY_COMMTIME, KEY_COMMUNICATOR, KEY_DRIVERS, KEY_HISTORYDB, KEY_INITTIME, KEY_NODB, KEY_OBSERVEDB, KEY_OVERRULEAUTO, KEY_PARKTIME, KEY_PERMISSIONDB, KEY_PROPOSALDB, KEY_QUITTIME, KEY_REAUTO, KEY_RESETTIME, KEY_SET, KEY_SHUTDOWNDELAY, KEY_STATUSTIME, KEY_TARGETDB, KEY_TASKDB, KEY_UNIQUE, KEY_USERDB, lastabort, lastinit, lastpark, lastreset, telescope

Fields inherited from class stella.rmi.ReceiverTorso

KEY_BIND, KEY_BINDNAME, KEY_COMMANDCASTER, KEY_ERRORCOOL

Fields inherited from class util.rmi.AbstractRmiListener

KEY_ALIVE, KEY_EXPORTPORT, KEY_INIT, KEY_LISTENERNAME, KEY_RETRY, KEY_RETRYSLEEP

Fields inherited from class util.PropertyResources

KEY_NOINITONCREATE, POSTFIX_ALPHABET, POSTFIX_BYTES, POSTFIX_DIR, POSTFIX_EXT, POSTFIX_FILE, POSTFIX_LIST, POSTFIX_MODTIME, POSTFIX_URL

Fields inherited from class util.PropertyContainer

KEY_LISTSEPARATOR, KEY_MAPKEYVALUECHAR, KEY_MAPSEPARATOR

Fields inherited from interface stella.rmi.RmiAcknowledgeCaster

NAMING_EXTENSION

Fields inherited from interface stella.rmi.RmiDoneCaster

NAMING_EXTENSION

Fields inherited from interface util.StepInitializable

KEY_INITDEPTH

Fields inherited from interface util.ResourceSupplying

KEY_URLRESOURCES, KEY_URLUSECONFIG, KEY_URLUSECURRENT, KEY_URLUSEHOME

Fields inherited from interface util.PropertySupplying

CONFIG, KEY_CLASS

Constructor Summary

Constructors

Constructor and Description
TestReceiver(Map ensure) Constructs a new test receiver.

Method Summary

Modifier and Type	Method and Description
boolean	accepts(CommandEvent ce) A tester accepts the commands that are defined with the KEY_ACCEPTS command.
protected int	getAcknowledgeNumber(CommandEvent cmd) Returns the number of acknowledge messages that will be generated for this command.
protected long	getCompletionTime(CommandEvent ignore, int dummytype) Returns a time between KEY_ACKMIN and KEY_ACKMAX.
protected ErrorEvent	getLastError(CommandEvent dummy) Returns a randomly selected error out of the errorlist.
protected boolean	initializeMaster(CommandEvent dummy) Method called to init the device.
static void	main(String[] arg) For testing.
protected boolean	parkMaster(CommandEvent dummy) Method called to park the device.
protected boolean	processCommand(CommandEvent ignore, int dummytype) Processes the given command.
protected boolean	resetMaster(CommandEvent dummy) Method called to reset the device.
protected Object	statusMaster(CommandEvent dummy) Method called to return the status string.

Methods inherited from class stella.rmi.GenericMaster

abortMaster, addErrorListener, addRmiErrorListener, automatic, createCommunicator, createCommunicator, exit, external, formatWithGlobals, getAllDrivers, getDriver, getHistorySql, getObserveSql, getOffsetCaster, getParameterByKey, getParameterByName, getParameterCluster, getParameterValueByKey, getParameterValueByName, getPermissionSql, getProposalSql, getStatus, getTargetSql, getTaskSql, getUnique, getUniqueId, getUserSql, initialize, initStep, isAlive, isAuto, isManual, isPassive, manual, park, quit, quitMaster, reload, rescanned, reset, resetAlarm, resetAllDrivers, restartAllDrivers, revert, rmiAddParameter, rmiCommand, rmiGet, rmiGetAllParameterNames, rmiRemoveParameter, rmiSet, setLastError, setOff, setParameterValueByKey, setParameterValueByName, setPassive, shutdown, zeroAllOmc

Methods inherited from class stella.rmi.ReceiverTorso

addRmiAcknowledgeListener, addRmiDoneListener, bindDefault, containsRemoteProperty, deregisterAtCaster, equals, getRemoteProperties, getRemoteProperty, hashCode, notifyAcknowledgeListener, notifyDoneListener, registerAtCaster, removeRmiAcknowledgeListener, removeRmiDoneListener, sendAllPrematureDone, sendPrematureDone, setRemoteProperty, toString, unbindDefault

Methods inherited from class stella.rmi.AbstractRmiCasterAndListener

bindToRegistry, getBindName, isValid, notifyErrorListener, removeErrorListener, removeRmiErrorListener, sendError, sendError, sendError, sendStatus, sendStatus, sendStatus, unbindFromRegistry

Methods inherited from class util.rmi.AbstractRmiListener

allBound, blockBinding, blockBinding, disconnect, getIP, getListenerName, isConnected, listenerName, releaseBinding, releaseBinding, startBinding, startBinding

Methods inherited from class util.PropertyResources

clone, createFrom, createFrom, createFrom, createInstance, getApplet, getAsResources, getLocate, getPropertiesToKey, getPropertiesToKey, getResource, getResourceAsStream, getResourceFromKey, getResources, hasLocalURLs, initProperties, keyCreate, keyCreate, reload, setApplet

Methods inherited from class util.PropertyContainer

augment, augment, augment, augment, augment, defaultBoolean, defaultChar, defaultDouble, defaultFloat, defaultInt, defaultLong, defaultObject, defaultObject, defaultProperties, defaultProperty, getAsBoolean, getAsChar, getAsDouble, getAsEnums, getAsFloat, getAsInt, getAsList, getAsLong, getAsMap, getAsMap, getAsObject, getAsObject, getProperties, getProperty, has, isNew, parseObject, parseObject, removeProperty, requires, setObject, setProperties, setProperty, stringProperties

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface util.rmi.RmiCaster

bindToRegistry, isValid, unbindFromRegistry

Methods inherited from interface stella.ErrorCaster

removeErrorListener

Methods inherited from interface util.rmi.RmiEventListener

getListenerName

Methods inherited from interface util.rmi.RmiListener

disconnect, isConnected

Methods inherited from interface util.PropertySupplying

defaultBoolean, defaultChar, defaultDouble, defaultFloat, defaultInt, defaultLong, defaultObject, defaultObject, defaultProperties, defaultProperty, getAsBoolean, getAsChar, getAsDouble, getAsFloat, getAsInt, getAsList, getAsLong, getAsMap, getAsObject, getAsObject, getProperties, getProperty, has, parseObject, removeProperty, setObject, setProperty, stringProperties

Field Detail

KEY_ACCEPTS

public static final String KEY_ACCEPTS

The interface name of accepted commands.

See Also:

Constant Field Values

KEY_ERRORS

public static final String KEY_ERRORS

A list of error classes that might be generated.

See Also:

Constant Field Values

KEY_ACKMIN

public static final String KEY_ACKMIN

The minimum acknowledge time sent back.

See Also:

Constant Field Values

KEY_ACKMAX

public static final String KEY_ACKMAX

The maximum acknowledge time sent back.

See Also:

Constant Field Values

KEY_COMMANDFAIL

public static final String KEY_COMMANDFAIL

The probability of command execution failure.

See Also:

Constant Field Values

KEY_COMMANDLONG

public static final String KEY_COMMANDLONG

The probability of command execution time-out.

See Also:

Constant Field Values

KEY_STATUSPROB

public static final String KEY_STATUSPROB

The probability of generating a status.

See Also:

Constant Field Values

DEFACKMIN

private static final long DEFACKMIN

The default minimum acknowledge time.

See Also:

Constant Field Values

DEFACKMAX

private static final long DEFACKMAX

The default maximum acknowledge time.

See Also:

Constant Field Values

DEFCOMMANDFAIL

private static final double DEFCOMMANDFAIL

The default probability of command execution failure.

See Also:

Constant Field Values

DEFCOMMANDLONG

private static final double DEFCOMMANDLONG

The default probability of command execution time-out.

See Also:

Constant Field Values

DEFSTATUSPROB

private static final double DEFSTATUSPROB

The default probability of generating a status.

See Also:

Constant Field Values

handles

private Class handles

The class type of commands accepted.

errors

private List errors

The error classes available for this test receiver.

Constructor Detail

TestReceiver

public TestReceiver(Map ensure)
             throws RemoteException

Constructs a new test receiver. Registers System.err as an error listener.

Throws:

RemoteException

Method Detail

accepts

public boolean accepts(CommandEvent ce)
                throws RemoteException

A tester accepts the commands that are defined with the KEY_ACCEPTS command. If the command handed over is an instance of the class (interface) represented by the class named with the KEY_ACCEPTS key, it will return true. If the key is missing, true will be returned.

Throws:

RemoteException

getAcknowledgeNumber

protected int getAcknowledgeNumber(CommandEvent cmd)

Returns the number of acknowledge messages that will be generated for this command. The test receiver relies solely on the expected number of acknowledge events transported with the command.

Overrides:

getAcknowledgeNumber in class GenericMaster

getCompletionTime

protected long getCompletionTime(CommandEvent ignore,
                                 int dummytype)

Returns a time between KEY_ACKMIN and KEY_ACKMAX.

Overrides:

getCompletionTime in class GenericMaster

Parameters:

ignore - The command to process.

dummytype - The number of the acknowledge that will be sent back.

processCommand

protected boolean processCommand(CommandEvent ignore,
                                 int dummytype)

Processes the given command. Depending on the KEY_COMMANDLONG probability, the execution of this command may take longer than the acknowledge time sent back. Note that KEY_COMMANDLONG probability is a maximum failure probability because the acknowledge time sent back may vary between KEY_ACKMIN and KEY_ACKMAX, while the KEY_COMMANDLONG probability is the probability that the execution of the command will take longert than KEY_ACKMIN. With a probability of KEY_COMMANDFAIL the command execution will fail, resulting in an error to be generated and sent back, see KEY_ERRORS. A simple status message is sent with a probability of KEY_STATUSPROB.

Overrides:

processCommand in class GenericMaster

getLastError

protected ErrorEvent getLastError(CommandEvent dummy)

Returns a randomly selected error out of the errorlist. If the errorlist is not present or the error cannot be instantiated, null is returned.

Overrides:

getLastError in class ReceiverTorso

resetMaster

protected boolean resetMaster(CommandEvent dummy)

Method called to reset the device.

Specified by:

resetMaster in class GenericMaster

Parameters:

dummy - Non-null in automatic mode.

initializeMaster

protected boolean initializeMaster(CommandEvent dummy)

Method called to init the device.

Specified by:

initializeMaster in class GenericMaster

Parameters:

dummy - Non-null in automatic mode.

parkMaster

protected boolean parkMaster(CommandEvent dummy)

Method called to park the device.

Specified by:

parkMaster in class GenericMaster

Parameters:

dummy - Non-null in automatic mode.

statusMaster

protected Object statusMaster(CommandEvent dummy)

Method called to return the status string.

Specified by:

statusMaster in class GenericMaster

Parameters:

dummy - Non-null in automatic mode.

Returns:

A string or an ErrorEvent.

main

public static void main(String[] arg)
                 throws RemoteException

For testing. Registers to the command caster given in the first command line argument.

Throws:

RemoteException