MessageDriverNodeBase

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.sandev.basics.MessageDriver
Class MessageDriverNodeBase

java.lang.Object
  org.sandev.basics.MessageDriver.MessageDriverNodeDecl
      org.sandev.basics.MessageDriver.MessageDriverNodeBase

All Implemented Interfaces:: Controllable, Loggable, Messageable

Direct Known Subclasses:: MessageDriverNode

public class MessageDriverNodeBase
extends MessageDriverNodeDecl
implements Controllable, Messageable, Loggable

AUTOGENERATED FILE, DO NOT EDIT DIRECTLY.
source: org.sandev.basics.MessageDriver.MessageDriverNodeDecl
generator: org.sandev.generator.NodeClassGenerator
time: Dec 2, 2005 6:38:50 PM

This file contains:

messaging methods corresponding to the synchronous and asynchronous input and output declarations
accessor methods, initialization and maintenance code for declared configuration parameters
optionally overridable control hook methods called in response to node control state changes
utility methods

Field Summary
`protected ControlWrapper[]`	`ctrlwrappers` The control wrappers we need to notify of state or parameter changes.
`protected Controllable[]`	`helperNodes` Our helper nodes
`protected IODeclReceive`	`incomingSyncSandMessage` Inbound org.sandev.basics.structs.SandMessage synchronous messaging configuration
`protected static int`	`LOGDEBUG` Convenience redeclaration of corresponding Logger.LOGLEVEL constant
`protected static int`	`LOGERROR` Convenience redeclaration of corresponding Logger.LOGLEVEL constant
`protected static int`	`LOGFATAL` Convenience redeclaration of corresponding Logger.LOGLEVEL constant
`protected Logger`	`logger` Logfile output at specified severity levels.
`protected static int`	`LOGINFO` Convenience redeclaration of corresponding Logger.LOGLEVEL constant
`protected int`	`logLevel` Calls to log with severity levels less than this value will be ignored.
`static int`	`LOGLEVEL_DEBUG` Possible value for logLevel
`static int`	`LOGLEVEL_ERROR` Possible value for logLevel
`static int`	`LOGLEVEL_FATAL` Possible value for logLevel
`static int`	`LOGLEVEL_INFO` Possible value for logLevel
`static int`	`LOGLEVEL_WARN` Possible value for logLevel
`protected static int`	`LOGWARN` Convenience redeclaration of corresponding Logger.LOGLEVEL constant
`protected Messager`	`messager` Communications to and from this node.
`protected NodeInstance`	`nodeInstance` The declaration used to initialize this node instance when it was first created.
`protected IODeclSend`	`outgoingAsyncSandMessage` Outbound org.sandev.basics.structs.SandMessage asynchronous messaging configuration
`protected Controllable`	`parent` Our parent node
`protected java.lang.String`	`sandNodeErrorMessage` Text details of the node execution error.
`protected int`	`sandNodeState` Runtime state of the node.
`static int`	`SANDNODESTATE_FAILED` Possible value for sandNodeState
`static int`	`SANDNODESTATE_FAILING` Possible value for sandNodeState
`static int`	`SANDNODESTATE_RESUMING` Possible value for sandNodeState
`static int`	`SANDNODESTATE_RUNNING` Possible value for sandNodeState
`static int`	`SANDNODESTATE_STARTING` Possible value for sandNodeState
`static int`	`SANDNODESTATE_STOPPED` Possible value for sandNodeState
`static int`	`SANDNODESTATE_STOPPING` Possible value for sandNodeState
`static int`	`SANDNODESTATE_SUSPENDED` Possible value for sandNodeState
`static int`	`SANDNODESTATE_SUSPENDING` Possible value for sandNodeState
`static int`	`SANDNODESTATE_UNDEFINED` Possible value for sandNodeState
`protected SandRoot`	`sandRoot` Back reference to the SandRoot that launched us.

Fields inherited from class org.sandev.basics.MessageDriver.MessageDriverNodeDecl

basePath, testScripts

Fields inherited from interface org.sandev.basics.nodecommon.Controllable

