org.sandev.TaskHeap.ExternalSync
Class ExternalSyncNodeBase

java.lang.Object
  extended byorg.sandev.TaskHeap.ExternalSync.ExternalSyncNodeDecl
      extended byorg.sandev.TaskHeap.ExternalSync.ExternalSyncNodeBase
All Implemented Interfaces:
org.sandev.basics.nodecommon.Controllable, org.sandev.basics.nodecommon.Loggable, org.sandev.basics.nodecommon.Messageable
Direct Known Subclasses:
ExternalSyncNode

public class ExternalSyncNodeBase
extends ExternalSyncNodeDecl
implements org.sandev.basics.nodecommon.Controllable, org.sandev.basics.nodecommon.Messageable, org.sandev.basics.nodecommon.Loggable

AUTOGENERATED FILE, DO NOT EDIT DIRECTLY.
source: org.sandev.TaskHeap.ExternalSync.ExternalSyncNodeDecl
generator: org.sandev.generator.NodeClassGenerator
time: Dec 2, 2005 6:38:51 PM

This file contains:


Field Summary
protected  org.sandev.basics.nodecommon.ControlWrapper[] ctrlwrappers
          The control wrappers we need to notify of state or parameter changes.
protected  org.sandev.basics.nodecommon.Controllable[] helperNodes
          Our helper nodes
protected  org.sandev.basics.sandmessages.IODeclReceive incomingSyncExternalPlanSync
          Inbound org.sandev.TaskHeap.sandmessages.ExternalPlanSync synchronous messaging configuration
protected  org.sandev.basics.sandmessages.IODeclReceive incomingSyncPing
          Inbound org.sandev.basics.sandmessages.Ping 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  org.sandev.basics.nodecommon.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  org.sandev.basics.nodecommon.Messager messager
          Communications to and from this node.
protected  org.sandev.basics.structs.NodeInstance nodeInstance
          The declaration used to initialize this node instance when it was first created.
protected  org.sandev.basics.nodecommon.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  org.sandev.basics.nodecommon.SandRoot sandRoot
          Back reference to the SandRoot that launched us.
 
Fields inherited from class org.sandev.TaskHeap.ExternalSync.ExternalSyncNodeDecl
externalPlanFailure, externalPlanSuccess, httpAgentID
 
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
ExternalSyncNodeBase()
          Default constructor calls init.
 
