CacheManagerNodeInstance

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 CacheManagerNodeInstance

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

All Implemented Interfaces:: NodeInstance, Resolvable, SandInstanceMessage, SandMessage

public class CacheManagerNodeInstance
extends CacheManagerNodeDecl
implements NodeInstance, Resolvable

AUTOGENERATED FILE, DO NOT EDIT DIRECTLY.
source: org.sandev.basics.CacheManager.CacheManagerNodeDecl
generator: org.sandev.generator.NodeInstClassGenerator
time: Dec 2, 2005 6:38:50 PM

This file contains all declared configuration and messaging parameters for this node.

Field Summary
`protected NodeInstance[]`	`helperNodes` Additional nodes instantiated with this node running together as a logical subsystem.
`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 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 java.lang.String`	`nodeInstanceName` The unique name identifying this specific node instance.
`protected IODeclSend`	`outgoingAsyncCacheAction` Outbound org.sandev.basics.sandmessages.CacheAction asynchronous messaging configuration
`protected java.lang.String`	`servername` The name of the server this instance will be running on.

Fields inherited from class org.sandev.basics.CacheManager.CacheManagerNodeDecl

localAuthUserLookup, notificationPassword, notificationUsername

Fields inherited from interface org.sandev.basics.structs.NodeInstance

MSGMODE_DIRECT, MSGMODE_SECURE, MSGOPTIMIZE_IF_POSSIBLE, MSGOPTIMIZE_NEVER

Fields inherited from interface org.sandev.basics.structs.SandInstanceMessage

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_UNIQUE, GENMOD_ACTION_APPEND, GENMOD_ACTION_INSERT, GENMOD_ACTION_REMOVE, GENMOD_ACTION_SET

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

