CacheManagerNodeBase

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.CacheManager
Class CacheManagerNodeBase

java.lang.Object
  org.sandev.basics.CacheManager.CacheManagerNodeDecl
      org.sandev.basics.CacheManager.CacheManagerNodeBase

All Implemented Interfaces:: Controllable, Loggable, Messageable

Direct Known Subclasses:: CacheManagerNode

public class CacheManagerNodeBase
extends CacheManagerNodeDecl
implements Controllable, Messageable, Loggable
extends CacheManagerNodeDecl
implements Controllable, Messageable, Loggable

AUTOGENERATED FILE, DO NOT EDIT DIRECTLY.
source: org.sandev.basics.CacheManager.CacheManagerNodeDecl
generator: org.sandev.generator.NodeClassGenerator
time: Jul 31, 2008 4:34:14 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 IODeclSubscribe`	`incomingAsyncCacheActionMessage` Inbound org.sandev.basics.sandmessages.CacheAction asynchronous messaging configuration
`protected IODeclSubscribe`	`incomingAsyncSandUpdateMessage` Inbound org.sandev.basics.structs.SandUpdateMessage asynchronous messaging configuration
`protected IODeclReceive`	`incomingSyncCacheAction` Inbound org.sandev.basics.sandmessages.CacheAction 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`	`outgoingAsyncCacheAction` Outbound org.sandev.basics.sandmessages.CacheAction 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.CacheManager.CacheManagerNodeDecl
`localAuthUserLookup, notificationPassword, notificationUsername`

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

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
`CacheManagerNodeBase()` Default constructor calls init.

