org.sandev.basics.structs
Interface NodeInstance

All Superinterfaces:
SandInstanceMessage, SandMessage
All Known Implementing Classes:
AuthorizerNodeInstance, CacheManagerNodeInstance, DataManagerNodeInstance, MessageDriverNodeInstance

public interface NodeInstance
extends SandInstanceMessage

A declaration of a node instance.

SandMessage

If you are declaring a new node Foo, then you create the FooNodeDecl.java (declaration) and FooNode.java (implementation) files. The generators create FooNodeBase.java (the SAND implementation), and FooNodeInstance.java (the instance declaration). FooNodeInstance implements NodeInstance. A deployment Configuration contains a collection of NodeInstances, which comprise the deployed system.


Field Summary
static int MSGMODE_DIRECT
          message goes directly from source to destination
static int MSGMODE_SECURE
          message goes via authorizers
static int MSGOPTIMIZE_IF_POSSIBLE
          message is delivered via direct java call if possible
static int MSGOPTIMIZE_NEVER
          message is always delivered via supporting technology
 
Fields inherited from interface org.sandev.basics.structs.SandInstanceMessage
FIELDCHECK_EMPTYSTRINGPRINTVAL, FIELDCHECK_INVALIDVAL, FIELDCHECK_NOTAREF, FIELDCHECK_NOTINRANGE, FIELDCHECK_NULLARRAY, FIELDCHECK_STRINGOVER, FIELDCHECK_UNKNOWNVAL, FIELDFLAG_BINARY, FIELDFLAG_ENCRYPT, FIELDFLAG_INTERNAL, FIELDFLAG_NOECHO, FIELDFLAG_OBFUSCATE, FIELDFLAG_STRINGPERSIST, FIELDFLAG_SUMMARYEDIT, FIELDFLAG_UNIQUE, GENMOD_ACTION_APPEND, GENMOD_ACTION_INSERT, GENMOD_ACTION_REMOVE, GENMOD_ACTION_SET
 
Method Summary
 NodeInstance[] getHelperNodes()
          Return the helper node instances configured to work with this node instance.
 int getLogLevel()
          Return the log level of this node, as one of the Logger.LOGLEVEL_* values.
 java.lang.String getNodeInstanceName()
          Return the unique name of this node instance.
 java.lang.String getServername()
          Return the unique name of the server this node is running on.
 void setHelperNodes(NodeInstance[] nodes)
          Set the helper node instances configured to work with this node instance.
 void setLogLevel(int logLevel)
          Set the log level of this node.
 void setServername(java.lang.String name)
          Set the unique name of the server this node should run on.
 
Methods inherited from interface org.sandev.basics.structs.SandInstanceMessage
cloneMessage, convertToSuperstructClass, copyFieldValue, debugDump, defaultField, fieldHasFlag, fieldsValid, fieldValidate, generalAccessor, generalDereference, generalModifier, getAllFields, getContainedMessageFields, getDisplayFields, getDisplayFieldsPrint, getDisplayID, getDisplayValues, getPrintnameForField
 
Methods inherited from interface org.sandev.basics.structs.SandMessage
getCollectionMessage, getQueryMessage, getShortName, getStructMessage, getUpdateMessage, isEquivalent
 

Field Detail

MSGMODE_DIRECT

static final int MSGMODE_DIRECT
message goes directly from source to destination

See Also:
Constant Field Values

MSGMODE_SECURE

static final int MSGMODE_SECURE
message goes via authorizers

See Also:
Constant Field Values

MSGOPTIMIZE_IF_POSSIBLE

static final int MSGOPTIMIZE_IF_POSSIBLE
message is delivered via direct java call if possible

See Also:
Constant Field Values

MSGOPTIMIZE_NEVER

static final int MSGOPTIMIZE_NEVER
message is always delivered via supporting technology

See Also:
Constant Field Values
Method Detail

getNodeInstanceName

java.lang.String getNodeInstanceName()
Return the unique name of this node instance.


getServername

java.lang.String getServername()
Return the unique name of the server this node is running on. If this instance is running as a helper of another node, the servername should be left unspecified.


setServername

void setServername(java.lang.String name)
Set the unique name of the server this node should run on.


getLogLevel

int getLogLevel()
Return the log level of this node, as one of the Logger.LOGLEVEL_* values.


setLogLevel

void setLogLevel(int logLevel)
Set the log level of this node. Must be one of the Logger.LOGLEVEL_* values.


getHelperNodes

NodeInstance[] getHelperNodes()
Return the helper node instances configured to work with this node instance.


setHelperNodes

void setHelperNodes(NodeInstance[] nodes)
Set the helper node instances configured to work with this node instance.