OPERATION_FAIL, OPERATION_RESUME, OPERATION_SHUTDOWN, OPERATION_STARTUP, OPERATION_STR_FAIL, OPERATION_STR_RESUME, OPERATION_STR_SHUTDOWN, OPERATION_STR_STARTUP, OPERATION_STR_SUSPEND, OPERATION_STR_UNDEFINED, OPERATION_STRINGS, OPERATION_SUSPEND, OPERATION_UNDEFINED, SHUTDOWN_ERROR_RESTART_GLOBAL, SHUTDOWN_ERROR_RESTART_LOCAL, SHUTDOWN_ERROR_TERMINATE, SHUTDOWN_NORMAL, STATE_FAILED, STATE_FAILING, STATE_RESUMING, STATE_RUNNING, STATE_STARTING, STATE_STOPPED, STATE_STOPPING, STATE_STR_FAILED, STATE_STR_FAILING, STATE_STR_RESUMING, STATE_STR_RUNNING, STATE_STR_STARTING, STATE_STR_STOPPED, STATE_STR_STOPPING, STATE_STR_SUSPENDED, STATE_STR_SUSPENDING, STATE_STR_UNDEFINED, STATE_STRINGS, STATE_SUSPENDED, STATE_SUSPENDING, STATE_UNDEFINED

Constructor Summary
`MessageDriverNodeBase()` Default constructor calls init.