Method Summary
`void`	`addHelperNodes(NodeInstance element)` Appends a value to helperNodes
`void`	`addHelperNodes(NodeInstance[] elements)` Appends an array of values to helperNodes
`void`	`clearHelperNodes()` Clears all values from helperNodes
`CacheManagerNodeInstance`	`cloneCacheManagerNodeInstance()` Make a deep copy of this CacheManagerNodeInstance.
`SandInstanceMessage`	`cloneMessage()` Calls cloneCacheManagerNodeInstance
`SandInstanceMessage`	`convertToSuperstructClass()` Return a new instance of the message associated with the superstruct of this instance.
`void`	`copyDataFrom(CacheManagerNodeInstance other)` Deep copy all the data from the specified instance.
`void`	`copyFieldValue(java.lang.String fieldName, SandInstanceMessage other)` Copy the specified field from the given instance.
`java.lang.String`	`debugDump(java.lang.String prefix)` Dump this instance into a debug printable string.
`void`	`defaultField(java.lang.String fieldname)` Set the specified field to its default value.
`boolean`	`fieldHasFlag(java.lang.String fieldname, int fieldflag)` Return true if the named field declares the indicated flag, false otherwise.
`boolean`	`fieldsValid()` Validate the fields as specified in the SandInstanceMessage interface
`SandAttrVal[]`	`fieldValidate(SandAttrVal[] checkFields)` Validate the fields as specified in the SandInstanceMessage interface
`java.lang.Object`	`generalAccessor(java.lang.String fieldspec)` General field accessor method.
`SandAttrVal`	`generalDereference(java.lang.String fieldspec)` General reference field accessor method.
`void`	`generalModifier(int action, java.lang.String field, int index, java.lang.Object val)` General mutator method.
`java.lang.String[]`	`getAllFields()` Return an array of all fields for this class.
`SandCollectionMessage`	`getCollectionMessage()` Returns null
`java.lang.String[]`	`getDisplayFields()` Return an array of the summary field names for this class.
`java.lang.String[]`	`getDisplayValues()` Return the values for the summary fields.
`java.lang.String[]`	`getDisplayValues(IDLookup lookup, AuthUser user, java.lang.String defaultVal)` Return the values for the summary fields, including dereference expressions.
`NodeInstance[]`	`getHelperNodes()` Accessor for helperNodes
`NodeInstance`	`getHelperNodes(int index)` Returns the element at the specified index.
`static NodeInstance[]`	`getHelperNodesDefaultValue()` Default value for helperNodes.
`static NodeInstance`	`getHelperNodesElementInvalidValue()` Invalid value for helperNodeselement.
`static boolean`	`getHelperNodesFlag(int fieldflag)` Field flag accessor.
`static NodeInstance[]`	`getHelperNodesInvalidValue()` Invalid value for helperNodes.
`java.lang.String`	`getHelperNodesMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getHelperNodesRange()` Return the range specification for this field
`java.lang.String`	`getHelperNodesValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`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.
`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.
`java.lang.String`	`getNodeInstanceName()` Accessor for nodeInstanceName
`static java.lang.String`	`getNodeInstanceNameDefaultValue()` Default value for nodeInstanceName.
`java.lang.String`	`getNodeInstanceNameFieldPrintValue()` Return the print name of the nodeInstanceName field.
`static boolean`	`getNodeInstanceNameFlag(int fieldflag)` Field flag accessor.
`static java.lang.String`	`getNodeInstanceNameInvalidValue()` Invalid value for nodeInstanceName.
`static int`	`getNodeInstanceNameLengthMax()` Maximum nodeInstanceName length is 70 characters
`static int`	`getNodeInstanceNameLengthNorm()` Normal nodeInstanceName length is 30 characters
`java.lang.String`	`getNodeInstanceNameMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getNodeInstanceNamePrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getNodeInstanceNameRange()` Return the range specification for this field
`java.lang.String`	`getNodeInstanceNameValidityCheck()` 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.
`SandQueryMessage`	`getQueryMessage()` Returns null
`java.lang.String`	`getServername()` Accessor for servername
`static java.lang.String`	`getServernameDefaultValue()` Default value for servername.
`java.lang.String`	`getServernameFieldPrintValue()` Return the print name of the servername field.
`static boolean`	`getServernameFlag(int fieldflag)` Field flag accessor.
`static java.lang.String`	`getServernameInvalidValue()` Invalid value for servername.
`static int`	`getServernameLengthMax()` Maximum servername length is 70 characters
`static int`	`getServernameLengthNorm()` Normal servername length is 30 characters
`java.lang.String`	`getServernameMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getServernamePrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getServernameRange()` Return the range specification for this field
`java.lang.String`	`getServernameValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`java.lang.String`	`getShortName()` Returns the unqualified name of this message.
`SandStructMessage`	`getStructMessage()` Returns a new CacheManagerNodeInstance instance
`SandUpdateMessage`	`getUpdateMessage()` Returns null
`java.lang.String`	`getValueForFieldName(java.lang.String fieldname, IDLookup lookup, AuthUser user, java.lang.String defaultVal)` Returns the print representation of the value of the specified field, or the given default value if innaccessible.
`boolean`	`helperNodesContains(NodeInstance val)` Returns true if helperNodes contains the specified value.
`int`	`helperNodesIndexOf(NodeInstance val)` Return the index of the specified value in helperNodes, or -1 if not found.
`void`	`init()` Initialize all fields to their default values
`void`	`insertHelperNodes(int index, NodeInstance value)` Insert the specified element at the specified index.
`boolean`	`isEquivalent(SandMessage sm)` Declared field equivalence check as specified by the SandMessage interface.
`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.
`java.lang.String[]`	`referenceValidate(java.lang.String[] locations, java.lang.String prefix, IDLookup idlookup, NameLookup namelookup, AuthUser au)` Validate the references as specified in the Resolvable interface.
`NodeInstance`	`removeHelperNodes(int index)` Remove the element at the specified index and return it.
`boolean`	`removeHelperNodesValue(NodeInstance value)` Removes the given element from helperNodes.
`ServerDeclaration`	`resolveServernameReference(NameLookup lookup, AuthUser au)` Converts a reference to an instance by looking it up.
`ServerDeclaration`	`resolveServernameReferenceNonCrit(NameLookup lookup, AuthUser au)` Calls standard method, eating any SandException and returning a new instance with all default values instead.
`void`	`setHelperNodes(int index, NodeInstance value)` Set the value at the index specified.
`void`	`setHelperNodes(NodeInstance[] helperNodes)` Mutator for helperNodes
`void`	`setHelperNodes(java.lang.Object[] helperNodes)` Generic 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`	`setLogLevel(int logLevel)` Mutator for logLevel
`void`	`setNodeInstanceName(java.lang.Object nodeInstanceName)` Generic mutator for nodeInstanceName
`void`	`setNodeInstanceName(java.lang.String nodeInstanceName)` Mutator for nodeInstanceName
`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`	`setServername(java.lang.Object servername)` Generic mutator for servername
`void`	`setServername(java.lang.String servername)` Mutator for servername
`int`	`sizeofHelperNodes()` Returns the size of helperNodes.
`java.lang.String`	`toString()` Return a string representation of this object.

Methods inherited from class java.lang.Object

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