Method Summary
`void`	`addWrapper(ControlWrapper wrapper)` Add the specified wrapper to our notification collection
`SandCollectionMessage`	`callQuery(SandQueryMessage sqm)` Generalized query method to handle all queries understood by this node
`void`	`deliver(SandMessage msg)` Only those deliver methods explicitely declared by the node should actually be called.
`void`	`deliverCacheActionMessage(CacheAction msg)` Asynchronous inbound CacheAction
`void`	`deliverSandUpdateMessage(SandUpdateMessage msg)` Asynchronous inbound SandUpdateMessage
`boolean`	`fieldHasFlag(java.lang.String fieldname, int fieldflag)` Return true if the named field declares the indicated flag, false otherwise.
`java.lang.String`	`getDeploymentPrefix()` Return the prefix for this deployment.
`Controllable[]`	`getHelperNodes()` accessor for helperNodes
`IDCache`	`getIDCache()` Retrieve an IDCache for use by this node.
`IODeclSubscribe`	`getIncomingAsyncCacheActionMessage()` Accessor for incomingAsyncCacheActionMessage
`static IODeclSubscribe`	`getIncomingAsyncCacheActionMessageDefaultValue()` Default value for incomingAsyncCacheActionMessage.
`java.lang.String`	`getIncomingAsyncCacheActionMessageFieldPrintValue()` Return the print name of the incomingAsyncCacheActionMessage field.
`static boolean`	`getIncomingAsyncCacheActionMessageFlag(int fieldflag)` Field flag accessor.
`static IODeclSubscribe`	`getIncomingAsyncCacheActionMessageInvalidValue()` Invalid value for incomingAsyncCacheActionMessage.
`java.lang.String`	`getIncomingAsyncCacheActionMessageMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getIncomingAsyncCacheActionMessagePrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getIncomingAsyncCacheActionMessageRange()` Return the range specification for this field
`java.lang.String`	`getIncomingAsyncCacheActionMessageValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`IODeclSubscribe`	`getIncomingAsyncSandUpdateMessage()` Accessor for incomingAsyncSandUpdateMessage
`static IODeclSubscribe`	`getIncomingAsyncSandUpdateMessageDefaultValue()` Default value for incomingAsyncSandUpdateMessage.
`java.lang.String`	`getIncomingAsyncSandUpdateMessageFieldPrintValue()` Return the print name of the incomingAsyncSandUpdateMessage field.
`static boolean`	`getIncomingAsyncSandUpdateMessageFlag(int fieldflag)` Field flag accessor.
`static IODeclSubscribe`	`getIncomingAsyncSandUpdateMessageInvalidValue()` Invalid value for incomingAsyncSandUpdateMessage.
`java.lang.String`	`getIncomingAsyncSandUpdateMessageMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getIncomingAsyncSandUpdateMessagePrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getIncomingAsyncSandUpdateMessageRange()` Return the range specification for this field
`java.lang.String`	`getIncomingAsyncSandUpdateMessageValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`IODeclReceive`	`getIncomingSyncCacheAction()` Accessor for incomingSyncCacheAction
`static IODeclReceive`	`getIncomingSyncCacheActionDefaultValue()` Default value for incomingSyncCacheAction.
`java.lang.String`	`getIncomingSyncCacheActionFieldPrintValue()` Return the print name of the incomingSyncCacheAction field.
`static boolean`	`getIncomingSyncCacheActionFlag(int fieldflag)` Field flag accessor.
`static IODeclReceive`	`getIncomingSyncCacheActionInvalidValue()` Invalid value for incomingSyncCacheAction.
`java.lang.String`	`getIncomingSyncCacheActionMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getIncomingSyncCacheActionPrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getIncomingSyncCacheActionRange()` Return the range specification for this field
`java.lang.String`	`getIncomingSyncCacheActionValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`java.lang.String`	`getLocalAuthUserLookup()` Accessor for localAuthUserLookup
`static java.lang.String`	`getLocalAuthUserLookupDefaultValue()` Default value for localAuthUserLookup.
`java.lang.String`	`getLocalAuthUserLookupFieldPrintValue()` Return the print name of the localAuthUserLookup field.
`static boolean`	`getLocalAuthUserLookupFlag(int fieldflag)` Field flag accessor.
`static java.lang.String`	`getLocalAuthUserLookupInvalidValue()` Invalid value for localAuthUserLookup.
`static int`	`getLocalAuthUserLookupLengthMax()` Maximum localAuthUserLookup length is 70 characters
`static int`	`getLocalAuthUserLookupLengthNorm()` Normal localAuthUserLookup length is 30 characters
`java.lang.String`	`getLocalAuthUserLookupMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getLocalAuthUserLookupPrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getLocalAuthUserLookupRange()` Return the range specification for this field
`java.lang.String`	`getLocalAuthUserLookupValidityCheck()` 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.
`java.lang.String`	`getNotificationPassword()` Accessor for notificationPassword
`static java.lang.String`	`getNotificationPasswordDefaultValue()` Default value for notificationPassword.
`java.lang.String`	`getNotificationPasswordFieldPrintValue()` Return the print name of the notificationPassword field.
`static boolean`	`getNotificationPasswordFlag(int fieldflag)` Field flag accessor.
`static java.lang.String`	`getNotificationPasswordInvalidValue()` Invalid value for notificationPassword.
`static int`	`getNotificationPasswordLengthMax()` Maximum notificationPassword length is 80 characters
`static int`	`getNotificationPasswordLengthNorm()` Normal notificationPassword length is 15 characters
`java.lang.String`	`getNotificationPasswordMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getNotificationPasswordPrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getNotificationPasswordRange()` Return the range specification for this field
`java.lang.String`	`getNotificationPasswordValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`java.lang.String`	`getNotificationUsername()` Accessor for notificationUsername
`static java.lang.String`	`getNotificationUsernameDefaultValue()` Default value for notificationUsername.
`java.lang.String`	`getNotificationUsernameFieldPrintValue()` Return the print name of the notificationUsername field.
`static boolean`	`getNotificationUsernameFlag(int fieldflag)` Field flag accessor.
`static java.lang.String`	`getNotificationUsernameInvalidValue()` Invalid value for notificationUsername.
`static int`	`getNotificationUsernameLengthMax()` Maximum notificationUsername length is 80 characters
`static int`	`getNotificationUsernameLengthNorm()` Normal notificationUsername length is 15 characters
`java.lang.String`	`getNotificationUsernameMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getNotificationUsernamePrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getNotificationUsernameRange()` Return the range specification for this field
`java.lang.String`	`getNotificationUsernameValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`IODeclSend`	`getOutgoingAsyncCacheAction()` Accessor for outgoingAsyncCacheAction
`static IODeclSend`	`getOutgoingAsyncCacheActionDefaultValue()` Default value for outgoingAsyncCacheAction.
`java.lang.String`	`getOutgoingAsyncCacheActionFieldPrintValue()` Return the print name of the outgoingAsyncCacheAction field.
`static boolean`	`getOutgoingAsyncCacheActionFlag(int fieldflag)` Field flag accessor.
`static IODeclSend`	`getOutgoingAsyncCacheActionInvalidValue()` Invalid value for outgoingAsyncCacheAction.
`java.lang.String`	`getOutgoingAsyncCacheActionMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getOutgoingAsyncCacheActionPrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getOutgoingAsyncCacheActionRange()` Return the range specification for this field
`java.lang.String`	`getOutgoingAsyncCacheActionValidityCheck()` 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
`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 int`	`logLevelLabelToValueStatic(java.lang.String label)`
`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.
`static java.lang.String`	`logLevelValueToLabelStatic(int val)`
`protected void`	`notifyStateChange(int prevState, int currState)` Notify our registered control wrappers of our state change
`protected void`	`onDelivery(CacheAction msg)` Override this method in your node implementation
`protected void`	`onDelivery(SandUpdateMessage msg)` Override this method in your node implementation
`protected void`	`onFailure()` Override this method to do work when the node enters the failed state.
`protected CacheAction`	`onReceive(CacheAction 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()`.
`void`	`readConfigParamsFromNodeInstance(NodeInstance ni)` Read our configuration parameter values from the our node instance.
`CacheAction`	`receive(CacheAction msg)` Synchronous inbound CacheAction
`SandMessage`	`receive(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 int`	`sandNodeStateLabelToValueStatic(java.lang.String label)`
`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.
`static java.lang.String`	`sandNodeStateValueToLabelStatic(int val)`
`void`	`send(CacheAction msg)` Asynchronous outbound CacheAction
`void`	`setHelperNodes(Controllable[] nodes)` mutator for helperNodes
`void`	`setIncomingAsyncCacheActionMessage(IODeclSubscribe incomingAsyncCacheActionMessage)` Mutator for incomingAsyncCacheActionMessage
`void`	`setIncomingAsyncCacheActionMessage(java.lang.Object incomingAsyncCacheActionMessage)` Generic mutator for incomingAsyncCacheActionMessage
`void`	`setIncomingAsyncSandUpdateMessage(IODeclSubscribe incomingAsyncSandUpdateMessage)` Mutator for incomingAsyncSandUpdateMessage
`void`	`setIncomingAsyncSandUpdateMessage(java.lang.Object incomingAsyncSandUpdateMessage)` Generic mutator for incomingAsyncSandUpdateMessage
`void`	`setIncomingSyncCacheAction(IODeclReceive incomingSyncCacheAction)` Mutator for incomingSyncCacheAction
`void`	`setIncomingSyncCacheAction(java.lang.Object incomingSyncCacheAction)` Generic mutator for incomingSyncCacheAction
`void`	`setLocalAuthUserLookup(java.lang.Object localAuthUserLookup)` Generic mutator for localAuthUserLookup
`void`	`setLocalAuthUserLookup(java.lang.String localAuthUserLookup)` Mutator for localAuthUserLookup
`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`	`setNotificationPassword(java.lang.Object notificationPassword)` Generic mutator for notificationPassword
`void`	`setNotificationPassword(java.lang.String notificationPassword)` Mutator for notificationPassword
`void`	`setNotificationUsername(java.lang.Object notificationUsername)` Generic mutator for notificationUsername
`void`	`setNotificationUsername(java.lang.String notificationUsername)` Mutator for notificationUsername
`void`	`setOutgoingAsyncCacheAction(IODeclSend outgoingAsyncCacheAction)` Mutator for outgoingAsyncCacheAction
`void`	`setOutgoingAsyncCacheAction(java.lang.Object outgoingAsyncCacheAction)` Generic mutator for outgoingAsyncCacheAction
`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
`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

incomingSyncCacheAction

protected IODeclReceive incomingSyncCacheAction

Inbound org.sandev.basics.sandmessages.CacheAction synchronous messaging configuration

outgoingAsyncCacheAction

protected IODeclSend outgoingAsyncCacheAction

Outbound org.sandev.basics.sandmessages.CacheAction asynchronous messaging configuration

incomingAsyncSandUpdateMessage

protected IODeclSubscribe incomingAsyncSandUpdateMessage

Inbound org.sandev.basics.structs.SandUpdateMessage asynchronous messaging configuration

incomingAsyncCacheActionMessage

protected IODeclSubscribe incomingAsyncCacheActionMessage

Inbound org.sandev.basics.sandmessages.CacheAction asynchronous 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 Messager messager

Communications to and from this node.

logger

protected 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 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 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 Controllable parent

Our parent node

helperNodes

protected Controllable[] helperNodes

Our helper nodes

ctrlwrappers

protected ControlWrapper[] ctrlwrappers

The control wrappers we need to notify of state or parameter changes.

Constructor Detail

CacheManagerNodeBase

public CacheManagerNodeBase()

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.

getLocalAuthUserLookup

public java.lang.String getLocalAuthUserLookup()

Accessor for localAuthUserLookup

setLocalAuthUserLookup

public void setLocalAuthUserLookup(java.lang.String localAuthUserLookup)

Mutator for localAuthUserLookup

setLocalAuthUserLookup

public void setLocalAuthUserLookup(java.lang.Object localAuthUserLookup)

Generic mutator for localAuthUserLookup

getLocalAuthUserLookupFlag

public static boolean getLocalAuthUserLookupFlag(int fieldflag)

Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.

getLocalAuthUserLookupLengthNorm

public static int getLocalAuthUserLookupLengthNorm()

Normal localAuthUserLookup length is 30 characters

getLocalAuthUserLookupLengthMax

public static int getLocalAuthUserLookupLengthMax()

Maximum localAuthUserLookup length is 70 characters

getLocalAuthUserLookupDefaultValue

public static java.lang.String getLocalAuthUserLookupDefaultValue()

Default value for localAuthUserLookup. Returns ""

getLocalAuthUserLookupInvalidValue

public static java.lang.String getLocalAuthUserLookupInvalidValue()

Invalid value for localAuthUserLookup. Returns null

getLocalAuthUserLookupPrintValue

public java.lang.String getLocalAuthUserLookupPrintValue()

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.

getLocalAuthUserLookupFieldPrintValue

public java.lang.String getLocalAuthUserLookupFieldPrintValue()

Return the print name of the localAuthUserLookup field. If no printname is declared then this returns the field name.

getLocalAuthUserLookupRange

public java.lang.String getLocalAuthUserLookupRange()

Return the range specification for this field

getLocalAuthUserLookupValidityCheck

public java.lang.String getLocalAuthUserLookupValidityCheck()

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.

getLocalAuthUserLookupMetatype

public java.lang.String getLocalAuthUserLookupMetatype()

Return the metatype text for this field, or "" if no metatype was declared.

getNotificationUsername

public java.lang.String getNotificationUsername()

Accessor for notificationUsername

setNotificationUsername

public void setNotificationUsername(java.lang.String notificationUsername)

Mutator for notificationUsername

setNotificationUsername

public void setNotificationUsername(java.lang.Object notificationUsername)

Generic mutator for notificationUsername

getNotificationUsernameFlag

public static boolean getNotificationUsernameFlag(int fieldflag)

Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.

getNotificationUsernameLengthNorm

public static int getNotificationUsernameLengthNorm()

Normal notificationUsername length is 15 characters

getNotificationUsernameLengthMax

public static int getNotificationUsernameLengthMax()

Maximum notificationUsername length is 80 characters

getNotificationUsernameDefaultValue

public static java.lang.String getNotificationUsernameDefaultValue()

Default value for notificationUsername. Returns ""

getNotificationUsernameInvalidValue

public static java.lang.String getNotificationUsernameInvalidValue()

Invalid value for notificationUsername. Returns null

getNotificationUsernamePrintValue

public java.lang.String getNotificationUsernamePrintValue()

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

getNotificationUsernameFieldPrintValue

public java.lang.String getNotificationUsernameFieldPrintValue()

Return the print name of the notificationUsername field. If no printname is declared then this returns the field name.

getNotificationUsernameRange

public java.lang.String getNotificationUsernameRange()

Return the range specification for this field

getNotificationUsernameValidityCheck

public java.lang.String getNotificationUsernameValidityCheck()

getNotificationUsernameMetatype

public java.lang.String getNotificationUsernameMetatype()

Return the metatype text for this field, or "" if no metatype was declared.

getNotificationPassword

public java.lang.String getNotificationPassword()

Accessor for notificationPassword

setNotificationPassword

public void setNotificationPassword(java.lang.String notificationPassword)

Mutator for notificationPassword

setNotificationPassword

public void setNotificationPassword(java.lang.Object notificationPassword)

Generic mutator for notificationPassword

getNotificationPasswordFlag

public static boolean getNotificationPasswordFlag(int fieldflag)

Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.

getNotificationPasswordLengthNorm

public static int getNotificationPasswordLengthNorm()

Normal notificationPassword length is 15 characters

getNotificationPasswordLengthMax

public static int getNotificationPasswordLengthMax()

Maximum notificationPassword length is 80 characters

getNotificationPasswordDefaultValue

public static java.lang.String getNotificationPasswordDefaultValue()

Default value for notificationPassword. Returns ""

getNotificationPasswordInvalidValue

public static java.lang.String getNotificationPasswordInvalidValue()

Invalid value for notificationPassword. Returns null

getNotificationPasswordPrintValue

public java.lang.String getNotificationPasswordPrintValue()

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

getNotificationPasswordFieldPrintValue

public java.lang.String getNotificationPasswordFieldPrintValue()

Return the print name of the notificationPassword field. If no printname is declared then this returns the field name.

getNotificationPasswordRange

public java.lang.String getNotificationPasswordRange()

Return the range specification for this field

getNotificationPasswordValidityCheck

public java.lang.String getNotificationPasswordValidityCheck()

getNotificationPasswordMetatype

public java.lang.String getNotificationPasswordMetatype()

Return the metatype text for this field, or "" if no metatype was declared.

getIncomingSyncCacheAction

public IODeclReceive getIncomingSyncCacheAction()

Accessor for incomingSyncCacheAction

setIncomingSyncCacheAction

public void setIncomingSyncCacheAction(IODeclReceive incomingSyncCacheAction)

Mutator for incomingSyncCacheAction

setIncomingSyncCacheAction

public void setIncomingSyncCacheAction(java.lang.Object incomingSyncCacheAction)

Generic mutator for incomingSyncCacheAction

getIncomingSyncCacheActionFlag

public static boolean getIncomingSyncCacheActionFlag(int fieldflag)

Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.

getIncomingSyncCacheActionDefaultValue

public static IODeclReceive getIncomingSyncCacheActionDefaultValue()

Default value for incomingSyncCacheAction. Returns new IODeclReceive()

getIncomingSyncCacheActionInvalidValue

public static IODeclReceive getIncomingSyncCacheActionInvalidValue()

Invalid value for incomingSyncCacheAction. Returns null

getIncomingSyncCacheActionPrintValue

public java.lang.String getIncomingSyncCacheActionPrintValue()

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

getIncomingSyncCacheActionFieldPrintValue

public java.lang.String getIncomingSyncCacheActionFieldPrintValue()

Return the print name of the incomingSyncCacheAction field. If no printname is declared then this returns the field name.

getIncomingSyncCacheActionRange

public java.lang.String getIncomingSyncCacheActionRange()

Return the range specification for this field

getIncomingSyncCacheActionValidityCheck

public java.lang.String getIncomingSyncCacheActionValidityCheck()

getIncomingSyncCacheActionMetatype

public java.lang.String getIncomingSyncCacheActionMetatype()

Return the metatype text for this field, or "" if no metatype was declared.

getOutgoingAsyncCacheAction

public IODeclSend getOutgoingAsyncCacheAction()

Accessor for outgoingAsyncCacheAction

setOutgoingAsyncCacheAction

public void setOutgoingAsyncCacheAction(IODeclSend outgoingAsyncCacheAction)

Mutator for outgoingAsyncCacheAction

setOutgoingAsyncCacheAction

public void setOutgoingAsyncCacheAction(java.lang.Object outgoingAsyncCacheAction)

Generic mutator for outgoingAsyncCacheAction

getOutgoingAsyncCacheActionFlag

public static boolean getOutgoingAsyncCacheActionFlag(int fieldflag)

Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.

getOutgoingAsyncCacheActionDefaultValue

public static IODeclSend getOutgoingAsyncCacheActionDefaultValue()

Default value for outgoingAsyncCacheAction. Returns new IODeclSend()

getOutgoingAsyncCacheActionInvalidValue

public static IODeclSend getOutgoingAsyncCacheActionInvalidValue()

Invalid value for outgoingAsyncCacheAction. Returns null

getOutgoingAsyncCacheActionPrintValue

public java.lang.String getOutgoingAsyncCacheActionPrintValue()

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

getOutgoingAsyncCacheActionFieldPrintValue

public java.lang.String getOutgoingAsyncCacheActionFieldPrintValue()

Return the print name of the outgoingAsyncCacheAction field. If no printname is declared then this returns the field name.

getOutgoingAsyncCacheActionRange

public java.lang.String getOutgoingAsyncCacheActionRange()

Return the range specification for this field

getOutgoingAsyncCacheActionValidityCheck

public java.lang.String getOutgoingAsyncCacheActionValidityCheck()

getOutgoingAsyncCacheActionMetatype

public java.lang.String getOutgoingAsyncCacheActionMetatype()

Return the metatype text for this field, or "" if no metatype was declared.

getIncomingAsyncSandUpdateMessage

public IODeclSubscribe getIncomingAsyncSandUpdateMessage()

Accessor for incomingAsyncSandUpdateMessage

setIncomingAsyncSandUpdateMessage

public void setIncomingAsyncSandUpdateMessage(IODeclSubscribe incomingAsyncSandUpdateMessage)

Mutator for incomingAsyncSandUpdateMessage

setIncomingAsyncSandUpdateMessage

public void setIncomingAsyncSandUpdateMessage(java.lang.Object incomingAsyncSandUpdateMessage)

Generic mutator for incomingAsyncSandUpdateMessage

getIncomingAsyncSandUpdateMessageFlag

public static boolean getIncomingAsyncSandUpdateMessageFlag(int fieldflag)

Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.

getIncomingAsyncSandUpdateMessageDefaultValue

public static IODeclSubscribe getIncomingAsyncSandUpdateMessageDefaultValue()

Default value for incomingAsyncSandUpdateMessage. Returns new IODeclSubscribe()

getIncomingAsyncSandUpdateMessageInvalidValue

public static IODeclSubscribe getIncomingAsyncSandUpdateMessageInvalidValue()

Invalid value for incomingAsyncSandUpdateMessage. Returns null

getIncomingAsyncSandUpdateMessagePrintValue

public java.lang.String getIncomingAsyncSandUpdateMessagePrintValue()

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

getIncomingAsyncSandUpdateMessageFieldPrintValue

public java.lang.String getIncomingAsyncSandUpdateMessageFieldPrintValue()

Return the print name of the incomingAsyncSandUpdateMessage field. If no printname is declared then this returns the field name.

getIncomingAsyncSandUpdateMessageRange

public java.lang.String getIncomingAsyncSandUpdateMessageRange()

Return the range specification for this field

getIncomingAsyncSandUpdateMessageValidityCheck

public java.lang.String getIncomingAsyncSandUpdateMessageValidityCheck()

getIncomingAsyncSandUpdateMessageMetatype

public java.lang.String getIncomingAsyncSandUpdateMessageMetatype()

Return the metatype text for this field, or "" if no metatype was declared.

getIncomingAsyncCacheActionMessage

public IODeclSubscribe getIncomingAsyncCacheActionMessage()

Accessor for incomingAsyncCacheActionMessage

setIncomingAsyncCacheActionMessage

public void setIncomingAsyncCacheActionMessage(IODeclSubscribe incomingAsyncCacheActionMessage)

Mutator for incomingAsyncCacheActionMessage

setIncomingAsyncCacheActionMessage

public void setIncomingAsyncCacheActionMessage(java.lang.Object incomingAsyncCacheActionMessage)

Generic mutator for incomingAsyncCacheActionMessage

getIncomingAsyncCacheActionMessageFlag

public static boolean getIncomingAsyncCacheActionMessageFlag(int fieldflag)

Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.

getIncomingAsyncCacheActionMessageDefaultValue

public static IODeclSubscribe getIncomingAsyncCacheActionMessageDefaultValue()

Default value for incomingAsyncCacheActionMessage. Returns new IODeclSubscribe()

getIncomingAsyncCacheActionMessageInvalidValue

public static IODeclSubscribe getIncomingAsyncCacheActionMessageInvalidValue()

Invalid value for incomingAsyncCacheActionMessage. Returns null

getIncomingAsyncCacheActionMessagePrintValue

public java.lang.String getIncomingAsyncCacheActionMessagePrintValue()

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

getIncomingAsyncCacheActionMessageFieldPrintValue

public java.lang.String getIncomingAsyncCacheActionMessageFieldPrintValue()

Return the print name of the incomingAsyncCacheActionMessage field. If no printname is declared then this returns the field name.

getIncomingAsyncCacheActionMessageRange

public java.lang.String getIncomingAsyncCacheActionMessageRange()

Return the range specification for this field

getIncomingAsyncCacheActionMessageValidityCheck

public java.lang.String getIncomingAsyncCacheActionMessageValidityCheck()

getIncomingAsyncCacheActionMessageMetatype

public java.lang.String getIncomingAsyncCacheActionMessageMetatype()

Return the metatype text for this field, or "" if no metatype was declared.

getSandNodeState

public int getSandNodeState()

Accessor for sandNodeState

Specified by:: getSandNodeState in interface Controllable

setSandNodeState

public void setSandNodeState(int sandNodeState)

Mutator for sandNodeState

sandNodeStateValueToLabel

public java.lang.String sandNodeStateValueToLabel(int val)

Given a value, return the declared label for it. This is a conversion method suitable for things like XML serialization where the value must be unique, descriptive, and readable, but is not subject to the same degree of transformation as a UI.

sandNodeStateValueToLabelStatic

public static java.lang.String sandNodeStateValueToLabelStatic(int val)

sandNodeStateLabelToValue

public int sandNodeStateLabelToValue(java.lang.String label)

Given a label, return the value for it. This is a conversion method performing the inverse of ValueToLabel. See the comments there for more details.

sandNodeStateLabelToValueStatic

public static int sandNodeStateLabelToValueStatic(java.lang.String label)

getSandNodeStatePrintVals

public static java.lang.String[] getSandNodeStatePrintVals()

Return an array of the possible values for this field in display format. These values can be used by a UI directly, or as keys for looking up localized text. These values are not guaranteed to be globally unique, another field with the same possible value may share the same string instance.

getSandNodeStateKeyVals

public static java.lang.String[] getSandNodeStateKeyVals()

Return an array of unique keys for the values of this field. These keys are globally unique and can be used for looking up localized text without any chance of the same key being used by any other field value in the application.

getSandNodeStateActualVals

public static java.lang.String[] getSandNodeStateActualVals()

Return an array of the possible values for this field as Strings. These values can be directly converted to their integer equivalents.

sandNodeStatePrint2Key

public static java.lang.String sandNodeStatePrint2Key(java.lang.String printVal)

Utility method to transform a print value for this field into a key value. See the getSandNodeStatePrintVals and getSandNodeStateKeyVals methods for details.

sandNodeStatePrint2Actual

public static java.lang.String sandNodeStatePrint2Actual(java.lang.String printVal)

Utility method to transform a print value for this field into an actual value. See the getSandNodeStatePrintVals and getSandNodeStateActualVals methods for details.

sandNodeStateActual2Print

public static java.lang.String sandNodeStateActual2Print(java.lang.String actualVal)

Utility method to transform an actual value for this field into a print value. See the getSandNodeStateActualVals and getSandNodeStatePrintVals methods for details.

getSandNodeStateEnumSummary

public static java.lang.String getSandNodeStateEnumSummary()

Return a single String summary of the possible enum values for debug and similar purposes.

getSandNodeStateFlag

public static boolean getSandNodeStateFlag(int fieldflag)

Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.

getSandNodeStateDefaultValue

public static int getSandNodeStateDefaultValue()

Default value for sandNodeState. Returns 0

getSandNodeStateInvalidValue

public static int getSandNodeStateInvalidValue()

Invalid value for sandNodeState. Returns Integer.MIN_VALUE

getSandNodeStatePrintValue

public java.lang.String getSandNodeStatePrintValue()

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

getSandNodeStateFieldPrintValue

public java.lang.String getSandNodeStateFieldPrintValue()

Return the print name of the sandNodeState field. If no printname is declared then this returns the field name.

getSandNodeStateRange

public java.lang.String getSandNodeStateRange()

Return the range specification for this field

getSandNodeStateValidityCheck

public java.lang.String getSandNodeStateValidityCheck()

getSandNodeStateMetatype

public java.lang.String getSandNodeStateMetatype()

Return the metatype text for this field, or "" if no metatype was declared.

getSandNodeErrorMessage

public java.lang.String getSandNodeErrorMessage()

Accessor for sandNodeErrorMessage

setSandNodeErrorMessage

public void setSandNodeErrorMessage(java.lang.String sandNodeErrorMessage)

Mutator for sandNodeErrorMessage

setSandNodeErrorMessage

public void setSandNodeErrorMessage(java.lang.Object sandNodeErrorMessage)

Generic mutator for sandNodeErrorMessage

getSandNodeErrorMessageFlag

public static boolean getSandNodeErrorMessageFlag(int fieldflag)

Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.

getSandNodeErrorMessageLengthNorm

public static int getSandNodeErrorMessageLengthNorm()

Normal sandNodeErrorMessage length is 30 characters

getSandNodeErrorMessageLengthMax

public static int getSandNodeErrorMessageLengthMax()

Maximum sandNodeErrorMessage length is 70 characters

getSandNodeErrorMessageDefaultValue

public static java.lang.String getSandNodeErrorMessageDefaultValue()

Default value for sandNodeErrorMessage. Returns ""

getSandNodeErrorMessageInvalidValue

public static java.lang.String getSandNodeErrorMessageInvalidValue()

Invalid value for sandNodeErrorMessage. Returns null

getSandNodeErrorMessagePrintValue

public java.lang.String getSandNodeErrorMessagePrintValue()

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

getSandNodeErrorMessageFieldPrintValue

public java.lang.String getSandNodeErrorMessageFieldPrintValue()

Return the print name of the sandNodeErrorMessage field. If no printname is declared then this returns the field name.

getSandNodeErrorMessageRange

public java.lang.String getSandNodeErrorMessageRange()

Return the range specification for this field

getSandNodeErrorMessageValidityCheck

public java.lang.String getSandNodeErrorMessageValidityCheck()

getSandNodeErrorMessageMetatype

public java.lang.String getSandNodeErrorMessageMetatype()

Return the metatype text for this field, or "" if no metatype was declared.

getMessager

public Messager getMessager()

Accessor for messager

Specified by:: getMessager in interface Messageable

setMessager

public void setMessager(Messager messager)

Mutator for messager

Specified by:: setMessager in interface Messageable

setMessager

public void setMessager(java.lang.Object messager)

Generic mutator for messager

getMessagerFlag

public static boolean getMessagerFlag(int fieldflag)

Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.

getMessagerDefaultValue

public static Messager getMessagerDefaultValue()

Default value for messager. Returns null

getMessagerInvalidValue

public static Messager getMessagerInvalidValue()

Invalid value for messager. Returns null

getMessagerPrintValue

public java.lang.String getMessagerPrintValue()

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

getMessagerFieldPrintValue

public java.lang.String getMessagerFieldPrintValue()

Return the print name of the messager field. If no printname is declared then this returns the field name.

getMessagerRange

public java.lang.String getMessagerRange()

Return the range specification for this field

getMessagerValidityCheck

public java.lang.String getMessagerValidityCheck()

getMessagerMetatype

public java.lang.String getMessagerMetatype()

Return the metatype text for this field, or "" if no metatype was declared.

getLogger

public Logger getLogger()

Accessor for logger

Specified by:: getLogger in interface Loggable

setLogger

public void setLogger(Logger logger)

Mutator for logger

Specified by:: setLogger in interface Loggable

setLogger

public void setLogger(java.lang.Object logger)

Generic mutator for logger

getLoggerFlag

public static boolean getLoggerFlag(int fieldflag)

Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.

getLoggerDefaultValue

public static Logger getLoggerDefaultValue()

Default value for logger. Returns null

getLoggerInvalidValue

public static Logger getLoggerInvalidValue()

Invalid value for logger. Returns null

getLoggerPrintValue

public java.lang.String getLoggerPrintValue()

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

getLoggerFieldPrintValue

public java.lang.String getLoggerFieldPrintValue()

Return the print name of the logger field. If no printname is declared then this returns the field name.

getLoggerRange

public java.lang.String getLoggerRange()

Return the range specification for this field

getLoggerValidityCheck

public java.lang.String getLoggerValidityCheck()

getLoggerMetatype

public java.lang.String getLoggerMetatype()

Return the metatype text for this field, or "" if no metatype was declared.

getLogLevel

public int getLogLevel()

Accessor for logLevel

Specified by:: getLogLevel in interface Loggable

setLogLevel

public void setLogLevel(int logLevel)

Mutator for logLevel

Specified by:: setLogLevel in interface Loggable

logLevelValueToLabel

public java.lang.String logLevelValueToLabel(int val)

logLevelValueToLabelStatic

public static java.lang.String logLevelValueToLabelStatic(int val)

logLevelLabelToValue

public int logLevelLabelToValue(java.lang.String label)

Given a label, return the value for it. This is a conversion method performing the inverse of ValueToLabel. See the comments there for more details.

logLevelLabelToValueStatic

public static int logLevelLabelToValueStatic(java.lang.String label)

getLogLevelPrintVals

public static java.lang.String[] getLogLevelPrintVals()

getLogLevelKeyVals

public static java.lang.String[] getLogLevelKeyVals()

getLogLevelActualVals

public static java.lang.String[] getLogLevelActualVals()

Return an array of the possible values for this field as Strings. These values can be directly converted to their integer equivalents.

logLevelPrint2Key

public static java.lang.String logLevelPrint2Key(java.lang.String printVal)

Utility method to transform a print value for this field into a key value. See the getLogLevelPrintVals and getLogLevelKeyVals methods for details.

logLevelPrint2Actual

public static java.lang.String logLevelPrint2Actual(java.lang.String printVal)

Utility method to transform a print value for this field into an actual value. See the getLogLevelPrintVals and getLogLevelActualVals methods for details.

logLevelActual2Print

public static java.lang.String logLevelActual2Print(java.lang.String actualVal)

Utility method to transform an actual value for this field into a print value. See the getLogLevelActualVals and getLogLevelPrintVals methods for details.

getLogLevelEnumSummary

public static java.lang.String getLogLevelEnumSummary()

Return a single String summary of the possible enum values for debug and similar purposes.

getLogLevelFlag

public static boolean getLogLevelFlag(int fieldflag)

Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.

getLogLevelDefaultValue

public static int getLogLevelDefaultValue()

Default value for logLevel. Returns 0

getLogLevelInvalidValue

public static int getLogLevelInvalidValue()

Invalid value for logLevel. Returns Integer.MIN_VALUE

getLogLevelPrintValue

public java.lang.String getLogLevelPrintValue()

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

getLogLevelFieldPrintValue

public java.lang.String getLogLevelFieldPrintValue()

Return the print name of the logLevel field. If no printname is declared then this returns the field name.

getLogLevelRange

public java.lang.String getLogLevelRange()

Return the range specification for this field

getLogLevelValidityCheck

public java.lang.String getLogLevelValidityCheck()

getLogLevelMetatype

public java.lang.String getLogLevelMetatype()

Return the metatype text for this field, or "" if no metatype was declared.

getNodeInstance

public NodeInstance getNodeInstance()

Accessor for nodeInstance

Specified by:: getNodeInstance in interface Controllable

setNodeInstance

public void setNodeInstance(NodeInstance nodeInstance)

Mutator for nodeInstance

Specified by:: setNodeInstance in interface Controllable

setNodeInstance

public void setNodeInstance(java.lang.Object nodeInstance)

Generic mutator for nodeInstance

getNodeInstanceFlag

public static boolean getNodeInstanceFlag(int fieldflag)

Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.

getNodeInstanceDefaultValue

public static NodeInstance getNodeInstanceDefaultValue()

Default value for nodeInstance. Returns null

getNodeInstanceInvalidValue

public static NodeInstance getNodeInstanceInvalidValue()

Invalid value for nodeInstance. Returns null

getNodeInstancePrintValue

public java.lang.String getNodeInstancePrintValue()

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

getNodeInstanceFieldPrintValue

public java.lang.String getNodeInstanceFieldPrintValue()

Return the print name of the nodeInstance field. If no printname is declared then this returns the field name.

getNodeInstanceRange

public java.lang.String getNodeInstanceRange()

Return the range specification for this field

getNodeInstanceValidityCheck

public java.lang.String getNodeInstanceValidityCheck()

getNodeInstanceMetatype

public java.lang.String getNodeInstanceMetatype()

Return the metatype text for this field, or "" if no metatype was declared.

getNodeInstanceName

public java.lang.String getNodeInstanceName()

convenience wrapper method to retrieve our instance name

getServername

public java.lang.String getServername()

convenience wrapper method to retrieve our home server name

getSandRoot

public SandRoot getSandRoot()

accessor for sandRoot

Specified by:: getSandRoot in interface Controllable

setSandRoot

public void setSandRoot(SandRoot val)

mutator for sandRoot

Specified by:: setSandRoot in interface Controllable

init

public void init()

Initialize all fields to their default values

log

public void log(int severity,
                java.lang.String msg)

Log the message with the specified severity. Valid severity codes are (in increasing severity order):

LOGDEBUG (debugging information)
LOGINFO (general information)
LOGWARN (runtime problem, but fully recoverable)
LOGERROR (runtime problem, partially recoverable)
LOGFATAL (runtime problem, not recoverable)

If the severity specified is less than the logLevel set for this node, then no message is generated. For example if the logLevel is set to INFO, no DEBUG messages are output. If the logLevel is set to WARN, then no INFO or DEBUG messages are output. It is not recommended to set the logLevel to anything higher than WARN.

log

public void log(java.lang.String msg)

Shorthand for log(Logger.LOGLEVEL_INFO,msg)

startup

public void startup()
             throws ControlException

Starts a stopped node. The helper nodes are started first, then this node is started.

Specified by:: startup in interface Controllable

Throws:: ControlException

shutdown

public void shutdown()
              throws ControlException

Stops a running node. This node is stopped first, and then our helper nodes are stopped.

Specified by:: shutdown in interface Controllable

Throws:: ControlException

suspend

public void suspend()
             throws ControlException

Suspends a running node. This node is suspended first, and then our helper nodes are stopped.

Specified by:: suspend in interface Controllable

Throws:: ControlException

resume

public void resume()
            throws ControlException

Resumes a suspended node. The helper nodes are resumed first, and then this node.

Specified by:: resume in interface Controllable

Throws:: ControlException

restart

public void restart()
             throws ControlException

Restarts a running node by calling shutdown and then startup

Specified by:: restart in interface Controllable

Throws:: ControlException

validTransition

public boolean validTransition(int transition)

Validates a state transition by comparing the desired transition with the current state.

readConfigParamsFromNodeInstance

public void readConfigParamsFromNodeInstance(NodeInstance ni)

Read our configuration parameter values from the our node instance. This is done at startup, and is public to allow it to be called from a NodeInstanceFactory at node creation time. If NodeInstance is null, then this method does nothing and just returns. A null NodeInstance is normal in some startup situations and should not cause a startup error.

onStartup

protected void onStartup()
                  throws SandException

Override this method to do work during startup().

Throws:: SandException

onShutdown

protected void onShutdown()
                   throws SandException

Override this method to do work during shutdown().

Throws:: SandException

onSuspend

protected void onSuspend()
                  throws SandException

Override this method to do work during suspend().

Throws:: SandException

onResume

protected void onResume()
                 throws SandException

Override this method to do work during resume().

Throws:: SandException

onRestart

protected void onRestart()
                  throws SandException

Override this method to do work during startup().

Throws:: SandException

onFailure

protected void onFailure()
                  throws ControlException

Override this method to do work when the node enters the failed state.

Throws:: ControlException

getParent

public Controllable getParent()

accessor for parent

Specified by:: getParent in interface Controllable

setParent

public void setParent(Controllable node)

mutator for parent

getHelperNodes

public Controllable[] getHelperNodes()

accessor for helperNodes

Specified by:: getHelperNodes in interface Controllable

setHelperNodes

public void setHelperNodes(Controllable[] nodes)

mutator for helperNodes

Specified by:: setHelperNodes in interface Controllable

systemwideShutdown

public void systemwideShutdown(int code)
                        throws ControlException

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. This method is overridden by the root node to handle signalling across multiple server nodes.

Specified by:: systemwideShutdown in interface Controllable

Throws:: ControlException

addWrapper

public void addWrapper(ControlWrapper wrapper)

Add the specified wrapper to our notification collection

Specified by:: addWrapper in interface Controllable

notifyStateChange

protected void notifyStateChange(int prevState,
                                 int currState)

Notify our registered control wrappers of our state change

setupSubscriptions

protected void setupSubscriptions()

Subscribe us to the nodes we need to listen to

setupSecureReceive

protected void setupSecureReceive()

receive

public CacheAction receive(CacheAction msg)
                    throws SandException

Synchronous inbound CacheAction

Throws:: SandException

onReceive

protected CacheAction onReceive(CacheAction msg)
                         throws SandException

Override this method in your node implementation

Throws:: SandException

receive

public SandMessage receive(SandMessage msg)
                    throws SandException

Only those receive methods explicitely declared by the node should actually be called. However the Messageable interface forces all calls to be channeled through this general method, which means we have to manually call the correct method from here.

In practice, this doesn't add much overhead if we enumerate the supported methods at code generation time, and then switch on the enumeration.

Specified by:: receive in interface Messageable

Throws:: SandException

deliverSandUpdateMessage

public void deliverSandUpdateMessage(SandUpdateMessage msg)
                              throws SandException

Asynchronous inbound SandUpdateMessage

Throws:: SandException

onDelivery

protected void onDelivery(SandUpdateMessage msg)
                   throws SandException

Override this method in your node implementation

Throws:: SandException

deliverCacheActionMessage

public void deliverCacheActionMessage(CacheAction msg)
                               throws SandException

Asynchronous inbound CacheAction

Throws:: SandException

onDelivery

protected void onDelivery(CacheAction msg)
                   throws SandException

Override this method in your node implementation

Throws:: SandException

deliver

public void deliver(SandMessage msg)
             throws SandException

Only those deliver methods explicitely declared by the node should actually be called. However the Messageable interface forces all calls to be channeled through this general method, which means we have to manually call the correct method from here.

In practice, this doesn't add much overhead if we enumerate the supported methods at code generation time, and then switch on the enumeration.

Specified by:: deliver in interface Messageable

Throws:: SandException

callQuery

public SandCollectionMessage callQuery(SandQueryMessage sqm)
                                throws SandException

Generalized query method to handle all queries understood by this node

Specified by:: callQuery in interface Messageable

Throws:: SandException

send

public void send(CacheAction msg)
          throws MessagerException

Asynchronous outbound CacheAction

Throws:: MessagerException

getIDCache

public IDCache getIDCache()

Retrieve an IDCache for use by this node. Override this method if you want a different cache implementation.

Specified by:: getIDCache in interface Messageable

getDeploymentPrefix

public java.lang.String getDeploymentPrefix()

Return the prefix for this deployment.

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.CacheManager Class CacheManagerNodeBase

incomingSyncCacheAction

outgoingAsyncCacheAction

incomingAsyncSandUpdateMessage

incomingAsyncCacheActionMessage

sandNodeState

SANDNODESTATE_UNDEFINED

SANDNODESTATE_RUNNING

SANDNODESTATE_SUSPENDED

SANDNODESTATE_STOPPED

SANDNODESTATE_FAILED

SANDNODESTATE_STARTING

SANDNODESTATE_STOPPING

SANDNODESTATE_SUSPENDING

SANDNODESTATE_RESUMING

SANDNODESTATE_FAILING

sandNodeErrorMessage

messager

logger

logLevel

LOGLEVEL_DEBUG

LOGLEVEL_INFO

LOGLEVEL_WARN

LOGLEVEL_ERROR

LOGLEVEL_FATAL

nodeInstance

sandRoot

LOGDEBUG

LOGINFO

LOGWARN

LOGERROR

LOGFATAL

parent

helperNodes

ctrlwrappers

CacheManagerNodeBase

fieldHasFlag

getLocalAuthUserLookup

setLocalAuthUserLookup

setLocalAuthUserLookup

getLocalAuthUserLookupFlag

getLocalAuthUserLookupLengthNorm

getLocalAuthUserLookupLengthMax

getLocalAuthUserLookupDefaultValue

getLocalAuthUserLookupInvalidValue

getLocalAuthUserLookupPrintValue

getLocalAuthUserLookupFieldPrintValue

getLocalAuthUserLookupRange

getLocalAuthUserLookupValidityCheck

getLocalAuthUserLookupMetatype

getNotificationUsername

setNotificationUsername

setNotificationUsername

getNotificationUsernameFlag

getNotificationUsernameLengthNorm

getNotificationUsernameLengthMax

getNotificationUsernameDefaultValue

getNotificationUsernameInvalidValue

getNotificationUsernamePrintValue

getNotificationUsernameFieldPrintValue

getNotificationUsernameRange

getNotificationUsernameValidityCheck

getNotificationUsernameMetatype

getNotificationPassword

setNotificationPassword

setNotificationPassword

getNotificationPasswordFlag

getNotificationPasswordLengthNorm

getNotificationPasswordLengthMax

getNotificationPasswordDefaultValue

getNotificationPasswordInvalidValue

getNotificationPasswordPrintValue

getNotificationPasswordFieldPrintValue

getNotificationPasswordRange

getNotificationPasswordValidityCheck

getNotificationPasswordMetatype

getIncomingSyncCacheAction

setIncomingSyncCacheAction

setIncomingSyncCacheAction

getIncomingSyncCacheActionFlag

org.sandev.basics.CacheManager
Class CacheManagerNodeBase