Method Summary
`void`	`addTestScripts(java.lang.String element)` Appends a value to testScripts
`void`	`addTestScripts(java.lang.String[] elements)` Appends an array of values to testScripts
`void`	`addWrapper(ControlWrapper wrapper)` Add the specified wrapper to our notification collection
`void`	`clearTestScripts()` Clears all values from testScripts
`void`	`deliver(SandMessage msg)` Only those deliver methods explicitely declared by the node should actually be called.
`boolean`	`fieldHasFlag(java.lang.String fieldname, int fieldflag)` Return true if the named field declares the indicated flag, false otherwise.
`java.lang.String`	`getBasePath()` Accessor for basePath
`static java.lang.String`	`getBasePathDefaultValue()` Default value for basePath.
`java.lang.String`	`getBasePathFieldPrintValue()` Return the print name of the basePath field.
`static boolean`	`getBasePathFlag(int fieldflag)` Field flag accessor.
`static java.lang.String`	`getBasePathInvalidValue()` Invalid value for basePath.
`static int`	`getBasePathLengthMax()` Maximum basePath length is 70 characters
`static int`	`getBasePathLengthNorm()` Normal basePath length is 30 characters
`java.lang.String`	`getBasePathMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getBasePathPrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getBasePathRange()` Return the range specification for this field
`java.lang.String`	`getBasePathValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`Controllable[]`	`getHelperNodes()` accessor for helperNodes
`IDCache`	`getIDCache()` Stub for retrieving the IDCache used by this node.
`IODeclReceive`	`getIncomingSyncSandMessage()` Accessor for incomingSyncSandMessage
`static IODeclReceive`	`getIncomingSyncSandMessageDefaultValue()` Default value for incomingSyncSandMessage.
`java.lang.String`	`getIncomingSyncSandMessageFieldPrintValue()` Return the print name of the incomingSyncSandMessage field.
`static boolean`	`getIncomingSyncSandMessageFlag(int fieldflag)` Field flag accessor.
`static IODeclReceive`	`getIncomingSyncSandMessageInvalidValue()` Invalid value for incomingSyncSandMessage.
`java.lang.String`	`getIncomingSyncSandMessageMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getIncomingSyncSandMessagePrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getIncomingSyncSandMessageRange()` Return the range specification for this field
`java.lang.String`	`getIncomingSyncSandMessageValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`Logger`	`getLogger()` Accessor for logger
`static Logger`	`getLoggerDefaultValue()` Default value for logger.
`java.lang.String`	`getLoggerFieldPrintValue()` Return the print name of the logger field.
`static boolean`	`getLoggerFlag(int fieldflag)` Field flag accessor.
`static Logger`	`getLoggerInvalidValue()` Invalid value for logger.
`java.lang.String`	`getLoggerMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getLoggerPrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getLoggerRange()` Return the range specification for this field
`java.lang.String`	`getLoggerValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`int`	`getLogLevel()` Accessor for logLevel
`static java.lang.String[]`	`getLogLevelActualVals()` Return an array of the possible values for this field as Strings.
`static int`	`getLogLevelDefaultValue()` Default value for logLevel.
`static java.lang.String`	`getLogLevelEnumSummary()` Return a single String summary of the possible enum values for debug and similar purposes.
`java.lang.String`	`getLogLevelFieldPrintValue()` Return the print name of the logLevel field.
`static boolean`	`getLogLevelFlag(int fieldflag)` Field flag accessor.
`static int`	`getLogLevelInvalidValue()` Invalid value for logLevel.
`static java.lang.String[]`	`getLogLevelKeyVals()` Return an array of unique keys for the values of this field.
`java.lang.String`	`getLogLevelMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`static java.lang.String[]`	`getLogLevelPrintVals()` Return an array of the possible values for this field in display format.
`java.lang.String`	`getLogLevelPrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getLogLevelRange()` Return the range specification for this field
`java.lang.String`	`getLogLevelValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`Messager`	`getMessager()` Accessor for messager
`static Messager`	`getMessagerDefaultValue()` Default value for messager.
`java.lang.String`	`getMessagerFieldPrintValue()` Return the print name of the messager field.
`static boolean`	`getMessagerFlag(int fieldflag)` Field flag accessor.
`static Messager`	`getMessagerInvalidValue()` Invalid value for messager.
`java.lang.String`	`getMessagerMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getMessagerPrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getMessagerRange()` Return the range specification for this field
`java.lang.String`	`getMessagerValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`NodeInstance`	`getNodeInstance()` Accessor for nodeInstance
`static NodeInstance`	`getNodeInstanceDefaultValue()` Default value for nodeInstance.
`java.lang.String`	`getNodeInstanceFieldPrintValue()` Return the print name of the nodeInstance field.
`static boolean`	`getNodeInstanceFlag(int fieldflag)` Field flag accessor.
`static NodeInstance`	`getNodeInstanceInvalidValue()` Invalid value for nodeInstance.
`java.lang.String`	`getNodeInstanceMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getNodeInstanceName()` convenience wrapper method to retrieve our instance name
`java.lang.String`	`getNodeInstancePrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getNodeInstanceRange()` Return the range specification for this field
`java.lang.String`	`getNodeInstanceValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`IODeclSend`	`getOutgoingAsyncSandMessage()` Accessor for outgoingAsyncSandMessage
`static IODeclSend`	`getOutgoingAsyncSandMessageDefaultValue()` Default value for outgoingAsyncSandMessage.
`java.lang.String`	`getOutgoingAsyncSandMessageFieldPrintValue()` Return the print name of the outgoingAsyncSandMessage field.
`static boolean`	`getOutgoingAsyncSandMessageFlag(int fieldflag)` Field flag accessor.
`static IODeclSend`	`getOutgoingAsyncSandMessageInvalidValue()` Invalid value for outgoingAsyncSandMessage.
`java.lang.String`	`getOutgoingAsyncSandMessageMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getOutgoingAsyncSandMessagePrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getOutgoingAsyncSandMessageRange()` Return the range specification for this field
`java.lang.String`	`getOutgoingAsyncSandMessageValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`Controllable`	`getParent()` accessor for parent
`java.lang.String`	`getSandNodeErrorMessage()` Accessor for sandNodeErrorMessage
`static java.lang.String`	`getSandNodeErrorMessageDefaultValue()` Default value for sandNodeErrorMessage.
`java.lang.String`	`getSandNodeErrorMessageFieldPrintValue()` Return the print name of the sandNodeErrorMessage field.
`static boolean`	`getSandNodeErrorMessageFlag(int fieldflag)` Field flag accessor.
`static java.lang.String`	`getSandNodeErrorMessageInvalidValue()` Invalid value for sandNodeErrorMessage.
`static int`	`getSandNodeErrorMessageLengthMax()` Maximum sandNodeErrorMessage length is 70 characters
`static int`	`getSandNodeErrorMessageLengthNorm()` Normal sandNodeErrorMessage length is 30 characters
`java.lang.String`	`getSandNodeErrorMessageMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getSandNodeErrorMessagePrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getSandNodeErrorMessageRange()` Return the range specification for this field
`java.lang.String`	`getSandNodeErrorMessageValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`int`	`getSandNodeState()` Accessor for sandNodeState
`static java.lang.String[]`	`getSandNodeStateActualVals()` Return an array of the possible values for this field as Strings.
`static int`	`getSandNodeStateDefaultValue()` Default value for sandNodeState.
`static java.lang.String`	`getSandNodeStateEnumSummary()` Return a single String summary of the possible enum values for debug and similar purposes.
`java.lang.String`	`getSandNodeStateFieldPrintValue()` Return the print name of the sandNodeState field.
`static boolean`	`getSandNodeStateFlag(int fieldflag)` Field flag accessor.
`static int`	`getSandNodeStateInvalidValue()` Invalid value for sandNodeState.
`static java.lang.String[]`	`getSandNodeStateKeyVals()` Return an array of unique keys for the values of this field.
`java.lang.String`	`getSandNodeStateMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`static java.lang.String[]`	`getSandNodeStatePrintVals()` Return an array of the possible values for this field in display format.
`java.lang.String`	`getSandNodeStatePrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getSandNodeStateRange()` Return the range specification for this field
`java.lang.String`	`getSandNodeStateValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`SandRoot`	`getSandRoot()` accessor for sandRoot
`java.lang.String`	`getServername()` convenience wrapper method to retrieve our home server name
`java.lang.String[]`	`getTestScripts()` Accessor for testScripts
`java.lang.String`	`getTestScripts(int index)` Returns the element at the specified index.
`static java.lang.String[]`	`getTestScriptsDefaultValue()` Default value for testScripts.
`static java.lang.String`	`getTestScriptsElementInvalidValue()` Invalid value for testScriptselement.
`static boolean`	`getTestScriptsFlag(int fieldflag)` Field flag accessor.
`static java.lang.String[]`	`getTestScriptsInvalidValue()` Invalid value for testScripts.
`static int`	`getTestScriptsLengthMax()` Maximum testScripts length is 70 characters
`static int`	`getTestScriptsLengthNorm()` Normal testScripts length is 30 characters
`java.lang.String`	`getTestScriptsMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getTestScriptsRange()` Return the range specification for this field
`java.lang.String`	`getTestScriptsValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`void`	`init()` Initialize all fields to their default values
`void`	`insertTestScripts(int index, java.lang.String value)` Insert the specified element at the specified index.
`void`	`log(int severity, java.lang.String msg)` Log the message with the specified severity.
`void`	`log(java.lang.String msg)` Shorthand for log(Logger.LOGLEVEL_INFO,msg)
`static java.lang.String`	`logLevelActual2Print(java.lang.String actualVal)` Utility method to transform an actual value for this field into a print value.
`int`	`logLevelLabelToValue(java.lang.String label)` Given a label, return the value for it.
`static java.lang.String`	`logLevelPrint2Actual(java.lang.String printVal)` Utility method to transform a print value for this field into an actual value.
`static java.lang.String`	`logLevelPrint2Key(java.lang.String printVal)` Utility method to transform a print value for this field into a key value.
`java.lang.String`	`logLevelValueToLabel(int val)` Given a value, return the declared label for it.
`protected void`	`notifyStateChange(int prevState, int currState)` Notify our registered control wrappers of our state change
`protected void`	`onFailure()` Override this method to do work when the node enters the failed state.
`protected SandMessage`	`onReceive(SandMessage msg)` Override this method in your node implementation
`protected void`	`onRestart()` Override this method to do work during `startup()`.
`protected void`	`onResume()` Override this method to do work during `resume()`.
`protected void`	`onShutdown()` Override this method to do work during `shutdown()`.
`protected void`	`onStartup()` Override this method to do work during `startup()`.
`protected void`	`onSuspend()` Override this method to do work during `suspend()`.
`SandMessage`	`receive(SandMessage msg)` Synchronous inbound SandMessage
`java.lang.String`	`removeTestScripts(int index)` Remove the element at the specified index and return it.
`boolean`	`removeTestScriptsValue(java.lang.String value)` Removes the given element from testScripts.
`void`	`restart()` Restarts a running node by calling shutdown and then startup
`void`	`resume()` Resumes a suspended node.
`static java.lang.String`	`sandNodeStateActual2Print(java.lang.String actualVal)` Utility method to transform an actual value for this field into a print value.
`int`	`sandNodeStateLabelToValue(java.lang.String label)` Given a label, return the value for it.
`static java.lang.String`	`sandNodeStatePrint2Actual(java.lang.String printVal)` Utility method to transform a print value for this field into an actual value.
`static java.lang.String`	`sandNodeStatePrint2Key(java.lang.String printVal)` Utility method to transform a print value for this field into a key value.
`java.lang.String`	`sandNodeStateValueToLabel(int val)` Given a value, return the declared label for it.
`void`	`send(SandMessage msg)` Asynchronous outbound SandMessage
`void`	`setBasePath(java.lang.Object basePath)` Generic mutator for basePath
`void`	`setBasePath(java.lang.String basePath)` Mutator for basePath
`void`	`setHelperNodes(Controllable[] nodes)` mutator for helperNodes
`void`	`setIncomingSyncSandMessage(IODeclReceive incomingSyncSandMessage)` Mutator for incomingSyncSandMessage
`void`	`setIncomingSyncSandMessage(java.lang.Object incomingSyncSandMessage)` Generic mutator for incomingSyncSandMessage
`void`	`setLogger(Logger logger)` Mutator for logger
`void`	`setLogger(java.lang.Object logger)` Generic mutator for logger
`void`	`setLogLevel(int logLevel)` Mutator for logLevel
`void`	`setMessager(Messager messager)` Mutator for messager
`void`	`setMessager(java.lang.Object messager)` Generic mutator for messager
`void`	`setNodeInstance(NodeInstance nodeInstance)` Mutator for nodeInstance
`void`	`setNodeInstance(java.lang.Object nodeInstance)` Generic mutator for nodeInstance
`void`	`setOutgoingAsyncSandMessage(IODeclSend outgoingAsyncSandMessage)` Mutator for outgoingAsyncSandMessage
`void`	`setOutgoingAsyncSandMessage(java.lang.Object outgoingAsyncSandMessage)` Generic mutator for outgoingAsyncSandMessage
`void`	`setParent(Controllable node)` mutator for parent
`void`	`setSandNodeErrorMessage(java.lang.Object sandNodeErrorMessage)` Generic mutator for sandNodeErrorMessage
`void`	`setSandNodeErrorMessage(java.lang.String sandNodeErrorMessage)` Mutator for sandNodeErrorMessage
`void`	`setSandNodeState(int sandNodeState)` Mutator for sandNodeState
`void`	`setSandRoot(SandRoot val)` mutator for sandRoot
`void`	`setTestScripts(int index, java.lang.String value)` Set the value at the index specified.
`void`	`setTestScripts(java.lang.String[] testScripts)` Mutator for testScripts
`protected void`	`setupSecureReceive()` Register us for receive with our local Authorizer
`protected void`	`setupSubscriptions()` Subscribe us to the nodes we need to listen to
`void`	`shutdown()` Stops a running node.
`int`	`sizeofTestScripts()` Returns the size of testScripts.
`void`	`startup()` Starts a stopped node.
`void`	`suspend()` Suspends a running node.
`void`	`systemwideShutdown(int code)` Call our shutdown, which shuts down our local nodes, then cascade this call upward to our parent so it spreads throughout the system as needed.
`boolean`	`testScriptsContains(java.lang.String val)` Returns true if testScripts contains the specified value.
`int`	`testScriptsIndexOf(java.lang.String val)` Return the index of the specified value in testScripts, or -1 if not found.
`boolean`	`validTransition(int transition)` Validates a state transition by comparing the desired transition with the current state.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

incomingSyncSandMessage

protected IODeclReceive incomingSyncSandMessage

Inbound org.sandev.basics.structs.SandMessage synchronous messaging configuration

outgoingAsyncSandMessage

protected IODeclSend outgoingAsyncSandMessage

Outbound org.sandev.basics.structs.SandMessage asynchronous messaging configuration

sandNodeState

protected int sandNodeState

Runtime state of the node. Must be one of the STATE constants defined in Controllable