Field Detail

nodeInstanceName

protected java.lang.String nodeInstanceName

The unique name identifying this specific node instance.

servername

protected java.lang.String servername

The name of the server this instance will be running on.

helperNodes

protected NodeInstance[] helperNodes

Additional nodes instantiated with this node running together as a logical subsystem.

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

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

Constructor Detail

CacheManagerNodeInstance

public CacheManagerNodeInstance()

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.

Specified by:: fieldHasFlag in interface SandInstanceMessage

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.

getNodeInstanceName

public java.lang.String getNodeInstanceName()

Accessor for nodeInstanceName

Specified by:: getNodeInstanceName in interface NodeInstance

setNodeInstanceName

public void setNodeInstanceName(java.lang.String nodeInstanceName)

Mutator for nodeInstanceName

setNodeInstanceName

public void setNodeInstanceName(java.lang.Object nodeInstanceName)

Generic mutator for nodeInstanceName

getNodeInstanceNameFlag

public static boolean getNodeInstanceNameFlag(int fieldflag)

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

getNodeInstanceNameLengthNorm

public static int getNodeInstanceNameLengthNorm()

Normal nodeInstanceName length is 30 characters

getNodeInstanceNameLengthMax

public static int getNodeInstanceNameLengthMax()

Maximum nodeInstanceName length is 70 characters

getNodeInstanceNameDefaultValue

public static java.lang.String getNodeInstanceNameDefaultValue()

Default value for nodeInstanceName. Returns ""

getNodeInstanceNameInvalidValue

public static java.lang.String getNodeInstanceNameInvalidValue()

Invalid value for nodeInstanceName. Returns null

getNodeInstanceNamePrintValue

public java.lang.String getNodeInstanceNamePrintValue()

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

getNodeInstanceNameFieldPrintValue

public java.lang.String getNodeInstanceNameFieldPrintValue()

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

getNodeInstanceNameRange

public java.lang.String getNodeInstanceNameRange()

Return the range specification for this field

getNodeInstanceNameValidityCheck

public java.lang.String getNodeInstanceNameValidityCheck()

getNodeInstanceNameMetatype

public java.lang.String getNodeInstanceNameMetatype()

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

getServername

public java.lang.String getServername()

Accessor for servername

Specified by:: getServername in interface NodeInstance

setServername

public void setServername(java.lang.String servername)

Mutator for servername

Specified by:: setServername in interface NodeInstance

setServername

public void setServername(java.lang.Object servername)

Generic mutator for servername

getServernameFlag

public static boolean getServernameFlag(int fieldflag)

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

getServernameLengthNorm

public static int getServernameLengthNorm()

Normal servername length is 30 characters

getServernameLengthMax

public static int getServernameLengthMax()

Maximum servername length is 70 characters

getServernameDefaultValue

public static java.lang.String getServernameDefaultValue()

Default value for servername. Returns ""

getServernameInvalidValue

public static java.lang.String getServernameInvalidValue()

Invalid value for servername. Returns null

getServernamePrintValue

public java.lang.String getServernamePrintValue()

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

getServernameFieldPrintValue

public java.lang.String getServernameFieldPrintValue()

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

getServernameRange

public java.lang.String getServernameRange()

Return the range specification for this field

resolveServernameReferenceNonCrit

public ServerDeclaration resolveServernameReferenceNonCrit(NameLookup lookup,
                                                           AuthUser au)

Calls standard method, eating any SandException and returning a new instance with all default values instead. This is to support the UI, which is calling to get detail for a richer display. If the detail is not available, it's not critical.

resolveServernameReference

public ServerDeclaration resolveServernameReference(NameLookup lookup,
                                                    AuthUser au)
                                             throws SandException

Converts a reference to an instance by looking it up.

Throws:: SandException

getServernameValidityCheck

public java.lang.String getServernameValidityCheck()

getServernameMetatype

public java.lang.String getServernameMetatype()

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

getHelperNodes

public NodeInstance[] getHelperNodes()

Accessor for helperNodes

Specified by:: getHelperNodes in interface NodeInstance

setHelperNodes

public void setHelperNodes(NodeInstance[] helperNodes)

Mutator for helperNodes

Specified by:: setHelperNodes in interface NodeInstance

setHelperNodes

public void setHelperNodes(java.lang.Object[] helperNodes)

Generic mutator for helperNodes

addHelperNodes

public void addHelperNodes(NodeInstance element)

Appends a value to helperNodes

addHelperNodes

public void addHelperNodes(NodeInstance[] elements)