Method Summary
 void addWrapper(org.sandev.basics.nodecommon.ControlWrapper wrapper)
          Add the specified wrapper to our notification collection
 void deliver(org.sandev.basics.structs.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 getExternalPlanFailure()
          Accessor for externalPlanFailure
static java.lang.String getExternalPlanFailureDefaultValue()
          Default value for externalPlanFailure.
 java.lang.String getExternalPlanFailureFieldPrintValue()
          Return the print name of the externalPlanFailure field.
static boolean getExternalPlanFailureFlag(int fieldflag)
          Field flag accessor.
static java.lang.String getExternalPlanFailureInvalidValue()
          Invalid value for externalPlanFailure.
static int getExternalPlanFailureLengthMax()
          Maximum externalPlanFailure length is 255 characters
static int getExternalPlanFailureLengthNorm()
          Normal externalPlanFailure length is 60 characters
 java.lang.String getExternalPlanFailureMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getExternalPlanFailurePrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getExternalPlanFailureRange()
          Return the range specification for this field
 java.lang.String getExternalPlanFailureValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 java.lang.String getExternalPlanSuccess()
          Accessor for externalPlanSuccess
static java.lang.String getExternalPlanSuccessDefaultValue()
          Default value for externalPlanSuccess.
 java.lang.String getExternalPlanSuccessFieldPrintValue()
          Return the print name of the externalPlanSuccess field.
static boolean getExternalPlanSuccessFlag(int fieldflag)
          Field flag accessor.
static java.lang.String getExternalPlanSuccessInvalidValue()
          Invalid value for externalPlanSuccess.
static int getExternalPlanSuccessLengthMax()
          Maximum externalPlanSuccess length is 255 characters
static int getExternalPlanSuccessLengthNorm()
          Normal externalPlanSuccess length is 60 characters
 java.lang.String getExternalPlanSuccessMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getExternalPlanSuccessPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getExternalPlanSuccessRange()
          Return the range specification for this field
 java.lang.String getExternalPlanSuccessValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 org.sandev.basics.nodecommon.Controllable[] getHelperNodes()
          accessor for helperNodes
 java.lang.String getHttpAgentID()
          Accessor for httpAgentID
static java.lang.String getHttpAgentIDDefaultValue()
          Default value for httpAgentID.
 java.lang.String getHttpAgentIDFieldPrintValue()
          Return the print name of the httpAgentID field.
static boolean getHttpAgentIDFlag(int fieldflag)
          Field flag accessor.
static java.lang.String getHttpAgentIDInvalidValue()
          Invalid value for httpAgentID.
static int getHttpAgentIDLengthMax()
          Maximum httpAgentID length is 80 characters
static int getHttpAgentIDLengthNorm()
          Normal httpAgentID length is 30 characters
 java.lang.String getHttpAgentIDMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getHttpAgentIDPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getHttpAgentIDRange()
          Return the range specification for this field
 java.lang.String getHttpAgentIDValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 org.sandev.basics.util.IDCache getIDCache()
          Stub for retrieving the IDCache used by this node.
 org.sandev.basics.sandmessages.IODeclReceive getIncomingSyncExternalPlanSync()
          Accessor for incomingSyncExternalPlanSync
static org.sandev.basics.sandmessages.IODeclReceive getIncomingSyncExternalPlanSyncDefaultValue()
          Default value for incomingSyncExternalPlanSync.
 java.lang.String getIncomingSyncExternalPlanSyncFieldPrintValue()
          Return the print name of the incomingSyncExternalPlanSync field.
static boolean getIncomingSyncExternalPlanSyncFlag(int fieldflag)
          Field flag accessor.
static org.sandev.basics.sandmessages.IODeclReceive getIncomingSyncExternalPlanSyncInvalidValue()
          Invalid value for incomingSyncExternalPlanSync.
 java.lang.String getIncomingSyncExternalPlanSyncMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getIncomingSyncExternalPlanSyncPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getIncomingSyncExternalPlanSyncRange()
          Return the range specification for this field
 java.lang.String getIncomingSyncExternalPlanSyncValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 org.sandev.basics.sandmessages.IODeclReceive getIncomingSyncPing()
          Accessor for incomingSyncPing
static org.sandev.basics.sandmessages.IODeclReceive getIncomingSyncPingDefaultValue()
          Default value for incomingSyncPing.
 java.lang.String getIncomingSyncPingFieldPrintValue()
          Return the print name of the incomingSyncPing field.
static boolean getIncomingSyncPingFlag(int fieldflag)
          Field flag accessor.
static org.sandev.basics.sandmessages.IODeclReceive getIncomingSyncPingInvalidValue()
          Invalid value for incomingSyncPing.
 java.lang.String getIncomingSyncPingMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getIncomingSyncPingPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getIncomingSyncPingRange()
          Return the range specification for this field
 java.lang.String getIncomingSyncPingValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 org.sandev.basics.nodecommon.Logger getLogger()
          Accessor for logger
static org.sandev.basics.nodecommon.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 org.sandev.basics.nodecommon.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.
 org.sandev.basics.nodecommon.Messager getMessager()
          Accessor for messager
static org.sandev.basics.nodecommon.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 org.sandev.basics.nodecommon.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.
 org.sandev.basics.structs.NodeInstance getNodeInstance()
          Accessor for nodeInstance
static org.sandev.basics.structs.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 org.sandev.basics.structs.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.
 org.sandev.basics.nodecommon.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.
 org.sandev.basics.nodecommon.SandRoot getSandRoot()
          accessor for sandRoot
 java.lang.String getServername()
          convenience wrapper method to retrieve our home server name
 void init()
          Initialize all fields to their default values
 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  ExternalPlanSync onReceive(ExternalPlanSync msg)
          Override this method in your node implementation
protected  org.sandev.basics.sandmessages.Ping onReceive(org.sandev.basics.sandmessages.Ping 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().
 ExternalPlanSync receive(ExternalPlanSync msg)
          Synchronous inbound ExternalPlanSync
 org.sandev.basics.sandmessages.Ping receive(org.sandev.basics.sandmessages.Ping msg)
          Synchronous inbound Ping
 org.sandev.basics.structs.SandMessage receive(org.sandev.basics.structs.SandMessage msg)
          Only those receive methods explicitely declared by the node should actually be called.
 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 setExternalPlanFailure(java.lang.Object externalPlanFailure)
          Generic mutator for externalPlanFailure
 void setExternalPlanFailure(java.lang.String externalPlanFailure)
          Mutator for externalPlanFailure
 void setExternalPlanSuccess(java.lang.Object externalPlanSuccess)
          Generic mutator for externalPlanSuccess
 void setExternalPlanSuccess(java.lang.String externalPlanSuccess)
          Mutator for externalPlanSuccess
 void setHelperNodes(org.sandev.basics.nodecommon.Controllable[] nodes)
          mutator for helperNodes
 void setHttpAgentID(java.lang.Object httpAgentID)
          Generic mutator for httpAgentID
 void setHttpAgentID(java.lang.String httpAgentID)
          Mutator for httpAgentID
 void setIncomingSyncExternalPlanSync(org.sandev.basics.sandmessages.IODeclReceive incomingSyncExternalPlanSync)
          Mutator for incomingSyncExternalPlanSync
 void setIncomingSyncExternalPlanSync(java.lang.Object incomingSyncExternalPlanSync)
          Generic mutator for incomingSyncExternalPlanSync
 void setIncomingSyncPing(org.sandev.basics.sandmessages.IODeclReceive incomingSyncPing)
          Mutator for incomingSyncPing
 void setIncomingSyncPing(java.lang.Object incomingSyncPing)
          Generic mutator for incomingSyncPing
 void setLogger(org.sandev.basics.nodecommon.Logger logger)
          Mutator for logger
 void setLogger(java.lang.Object logger)
          Generic mutator for logger
 void setLogLevel(int logLevel)
          Mutator for logLevel
 void setMessager(org.sandev.basics.nodecommon.Messager messager)
          Mutator for messager
 void setMessager(java.lang.Object messager)
          Generic mutator for messager
 void setNodeInstance(org.sandev.basics.structs.NodeInstance nodeInstance)
          Mutator for nodeInstance
 void setNodeInstance(java.lang.Object nodeInstance)
          Generic mutator for nodeInstance
 void setParent(org.sandev.basics.nodecommon.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(org.sandev.basics.nodecommon.SandRoot val)
          mutator for sandRoot
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.
 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 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

incomingSyncPing

protected org.sandev.basics.sandmessages.IODeclReceive incomingSyncPing
Inbound org.sandev.basics.sandmessages.Ping synchronous messaging configuration


incomingSyncExternalPlanSync

protected org.sandev.basics.sandmessages.IODeclReceive incomingSyncExternalPlanSync
Inbound org.sandev.TaskHeap.sandmessages.ExternalPlanSync synchronous messaging configuration


sandNodeState

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


SANDNODESTATE_UNDEFINED

public static final int SANDNODESTATE_UNDEFINED
Possible value for sandNodeState

See Also:
Constant Field Values

SANDNODESTATE_RUNNING

public static final int SANDNODESTATE_RUNNING
Possible value for sandNodeState

See Also:
Constant Field Values

SANDNODESTATE_SUSPENDED

public static final int SANDNODESTATE_SUSPENDED
Possible value for sandNodeState

See Also:
Constant Field Values

SANDNODESTATE_STOPPED

public static final int SANDNODESTATE_STOPPED
Possible value for sandNodeState

See Also:
Constant Field Values

SANDNODESTATE_FAILED

public static final int SANDNODESTATE_FAILED
Possible value for sandNodeState

See Also:
Constant Field Values

SANDNODESTATE_STARTING

public static final int SANDNODESTATE_STARTING
Possible value for sandNodeState

See Also:
Constant Field Values

SANDNODESTATE_STOPPING

public static final int SANDNODESTATE_STOPPING
Possible value for sandNodeState

See Also:
Constant Field Values

SANDNODESTATE_SUSPENDING

public static final int SANDNODESTATE_SUSPENDING
Possible value for sandNodeState

See Also:
Constant Field Values

SANDNODESTATE_RESUMING

public static final int SANDNODESTATE_RESUMING
Possible value for sandNodeState

See Also:
Constant Field Values

SANDNODESTATE_FAILING

public static final int SANDNODESTATE_FAILING
Possible value for sandNodeState

See Also:
Constant Field Values

sandNodeErrorMessage

protected java.lang.String sandNodeErrorMessage
Text details of the node execution error.


messager

protected org.sandev.basics.nodecommon.Messager messager
Communications to and from this node.


logger

protected org.sandev.basics.nodecommon.Logger logger
Logfile output at specified severity levels.


logLevel

protected int logLevel
Calls to log with severity levels less than this value will be ignored. For example, if you set this field to LOGLEVEL_WARN, then a call to log with LOGLEVEL_INFO will be ignored, while any call with LOGLEVEL_WARN/ERROR/FATAL will be processed. The log levels are defined in org.sandev.basics.nodecommon.Logger


LOGLEVEL_DEBUG

public static final int LOGLEVEL_DEBUG
Possible value for logLevel

See Also:
Constant Field Values

LOGLEVEL_INFO

public static final int LOGLEVEL_INFO
Possible value for logLevel

See Also:
Constant Field Values

LOGLEVEL_WARN

public static final int LOGLEVEL_WARN
Possible value for logLevel

See Also:
Constant Field Values

LOGLEVEL_ERROR

public static final int LOGLEVEL_ERROR
Possible value for logLevel

See Also:
Constant Field Values

LOGLEVEL_FATAL

public static final int LOGLEVEL_FATAL
Possible value for logLevel

See Also:
Constant Field Values

nodeInstance

protected org.sandev.basics.structs.NodeInstance nodeInstance
The declaration used to initialize this node instance when it was first created. This information is for reference only, it can only be modified within the configuration.


sandRoot

protected org.sandev.basics.nodecommon.SandRoot sandRoot
Back reference to the SandRoot that launched us.


LOGDEBUG

protected static final int LOGDEBUG
Convenience redeclaration of corresponding Logger.LOGLEVEL constant

See Also:
Constant Field Values

LOGINFO

protected static final int LOGINFO
Convenience redeclaration of corresponding Logger.LOGLEVEL constant

See Also:
Constant Field Values

LOGWARN

protected static final int LOGWARN
Convenience redeclaration of corresponding Logger.LOGLEVEL constant

See Also:
Constant Field Values

LOGERROR

protected static final int LOGERROR
Convenience redeclaration of corresponding Logger.LOGLEVEL constant

See Also:
Constant Field Values

LOGFATAL

protected static final int LOGFATAL
Convenience redeclaration of corresponding Logger.LOGLEVEL constant

See Also:
Constant Field Values

parent

protected org.sandev.basics.nodecommon.Controllable parent
Our parent node


helperNodes

protected org.sandev.basics.nodecommon.Controllable[] helperNodes
Our helper nodes


ctrlwrappers

protected org.sandev.basics.nodecommon.ControlWrapper[] ctrlwrappers
The control wrappers we need to notify of state or parameter changes.

Constructor Detail

ExternalSyncNodeBase

public ExternalSyncNodeBase()
Default constructor calls init.

Method Detail

fieldHasFlag

public boolean fieldHasFlag(java.lang.String fieldname,
                            int fieldflag)
Return true if the named field declares the indicated flag, false otherwise. See the FIELDFLAG* constants in SandInstanceMessage for supported fieldflag values.


getExternalPlanSuccess

public java.lang.String getExternalPlanSuccess()
Accessor for externalPlanSuccess


setExternalPlanSuccess

public void setExternalPlanSuccess(java.lang.String externalPlanSuccess)
Mutator for externalPlanSuccess


setExternalPlanSuccess

public void setExternalPlanSuccess(java.lang.Object externalPlanSuccess)
Generic mutator for externalPlanSuccess


getExternalPlanSuccessFlag

public static boolean getExternalPlanSuccessFlag(int fieldflag)
Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.


getExternalPlanSuccessLengthNorm

public static int getExternalPlanSuccessLengthNorm()
Normal externalPlanSuccess length is 60 characters


getExternalPlanSuccessLengthMax

public static int getExternalPlanSuccessLengthMax()
Maximum externalPlanSuccess length is 255 characters


getExternalPlanSuccessDefaultValue

public static java.lang.String getExternalPlanSuccessDefaultValue()
Default value for externalPlanSuccess. Returns "Information retrieved successfully."


getExternalPlanSuccessInvalidValue

public static java.lang.String getExternalPlanSuccessInvalidValue()
Invalid value for externalPlanSuccess. Returns null


getExternalPlanSuccessPrintValue

public java.lang.String getExternalPlanSuccessPrintValue()
Retrieve the current value of this field as a print String. For a String field, this returns the current value. For int, long, double this returns the standard string conversion. For a Date, this returns the default DateFormat format. For an enum, this returns the Actual2Print translation of the current value. For a struct this returns a summary description.

Used for debug output, and as an initial value for transformation and formatting.


getExternalPlanSuccessFieldPrintValue

public java.lang.String getExternalPlanSuccessFieldPrintValue()
Return the print name of the externalPlanSuccess field. If no printname is declared then this returns the field name.


getExternalPlanSuccessRange

public java.lang.String getExternalPlanSuccessRange()
Return the range specification for this field


getExternalPlanSuccessValidityCheck

public java.lang.String getExternalPlanSuccessValidityCheck()
Return the empty string if the value of this field is valid according to the base SAND declarations. This method supports the fieldValidate method, which is in turn specified by the org.sandev.basics.structs.SandInstanceMessage interface. See the comments there for more information, including a list of error Strings returned from here when a field is not valid.


getExternalPlanSuccessMetatype

public java.lang.String getExternalPlanSuccessMetatype()
Return the metatype text for this field, or "" if no metatype was declared.


getExternalPlanFailure

public java.lang.String getExternalPlanFailure()
Accessor for externalPlanFailure


setExternalPlanFailure

public void setExternalPlanFailure(java.lang.String externalPlanFailure)
Mutator for externalPlanFailure


setExternalPlanFailure

public void setExternalPlanFailure(java.lang.Object externalPlanFailure)
Generic mutator for externalPlanFailure


getExternalPlanFailureFlag

public static boolean getExternalPlanFailureFlag(int fieldflag)
Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.


getExternalPlanFailureLengthNorm

public static int getExternalPlanFailureLengthNorm()
Normal externalPlanFailure length is 60 characters


getExternalPlanFailureLengthMax

public static int getExternalPlanFailureLengthMax()
Maximum externalPlanFailure length is 255 characters


getExternalPlanFailureDefaultValue

public static java.lang.String getExternalPlanFailureDefaultValue()
Default value for externalPlanFailure. Returns "Information retrieval failed: $ERROR"


getExternalPlanFailureInvalidValue

public static java.lang.String getExternalPlanFailureInvalidValue()
Invalid value for externalPlanFailure. Returns null


getExternalPlanFailurePrintValue

public java.lang.String getExternalPlanFailurePrintValue()
Retrieve the current value of this field as a print String. For a String field, this returns the current value. For int, long, double this returns the standard string conversion. For a Date, this returns the default DateFormat format. For an enum, this returns the Actual2Print translation of the current value. For a struct this returns a summary description.

Used for debug output, and as an initial value for transformation and formatting.


getExternalPlanFailureFieldPrintValue

public java.lang.String getExternalPlanFailureFieldPrintValue()
Return the print name of the externalPlanFailure field. If no printname is declared then this returns the field name.


getExternalPlanFailureRange

public java.lang.String getExternalPlanFailureRange()
Return the range specification for this field


getExternalPlanFailureValidityCheck

public java.lang.String getExternalPlanFailureValidityCheck()
Return the empty string if the value of this field is valid according to the base SAND declarations. This method supports the fieldValidate method, which is in turn specified by the org.sandev.basics.structs.SandInstanceMessage interface. See the comments there for more information, including a list of error Strings returned from here when a field is not valid.


getExternalPlanFailureMetatype

public java.lang.String getExternalPlanFailureMetatype()
Return the metatype text for this field, or "" if no metatype was declared.


getHttpAgentID

public java.lang.String getHttpAgentID()
Accessor for httpAgentID


setHttpAgentID

public void setHttpAgentID(java.lang.String httpAgentID)
Mutator for httpAgentID


setHttpAgentID

public void setHttpAgentID(java.lang.Object httpAgentID)
Generic mutator for httpAgentID


getHttpAgentIDFlag

public static boolean getHttpAgentIDFlag