Appends an array of values to helperNodes

getHelperNodes

public NodeInstance getHelperNodes(int index)

Returns the element at the specified index. Returns null/-1 if the index was out of bounds.

setHelperNodes

public void setHelperNodes(int index,
                           NodeInstance value)

Set the value at the index specified.

insertHelperNodes

public void insertHelperNodes(int index,
                              NodeInstance value)

Insert the specified element at the specified index. If the index specified is greater than the index of the last element, then the value is appended to the existing array.

removeHelperNodes

public NodeInstance removeHelperNodes(int index)

Remove the element at the specified index and return it.

removeHelperNodesValue

public boolean removeHelperNodesValue(NodeInstance value)

Removes the given element from helperNodes. Returns true if the element was found.

clearHelperNodes

public void clearHelperNodes()

Clears all values from helperNodes

helperNodesContains

public boolean helperNodesContains(NodeInstance val)

Returns true if helperNodes contains the specified value.

helperNodesIndexOf

public int helperNodesIndexOf(NodeInstance val)

Return the index of the specified value in helperNodes, or -1 if not found.

sizeofHelperNodes

public int sizeofHelperNodes()

Returns the size of helperNodes. Returns -1 if helperNodes is null.

getHelperNodesFlag

public static boolean getHelperNodesFlag(int fieldflag)

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

getHelperNodesDefaultValue

public static NodeInstance[] getHelperNodesDefaultValue()

Default value for helperNodes. Returns new org.sandev.basics.structs.NodeInstance[0]

getHelperNodesElementInvalidValue

public static NodeInstance getHelperNodesElementInvalidValue()

Invalid value for helperNodeselement. Returns null

getHelperNodesInvalidValue

public static NodeInstance[] getHelperNodesInvalidValue()

Invalid value for helperNodes. Returns null

getHelperNodesRange

public java.lang.String getHelperNodesRange()

Return the range specification for this field

getHelperNodesValidityCheck

public java.lang.String getHelperNodesValidityCheck()

getHelperNodesMetatype

public java.lang.String getHelperNodesMetatype()

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.

getLogLevel

public int getLogLevel()

Accessor for logLevel

Specified by:: getLogLevel in interface NodeInstance

setLogLevel

public void setLogLevel(int logLevel)

Mutator for logLevel

Specified by:: setLogLevel in interface NodeInstance

logLevelValueToLabel

public java.lang.String logLevelValueToLabel(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.

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.

getLogLevelPrintVals

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

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.

getLogLevelKeyVals

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

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.

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.

init

public void init()

Initialize all fields to their default values

getShortName

public java.lang.String getShortName()

Returns the unqualified name of this message.

Specified by:: getShortName in interface SandMessage

getQueryMessage

public SandQueryMessage getQueryMessage()

Returns null

Specified by:: getQueryMessage in interface SandMessage

getCollectionMessage

public SandCollectionMessage getCollectionMessage()

Returns null

Specified by:: getCollectionMessage in interface SandMessage

getUpdateMessage

public SandUpdateMessage getUpdateMessage()

Returns null

Specified by:: getUpdateMessage in interface SandMessage

getStructMessage

public SandStructMessage getStructMessage()

Returns a new CacheManagerNodeInstance instance

Specified by:: getStructMessage in interface SandMessage

isEquivalent

public boolean isEquivalent(SandMessage sm)

Declared field equivalence check as specified by the SandMessage interface. String values are trimmed before comparison because conversions may occasionally result in trailing whitespace, which should not cause equivalence comparisons to fail. Comparisons are case insensitive since that corresponds to what most people expect, and how most databases work.

Specified by:: isEquivalent in interface SandMessage

generalModifier

public void generalModifier(int action,
                            java.lang.String field,
                            int index,
                            java.lang.Object val)
                     throws SandException

General mutator method. Specified by SandInstanceMessage interface.

Specified by:: generalModifier in interface SandInstanceMessage

Throws:: SandException

generalDereference

public SandAttrVal generalDereference(java.lang.String fieldspec)

General reference field accessor method. Specified by SandInstanceMessage interface.

Specified by:: generalDereference in interface SandInstanceMessage

generalAccessor

public java.lang.Object generalAccessor(java.lang.String fieldspec)

General field accessor method. Specified by SandInstanceMessage interface.

Specified by:: generalAccessor in interface SandInstanceMessage

getDisplayFields

public java.lang.String[] getDisplayFields()

Return an array of the summary field names for this class.

Specified by:: getDisplayFields in interface SandInstanceMessage

getDisplayValues

public java.lang.String[] getDisplayValues()

Return the values for the summary fields. The standard String representation of each value is returned. For Dates, the default DateFormat output is used. For enums, the print value is used. These can be further transformed as needed.

Specified by:: getDisplayValues in interface SandInstanceMessage

getDisplayValues

public java.lang.String[] getDisplayValues(IDLookup lookup,
                                           AuthUser user,
                                           java.lang.String defaultVal)

Return the values for the summary fields, including dereference expressions.

Specified by:: getDisplayValues in interface Resolvable

getValueForFieldName

public java.lang.String getValueForFieldName(java.lang.String fieldname,
                                             IDLookup lookup,
                                             AuthUser user,
                                             java.lang.String defaultVal)

Returns the print representation of the value of the specified field, or the given default value if innaccessible. A field value may be innaccessible due to authorization, null reference, or other call failure.

toString

public java.lang.String toString()

Return a string representation of this object. Uses the declared summary fields minus any dereference expressions.

getAllFields

public java.lang.String[] getAllFields()

Return an array of all fields for this class.

Specified by:: getAllFields in interface SandInstanceMessage

defaultField

public void defaultField(java.lang.String fieldname)

Set the specified field to its default value.

Specified by:: defaultField in interface SandInstanceMessage

cloneMessage

public SandInstanceMessage cloneMessage()

Calls cloneCacheManagerNodeInstance

Specified by:: cloneMessage in interface SandInstanceMessage

cloneCacheManagerNodeInstance

public CacheManagerNodeInstance cloneCacheManagerNodeInstance()

Make a deep copy of this CacheManagerNodeInstance. Creates a new instance and then calls copyDataFrom.

copyDataFrom

public void copyDataFrom(CacheManagerNodeInstance other)

Deep copy all the data from the specified instance. If the other instance is null then this method does nothing.

copyFieldValue

public void copyFieldValue(java.lang.String fieldName,
                           SandInstanceMessage other)

Copy the specified field from the given instance.

Specified by:: copyFieldValue in interface SandInstanceMessage

fieldValidate

public SandAttrVal[] fieldValidate(SandAttrVal[] checkFields)

Validate the fields as specified in the SandInstanceMessage interface

Specified by:: fieldValidate in interface SandInstanceMessage

fieldsValid

public boolean fieldsValid()

Validate the fields as specified in the SandInstanceMessage interface

Specified by:: fieldsValid in interface SandInstanceMessage

referenceValidate

public java.lang.String[] referenceValidate(java.lang.String[] locations,
                                            java.lang.String prefix,
                                            IDLookup idlookup,
                                            NameLookup namelookup,
                                            AuthUser au)
                                     throws SandException

Validate the references as specified in the Resolvable interface.

Specified by:: referenceValidate in interface Resolvable

Throws:: SandException

convertToSuperstructClass

public SandInstanceMessage convertToSuperstructClass()

Return a new instance of the message associated with the superstruct of this instance. Return null if the source struct for this message does not extend another struct.

Specified by:: convertToSuperstructClass in interface SandInstanceMessage

debugDump

public java.lang.String debugDump(java.lang.String prefix)

Dump this instance into a debug printable string.

Specified by:: debugDump in interface SandInstanceMessage

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 CacheManagerNodeInstance

nodeInstanceName

servername

helperNodes

incomingSyncCacheAction

outgoingAsyncCacheAction

incomingAsyncSandUpdateMessage

incomingAsyncCacheActionMessage

logLevel

LOGLEVEL_DEBUG

LOGLEVEL_INFO

LOGLEVEL_WARN

LOGLEVEL_ERROR

LOGLEVEL_FATAL

CacheManagerNodeInstance

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

getNodeInstanceName

setNodeInstanceName

setNodeInstanceName

getNodeInstanceNameFlag

getNodeInstanceNameLengthNorm

getNodeInstanceNameLengthMax

getNodeInstanceNameDefaultValue

getNodeInstanceNameInvalidValue

getNodeInstanceNamePrintValue

getNodeInstanceNameFieldPrintValue

getNodeInstanceNameRange

getNodeInstanceNameValidityCheck

getNodeInstanceNameMetatype

getServername

setServername

setServername

getServernameFlag

getServernameLengthNorm

getServernameLengthMax

getServernameDefaultValue

getServernameInvalidValue

getServernamePrintValue

getServernameFieldPrintValue

getServernameRange

resolveServernameReferenceNonCrit

org.sandev.basics.CacheManager
Class CacheManagerNodeInstance