DCNode (Oracle Communications Offline Mediation Controller Java API Reference)

java.lang.Object
- com.nt.udc.ndk.node.DCNode

All Implemented Interfaces:

AdminIfc, ConfigIfc, LoggerIfc, NodeHealthIfc, NodeStateManagementIfc, PropertyIfc, StateManagementIfc

Direct Known Subclasses:

EINode, MXAggregatorNode, OINode, PartitionedDCNode, ProcessorNode
```
public abstract class DCNode
extends java.lang.Object
implements AdminIfc, ConfigIfc, LoggerIfc, NodeHealthIfc, PropertyIfc, NodeStateManagementIfc
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.io.File`	`backupDir`
`protected ConfigIfc`	`config` An instance of a ConfigIfc class.
`protected java.lang.String`	`configClass`
`protected java.io.File`	`configDir`
`protected java.io.File`	`configFile`
`protected java.lang.String`	`configGUIClass`
`protected java.util.ArrayList<DCStreamHandler>`	`dcHandls`
`static long`	`DEFAULT_PROCESSING_INTERVAL`
`protected DCStreamHandler`	`fileMngr` The DCStreamHandler class manages all access to all streams/files that are used to transfer data between nodes.
`protected java.util.Timer`	`generalMonitoringTimer`
`protected boolean`	`inputMonitoringAlarmRaised`
`protected boolean`	`inputMonitoringEnabled`
`protected NARStreamHandler`	`inputMonitoringNARFileMgr`
`protected long`	`inputMonitoringPollingInterval`
`protected long`	`inputMonitoringPreviousCount`
`protected long`	`inputMonitoringSilenceCounter`
`protected long`	`inputMonitoringSilenceInterval`
`protected java.lang.String`	`inputMonitoringSilenceIntervalText`
`protected java.io.File`	`logDir`
`protected Logger`	`logger` An instance of a LoggerIfc class that will be used to write data to the log file.
`protected java.lang.String`	`majorType`
`protected java.lang.String`	`minorType`
`protected DCNodePerformance`	`node_pm`
`protected java.lang.String`	`nodeid`
`static java.lang.String`	`NODEINIT`
`static java.lang.String`	`NODERECONFIG`
`protected long`	`nodeStartTime` Time in millis that the node started
`protected static java.lang.String`	`nodeStateFileName`
`protected long`	`processingInterval` Time interval at which the node will check for data.
`protected boolean`	`reconfiguring` Indicates whether the node is being reconfigured
`protected boolean`	`savingStateOn`
`protected java.io.File`	`scratchDir`
`protected boolean`	`shutdown` Indicates whether the node is running
`protected StateManager`	`stateManager`
`protected java.io.File`	`suspenseDir`
`static java.lang.String`	`TRANSACTION_NAR_ID`
`protected java.io.File`	`udcHome`

Fields inherited from interface com.nt.udc.ndk.node.LoggerIfc
FC_CONFIGURATION, FC_CONNECTIVITY, FC_INITIALIZATION, FC_INTERNALERROR, FC_INVALIDDATA, FC_NODE_CONTROL, FC_RESOURCES, FC_SECURITY, FC_SERVER_CONTROL, FC_UNDEFINED, SF_CONF_CHANGE_ERROR, SF_CONF_CONFIG_FAIL, SF_CONF_ERR_NODE_CONF, SF_CONF_INV_FTP_CONF, SF_CONF_INV_NODE_CONF, SF_CONF_INV_PARAM, SF_CONF_INV_PARAM_VAL, SF_CONF_INV_REM_DIR, SF_CONF_MISSING_PARM, SF_CONF_MISSING_PARM2, SF_CONF_NM_CONF_ERROR, SF_CONF_NO_CONFIG, SF_CONF_NO_FTP_INT, SF_CONF_NODE_CREATION, SF_CONF_NODE_START, SF_CONF_NPL_CRITICAL, SF_CONF_NPL_ERROR, SF_CONF_READ_ERROR, SF_CONF_READ_PROPS, SF_CONF_SAVE_ERROR, SF_CONF_SOCKET_INIT, SF_CONF_VER_VALIDATION, SF_CONN_DB_CON_ERR, SF_CONN_DB_CON_LOST, SF_CONN_DEGRADED_ERR, SF_CONN_ECE_CON_ERR, SF_CONN_ERR_NODEINFO, SF_CONN_ERR_RCV_DATA, SF_CONN_ERR_SEND_ACK, SF_CONN_ERROR_TACHYON_USAGE, SF_CONN_FAILED_TO_RECEIVE_RESPONSE, SF_CONN_FILE_READ_ERR, SF_CONN_FTP_ERROR, SF_CONN_FTP_ERROR2, SF_CONN_FTP_LOGIN, SF_CONN_INTERFACING_CON_ERR, SF_CONN_INVALID_TACHYON_RECORD, SF_CONN_LDAP_CONNECT, SF_CONN_LOST_NM, SF_CONN_NM_API_ERR, SF_CONN_PDU_NULL, SF_CONN_POLL_ERR, SF_CONN_SNMP_SESS_OPEN_FAIL, SF_DATA_AGGR_ERROR, SF_DATA_ATTR_CREATE, SF_DATA_ATTR_PARSE, SF_DATA_ATTR_SHIFT, SF_DATA_CANNOT_ENCODE, SF_DATA_CANT_ACK, SF_DATA_CANT_ENCODE, SF_DATA_CONV_STR_TO_N, SF_DATA_CONV_TO_STR, SF_DATA_CONVERT_ATTR, SF_DATA_DATA_EXPIRED, SF_DATA_DATA_MISSING, SF_DATA_DATA_PROC_ERR, SF_DATA_ENCODE_ERR, SF_DATA_ERR_CREATE, SF_DATA_ERR_SEND_ACK, SF_DATA_ERROR_IN_NPL, SF_DATA_ERROR_ON_ACK, SF_DATA_FILE_DATA, SF_DATA_FILE_PROC_ERR, SF_DATA_FORMAT_ERROR, SF_DATA_IE_INVALID, SF_DATA_IE_MISSING, SF_DATA_INPUT_INVALID, SF_DATA_INV_ATT_TYPE, SF_DATA_INV_ATTR_NPL, SF_DATA_INV_RECORD, SF_DATA_INV_TRAF_VOL, SF_DATA_JDBC_DRIVER_ERR, SF_DATA_KEY_CREATE, SF_DATA_MISSING_ATTRS, SF_DATA_MSG_TOO_SMALL, SF_DATA_MSG_TYPE, SF_DATA_NAR_IS_NULL, SF_DATA_NO_DATA_FILE, SF_DATA_NO_OPT_IE, SF_DATA_REC_INCOMP, SF_DATA_RECORD_PROC, SF_DATA_RECORD_SAVE, SF_DATA_SRC_READ_ERR, SF_DATA_UNABLE_COMPLETE, SF_DATA_UNEXP_NAR, SF_DATA_UNEXPECTED, SF_DATA_VAL_NOT_FOUND, SF_DATA_WRONG_DECODER, SF_INIT_DB_CON_ERR, SF_INIT_DIR_CON_ERR, SF_INIT_IO_ERR, SF_INIT_LDM, SF_INIT_LDM_RUN, SF_INIT_NODE_CONFIG, SF_INIT_NODE_CREATION, SF_INIT_NODE_INIT, SF_INIT_NODE_START, SF_INIT_RDM, SF_INIT_RDM_RUN, SF_INIT_REG_ERROR, SF_INIT_RULE_LOAD_ERR, SF_INIT_SOCKET_CREATE, SF_INIT_SOCKET_INIT, SF_INT_ERR_ETRACE, SF_INT_ERR_EXCEPTION, SF_INT_ERR_EXPIRE_ERR, SF_INT_ERR_FIELD_NULL, SF_INT_ERR_PROC_ERR, SF_INT_ERR_SHUTDOWN, SF_NC_ERR_IN_NODE, SF_NC_ERR_MNG_SERVER, SF_NC_ERR_NODE_STATE, SF_NC_ERR_PROC_DATA, SF_NC_ERR_RESTARTING, SF_NC_ERR_STARTING, SF_NC_ERR_STOPPING, SF_NC_ERR_UNHEALTHY, SF_NC_NODE_CONF_ERROR, SF_NC_NODE_SHUTDOWN, SF_RES_CPU_MAJOR, SF_RES_CPU_MINOR, SF_RES_CPU_USAGE_ERR, SF_RES_DISK_CRITICAL, SF_RES_DISK_MINOR, SF_RES_DISK_STATUS, SF_RES_DISK_USAGE, SF_RES_ERR_DATA_READ, SF_RES_ERR_DATA_REM, SF_RES_ERR_DB_CLOSE, SF_RES_ERR_DB_OP, SF_RES_ERR_DEL_ENTRY, SF_RES_ERR_DIR_CLOSE, SF_RES_ERR_DIR_CREATE, SF_RES_ERR_DIR_DELETE, SF_RES_ERR_DIR_OPEN, SF_RES_ERR_DIR_PROC, SF_RES_ERR_DIR_READ, SF_RES_ERR_DIR_WRITE, SF_RES_ERR_ENT_CREATE, SF_RES_ERR_FILE_CLOSE, SF_RES_ERR_FILE_CREAT, SF_RES_ERR_FILE_DEL, SF_RES_ERR_FILE_MOVE, SF_RES_ERR_FILE_NAME, SF_RES_ERR_FILE_OPEN, SF_RES_ERR_FILE_PROC, SF_RES_ERR_FILE_READ, SF_RES_ERR_FILE_REN, SF_RES_ERR_FILE_WRITE, SF_RES_ERR_IN_TRANS, SF_RES_ERR_INST_CLASS, SF_RES_ERR_INST_REC, SF_RES_ERR_IO_ERR, SF_RES_ERR_OPEN_TRANS, SF_RES_ERR_READ_DU, SF_RES_ERR_SOCK_CLOSE, SF_RES_ERR_SOCK_CREAT, SF_RES_ERR_SOCK_OPEN, SF_RES_ERR_SOCK_WRITE, SF_RES_ERR_TABLE_ACC, SF_RES_ERR_TABLE_CLOS, SF_RES_ERR_TABLE_OPEN, SF_RES_ERR_TIMER_SCHED, SF_RES_ERR_USING_Q, SF_RES_IS_NULL, SF_RES_MEM_MAJOR, SF_RES_MEM_WARNING, SF_RES_NO_LICENSE, SF_RES_NODE_STATE_R, SF_RES_NODE_STATE_W, SF_SEC_NO_USER_AUTH, SF_SEC_USER_AUTH_FAIL, SF_SEC_USER_CFG_FAIL, SF_SRV_CNTRL, SF_UND_INTERRUPTED, SF_UND_SHUTDOWN_ERR

Fields inherited from interface com.nt.udc.ndk.node.PropertyIfc
ENVIRONMENT, RUNTIME

Constructor Summary

Constructors
Constructor and Description

DCNode()
Default Constructor; instantiates objects necessary to define the DCNodeTypeIfc methods.

DCNode(java.lang.String[] args)

Constructors
Constructor and Description
`DCNode()` Default Constructor; instantiates objects necessary to define the DCNodeTypeIfc methods.
`DCNode(java.lang.String[] args)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addNodeEventListener(NodeEventListener nodeEventListener)`
`void`	`backup()` Empty implementation
`void`	`clearStatus()` Clears the status table for the node
`void`	`clearStatus(StatusMessage sm)` RMI method that clears the worst status currently in existence for the node.
`void`	`clearStatus(java.lang.String faultCategory, java.lang.String specificFault)` Clears all log messages with a given fault category, and specific fault type.
`void`	`createCounters(java.lang.String nodeID)` Constructor for the class used to instantiate all objects needed by this node.
`ReadOnlyStatisticsMonitorIfc`	`getAndResetRecordStatistics()` Retrieves record statistics for this node.
`java.io.File`	`getBackupDir()` Returns the node's backup directory.
`ConfigIfc`	`getConfig()` Returns the node's configuration Object.
`java.lang.String`	`getConfigDataClass()`
`abstract java.lang.String`	`getConfigDataGuiClass()`
`java.io.File`	`getConfigDir()` Returns the node's configuration directory.
`java.io.File`	`getConfigFile()` Returns the node's configuration file.
`DCNodeTypeIfc`	`getDCNodeType()`
`DCStreamHandler`	`getDCStreamHandler()` Returns the DCStreamHandler object that this node is using for inter-node communication.
`DCStreamHandler`	`getDCStreamHandler(int i)`
`DiscardedStatisticsMonitorIfc`	`getDiscardedStatsProcessor()`
`java.lang.String`	`getDisplayString()`
`DuplicateStatisticsMonitorIfc`	`getDuplicateStatsProcessor()`
`java.io.File`	`getHomeDir()` Returns the node's home directory.
`InputStatisticsMonitorIfc`	`getInputStatsProcessor()` Get the input record Statistics Monitor.
`java.lang.String`	`getItem(java.lang.String key)` Retreives a configuration value for this node for the given key
`java.io.File`	`getLogDir()` Returns the node's log directory.
`LoggerIfc`	`getLogger()` Returns the node's logger.
`abstract java.lang.String`	`getMajorType()`
`abstract java.lang.String`	`getMinorType()`
`java.lang.String`	`getNodeClass()`
`java.util.List`	`getNodeEventListeners()`
`java.lang.String`	`getNodeId()` Returns Node's ID
`StateManager`	`getNodeStateManager()` Returns the Node's StateManager object.
`OutputStatisticsMonitorIfc`	`getOutputStatsProcessor()` Get the output record Statistics Monitor.
`DCNodePerformanceIfc`	`getPerformanceMetrics()` Returns the stream handler's node performance object
`java.lang.String`	`getProperty(java.lang.String type, java.lang.String key)` Retrieves the property value for the specified type and key.
`java.lang.String[]`	`getPropertyKeys(java.lang.String type)` Retrieve a list of 'property keys' for the given type subset.
`java.lang.String[]`	`getPropertyTypes()` Retrieve a list of 'property type' subsets.
`java.lang.String`	`getRejectTransactionId()`
`java.io.File`	`getScratchDir()` Returns the node's scratch directory.
`StateManagementType`	`getStateManagementType()` Returns the type of state management this node is using.
`StateManager`	`getStateManager()` Returns the Node's StateManager object.
`StatusMessage`	`getStatus()` RMI call that returns the most recent worst status that currently exists for the node.
`StoredStatisticsMonitorIfc`	`getStoredStatsProcessor()`
`DCStreamHandler`	`getStreamHandler()` Returns the node's stream handler.
`DCStreamHandler`	`getStreamHandler(int i)`
`java.io.File`	`getSuspenseDir()` Returns the node's suspense directory.
`void`	`initialize()`
`void`	`inputMonitoringCallback()` Default behaviour is to check the NARFileManager's input to see if anything has changed, and either raise or clear the Silent Input alarm.
`long`	`inputMonitoringPollInputCounter()`
`boolean`	`isDebugEnabled()`
`boolean`	`isHealthy()` This method is part of the NodeHealthIfc interface.
`boolean`	`isInfoEnabled()`
`boolean`	`isNodeStateImplemented()` Returns whether the derived node can save and restore its state.
`boolean`	`isNodeStateUsed()` Returns whether the node state is used (and whether the node can be recovered.)
`boolean`	`isReconfigPending()` RMI call that indicates if a reconfigure operation is pending in an DC process.
`protected boolean`	`isReconfiguring()` Indicates whether the node is being reconfigured for warm restart.
`boolean`	`isRejectTransaction()`
`protected boolean`	`isShutdown()` Indicates whether the node is running, by returning the value of `shutdown`
`boolean`	`isStateUsed()` Returns whether the node state is used (and whether the node can be recovered.)
`void`	`logCritical(java.lang.String faultCategory, java.lang.String specificFault, java.lang.String additionalFaultText, java.lang.Exception exception)` Logs a Critical Error message (which is indicated with a red alarm) with the given text.
`void`	`logDebug(java.lang.String message, java.lang.Exception exception)`
`void`	`logError(java.lang.String message, boolean autoClear, java.lang.Exception exception)` Do NOT use this method for Release 3.3 or later.
`void`	`logInfo(java.lang.String message, java.lang.Exception exception)` Logs an informational message (no alarm is generated)
`void`	`logMajor(java.lang.String faultCategory, java.lang.String specificFault, java.lang.String additionalFaultText, java.lang.Exception exception)` Logs a Major Error message (which is indicated with a Orange alarm) with the given text.
`void`	`logMinor(java.lang.String faultCategory, java.lang.String specificFault, java.lang.String additionalFaultText, java.lang.Exception exception)` Logs a Minor Error message (which is indicated with a yellow alarm) with the given text.
`void`	`logTrace(java.lang.String message, java.lang.Exception exception)` Logs a trace message (no alarm is generated).
`void`	`logWarning(java.lang.String message, boolean autoClear, java.lang.Exception exception)` Do NOT use this method for Release 3.3 or later.
`void`	`logWarning(java.lang.String faultCategory, java.lang.String specificFault, java.lang.String additionalFaultText, java.lang.Exception exception)` Logs a Warning message (which is indicated with a blue alarm) with the given text.
`void`	`reconfigure()` Call that reconfigures a DC node process.
`void`	`registerThreadForHealthMonitoring(java.lang.Thread t)` This method is part of the NodeHealthIfc interface.
`void`	`rejectTransaction(java.lang.String transactionId)`
`void`	`restoreState()` Tells the Node to restore its state from disk.
`void`	`saveState()` Tells the Node to save its state to disk.
`void`	`saveState(Callback stateFinishedCallback)` Tells the Node to save its state to disk.
`void`	`setConfig(ConfigIfc c)` Sets the node's configuration Object.
`void`	`setDCStreamHandler(DCStreamHandler handler)` Sets the DCStreamHandler object that this node is using for inter-node communication.
`void`	`setDCStreamHandler(DCStreamHandler handler, int i)`
`protected void`	`setIsReconfiguringFlag(boolean value)` Set value of `reconfiguring` flag to true or false.
`void`	`setItem(java.lang.String key, java.lang.String value)` Sets a configuration value for this node with the given key
`void`	`setProperty(java.lang.String type, java.lang.String key, java.lang.String value)` Set the property value for the specified type and key.
`protected void`	`setSNMPTrapGenerator(SnmpTrapSenderIfc stg)` This method allows the node to set it's SNMP Trap Generator, so that when severe messages are sent to the logger they can be sent to SNMP Trap Hosts that are listening.
`void`	`setStreamHandler(DCStreamHandler sh)` Sets the node's stream handler.
`void`	`setStreamHandler(DCStreamHandler sh, int i)`
`void`	`shutdown()` Performs all necessary functions to stop this node and any processes that it has created.
`protected void`	`shutdownDCStreamHandler()` Shutdown the DCStreamHandler.
`protected void`	`shuttingDown()` This method is should be overridden if a particular derived node needs to do some processing just prior to the node being shut down.
`void`	`startup()` Call that starts a node.
`void`	`unregisterThreadFromHealthMonitoring(java.lang.Thread t)` This method is part of the NodeHealthIfc interface.
`boolean`	`warmRestartImplemented()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_PROCESSING_INTERVAL
```
public static final long DEFAULT_PROCESSING_INTERVAL
```
    See Also:
    
    Constant Field Values
  - logger
```
protected Logger logger
```
    An instance of a LoggerIfc class that will be used to write data to the log file.
  - config
```
protected ConfigIfc config
```
    An instance of a ConfigIfc class. When instantiated, this class reads the configuration file that is sent as an argument to this program and stores all the configuration parameters in the file. The generated configuation table is sent to all other data collector functions as constructor parameters.
  - fileMngr
```
protected DCStreamHandler fileMngr
```
    The DCStreamHandler class manages all access to all streams/files that are used to transfer data between nodes.
    Currently, this provides file management capabilities.
  - dcHandls
```
protected java.util.ArrayList<DCStreamHandler> dcHandls
```
  - processingInterval
```
protected long processingInterval
```
    Time interval at which the node will check for data. Default is 20 seconds.
  - udcHome
```
protected java.io.File udcHome
```
  - configFile
```
protected java.io.File configFile
```
  - configDir
```
protected java.io.File configDir
```
  - scratchDir
```
protected java.io.File scratchDir
```
  - backupDir
```
protected java.io.File backupDir
```
  - logDir
```
protected java.io.File logDir
```
  - suspenseDir
```
protected java.io.File suspenseDir
```
  - nodeid
```
protected java.lang.String nodeid
```
  - majorType
```
protected java.lang.String majorType
```
  - minorType
```
protected java.lang.String minorType
```
  - configClass
```
protected java.lang.String configClass
```
  - configGUIClass
```
protected java.lang.String configGUIClass
```
  - shutdown
```
protected boolean shutdown
```
    Indicates whether the node is running
  - nodeStartTime
```
protected long nodeStartTime
```
    Time in millis that the node started
  - reconfiguring
```
protected boolean reconfiguring
```
    Indicates whether the node is being reconfigured
  - node_pm
```
protected DCNodePerformance node_pm
```
  - NODEINIT
```
public static final java.lang.String NODEINIT
```
  - NODERECONFIG
```
public static final java.lang.String NODERECONFIG
```
  - savingStateOn
```
protected boolean savingStateOn
```
  - stateManager
```
protected StateManager stateManager
```
  - nodeStateFileName
```
protected static java.lang.String nodeStateFileName
```
  - inputMonitoringEnabled
```
protected boolean inputMonitoringEnabled
```
  - inputMonitoringSilenceInterval
```
protected long inputMonitoringSilenceInterval
```
  - generalMonitoringTimer
```
protected java.util.Timer generalMonitoringTimer
```
  - inputMonitoringAlarmRaised
```
protected boolean inputMonitoringAlarmRaised
```
  - inputMonitoringPreviousCount
```
protected long inputMonitoringPreviousCount
```
  - inputMonitoringNARFileMgr
```
protected NARStreamHandler inputMonitoringNARFileMgr
```
  - inputMonitoringPollingInterval
```
protected long inputMonitoringPollingInterval
```
  - inputMonitoringSilenceCounter
```
protected long inputMonitoringSilenceCounter
```
  - inputMonitoringSilenceIntervalText
```
protected java.lang.String inputMonitoringSilenceIntervalText
```
  - TRANSACTION_NAR_ID
```
public static final java.lang.String TRANSACTION_NAR_ID
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DCNode
```
public DCNode()
```
    Default Constructor; instantiates objects necessary to define the DCNodeTypeIfc methods.
  - DCNode
```
public DCNode(java.lang.String[] args)
       throws NodeStartException
```
    Throws:
    
    NodeStartException
- Method Detail
  - createCounters
```
public void createCounters(java.lang.String nodeID)
```
    Constructor for the class used to instantiate all objects needed by this node. Sets up directory space for this node under the following directories below udcHome :
        /backup
        /config
        /log
        /scratch
    
    Parameters:
    
    args - Values are as follows:
       arg[0]    Numeric identifier for this node.    arg[1]    Directory location for the UDC installation (udcHome). All sub-directories created for the node will reside below this directory.    arg[2]    Location of this node's Configuration file
  - initialize
```
public void initialize()
                throws NodeStartException
```
    Specified by:
    
    initialize in interface AdminIfc
    
    Throws:
    
    NodeStartException
  - addNodeEventListener
```
public void addNodeEventListener(NodeEventListener nodeEventListener)
```
  - getNodeEventListeners
```
public java.util.List getNodeEventListeners()
```
  - getDCNodeType
```
public DCNodeTypeIfc getDCNodeType()
```
  - getLogger
```
public LoggerIfc getLogger()
```
    Returns the node's logger.
  - setConfig
```
public void setConfig(ConfigIfc c)
```
    Sets the node's configuration Object.
  - getConfig
```
public ConfigIfc getConfig()
```
    Returns the node's configuration Object.
  - setStreamHandler
```
public void setStreamHandler(DCStreamHandler sh)
```
    Sets the node's stream handler.
  - setStreamHandler
```
public void setStreamHandler(DCStreamHandler sh,
                             int i)
```
  - getStreamHandler
```
public DCStreamHandler getStreamHandler()
```
    Returns the node's stream handler.
  - getStreamHandler
```
public DCStreamHandler getStreamHandler(int i)
```
  - getHomeDir
```
public java.io.File getHomeDir()
```
    Returns the node's home directory.
  - getConfigFile
```
public java.io.File getConfigFile()
```
    Returns the node's configuration file.
  - getConfigDir
```
public java.io.File getConfigDir()
```
    Returns the node's configuration directory.
  - getScratchDir
```
public java.io.File getScratchDir()
```
    Returns the node's scratch directory.
  - getBackupDir
```
public java.io.File getBackupDir()
```
    Returns the node's backup directory.
  - getSuspenseDir
```
public java.io.File getSuspenseDir()
```
    Returns the node's suspense directory.
  - getLogDir
```
public java.io.File getLogDir()
```
    Returns the node's log directory.
  - backup
```
public void backup()
```
    Empty implementation
  - getNodeId
```
public java.lang.String getNodeId()
```
    Returns Node's ID
    
    Returns:
    
    null
  - getPerformanceMetrics
```
public DCNodePerformanceIfc getPerformanceMetrics()
```
    Returns the stream handler's node performance object
    
    Specified by:
    
    getPerformanceMetrics in interface AdminIfc
    
    Returns:
    
    DCNodePerformanceIfc object
  - shutdown
```
public void shutdown()
```
    Performs all necessary functions to stop this node and any processes that it has created.
    
    Specified by:
    
    shutdown in interface AdminIfc
  - clearStatus
```
public void clearStatus()
```
    Clears the status table for the node
    
    Specified by:
    
    clearStatus in interface AdminIfc
    
    Specified by:
    
    clearStatus in interface LoggerIfc
  - clearStatus
```
public void clearStatus(StatusMessage sm)
```
    RMI method that clears the worst status currently in existence for the node.
  - getStatus
```
public StatusMessage getStatus()
```
    RMI call that returns the most recent worst status that currently exists for the node.
    
    Specified by:
    
    getStatus in interface AdminIfc
    
    Returns:
    
    StatusMessage reflecting the most recent, worst status for this node.
  - reconfigure
```
public void reconfigure()
                 throws NodeStartException
```
    Call that reconfigures a DC node process. This method performs node reconfiguration processing specific to a DCNode object. Derived classes that need to perform their own reconfiguration processing should override reconfigure() and then call this method from there. This method sets a flag indicating this node is in the reconfiguration state. The most derived class should use the setIsReconfiguringFlag method just before returning from its reconfigure() method to set the reconfiguration state to false.
    
    Specified by:
    
    reconfigure in interface AdminIfc
    
    Throws:
    
    NodeStartException
  - startup
```
public void startup()
             throws NodeStartException
```
    Call that starts a node. This method performs startup processing specific to a DCNode object. Derived classes that need to perform their own startup processing should override startup() and then call this method first from there.
    
    Specified by:
    
    startup in interface AdminIfc
    
    Throws:
    
    NodeStartException
  - isReconfigPending
```
public boolean isReconfigPending()
```
    RMI call that indicates if a reconfigure operation is pending in an DC process. Empty method.
    
    Returns:
    
    false
  - getItem
```
public java.lang.String getItem(java.lang.String key)
```
    Retreives a configuration value for this node for the given key
    
    Specified by:
    
    getItem in interface ConfigIfc
    
    Parameters:
    
    key - String name of the desired configuration parameter value
    
    Returns:
    
    Value for the given key, null if the value could not be found, or the key does not exist.
  - setItem
```
public void setItem(java.lang.String key,
                    java.lang.String value)
```
    Sets a configuration value for this node with the given key
    
    Specified by:
    
    setItem in interface ConfigIfc
    
    Parameters:
    
    key - String name of the desired configuration parameter value
    
    value - value to store
  - getProperty
```
public java.lang.String getProperty(java.lang.String type,
                                    java.lang.String key)
```
    Retrieves the property value for the specified type and key.
    
    Specified by:
    
    getProperty in interface PropertyIfc
    
    Parameters:
    
    type - A String indicating the subset to which the property belongs (i.e. environment, runtime, etc.)
    
    key - A String indicating the specific property to be retrieved
    
    Returns:
    
    The value of the specified property, or null if the property has not been set
  - getPropertyTypes
```
public java.lang.String[] getPropertyTypes()
```
    Retrieve a list of 'property type' subsets.
    
    Specified by:
    
    getPropertyTypes in interface PropertyIfc
    
    Returns:
    
    A String[] of the various 'types' of properties
  - getPropertyKeys
```
public java.lang.String[] getPropertyKeys(java.lang.String type)
```
    Retrieve a list of 'property keys' for the given type subset.
    
    Specified by:
    
    getPropertyKeys in interface PropertyIfc
    
    Returns:
    
    A String[] containing the various 'keys' for the given type
  - setProperty
```
public void setProperty(java.lang.String type,
                        java.lang.String key,
                        java.lang.String value)
                 throws java.lang.IllegalArgumentException
```
    Set the property value for the specified type and key.
    
    Specified by:
    
    setProperty in interface PropertyIfc
    
    Parameters:
    
    type - A String indicating the subset the property to which the property belongs (i.e. init, runtime, etc.)
    
    key - A String indicating the specific property to be set
    
    value - The value of the property to be set. A null value will cause the current property to be unset.
    
    Throws:
    
    java.lang.IllegalArgumentException - if type or key is null
  - logError
```
public void logError(java.lang.String message,
                     boolean autoClear,
                     java.lang.Exception exception)
```
    Description copied from interface: LoggerIfc
    
    Do NOT use this method for Release 3.3 or later. Logs an Error message (which is indicated with a red alarm) with the given text and clearing capabilities.
    
    Specified by:
    
    logError in interface LoggerIfc
    
    Parameters:
    
    autoClear - if true, this message will clear any previous alarm in the system, otherwise a red alarm and an error message will be logged.
    
    exception - The exception which causes this alarm.
    
    message - Desired text for the error message to be written into the log file.
    
    See Also:
    
    LoggerIfc.logCritical(java.lang.String, java.lang.String, java.lang.String, java.lang.Exception), LoggerIfc.logMajor(java.lang.String, java.lang.String, java.lang.String, java.lang.Exception)
  - logWarning
```
public void logWarning(java.lang.String message,
                       boolean autoClear,
                       java.lang.Exception exception)
```
    Description copied from interface: LoggerIfc
    
    Do NOT use this method for Release 3.3 or later. Logs a Warning message (which is indicated with a yellow alarm) with the given text and clearing capabilities
    
    Specified by:
    
    logWarning in interface LoggerIfc
    
    Parameters:
    
    autoClear - if true, this message will clear any previous alarm in the system, otherwise a yellow alarm and an warning message will be logged.
    
    exception - The exception which causes this alarm.
    
    message - Desired text for the error message to be written into the log file.
    
    See Also:
    
    LoggerIfc.logMinor(java.lang.String, java.lang.String, java.lang.String, java.lang.Exception), LoggerIfc.logWarning(java.lang.String, java.lang.String, java.lang.String, java.lang.Exception)
  - logInfo
```
public void logInfo(java.lang.String message,
                    java.lang.Exception exception)
```
    Description copied from interface: LoggerIfc
    
    Logs an informational message (no alarm is generated)
    
    Specified by:
    
    logInfo in interface LoggerIfc
    
    Parameters:
    
    message - Desired text for the error message to be written into the log file.
    
    exception - The exception which causes this alarm
  - isDebugEnabled
```
public boolean isDebugEnabled()
```
    Specified by:
    
    isDebugEnabled in interface LoggerIfc
  - isInfoEnabled
```
public boolean isInfoEnabled()
```
    Specified by:
    
    isInfoEnabled in interface LoggerIfc
  - logDebug
```
public void logDebug(java.lang.String message,
                     java.lang.Exception exception)
```
    Specified by:
    
    logDebug in interface LoggerIfc
  - logTrace
```
public void logTrace(java.lang.String message,
                     java.lang.Exception exception)
```
    Description copied from interface: LoggerIfc
    
    Logs a trace message (no alarm is generated). This message will only be written out if the debugLevel is set appropriately via the node's configuration at runtime.
    
    Specified by:
    
    logTrace in interface LoggerIfc
    
    Parameters:
    
    message - Desired text for the error message to be written into the log file.
    
    exception - The exception which causes this exception
  - logCritical
```
public void logCritical(java.lang.String faultCategory,
                        java.lang.String specificFault,
                        java.lang.String additionalFaultText,
                        java.lang.Exception exception)
```
    Description copied from interface: LoggerIfc
    
    Logs a Critical Error message (which is indicated with a red alarm) with the given text. The Critical severity level indicates that a service affecting condition has occurred and an immediate corrective action is required. Such a severity can be reported, for example, when a managed object becomes totally out of service and its capability must be restored.
    
    Specified by:
    
    logCritical in interface LoggerIfc
    
    Parameters:
    
    faultCategory - A general category of the error. One of Initialization, Configuration, Connectivity Invalid data, Resources, Internal Error
    
    specificFault - A clearly worded description of this fault condition, with NO variable component (i.e. node names, port numbers, time stamps, etc.).
    
    additionalFaultText - Any desirable additional text. The variable information.
    
    exception - exception which causes this critical issue.
  - logMajor
```
public void logMajor(java.lang.String faultCategory,
                     java.lang.String specificFault,
                     java.lang.String additionalFaultText,
                     java.lang.Exception exception)
```
    Description copied from interface: LoggerIfc
    
    Logs a Major Error message (which is indicated with a Orange alarm) with the given text. The Major severity level indicates that a service affecting condition has developed and an urgent corrective action is required. Such a severity can be reported, for example, when there is a severe degradation in the capability of the managed object and its full capability must be restored.
    
    Specified by:
    
    logMajor in interface LoggerIfc
    
    Parameters:
    
    faultCategory - A general category of the error. One of Initialization, Configuration, Connectivity Invalid data, Resources, Internal Error
    
    specificFault - A clearly worded description of this fault condition, with NO variable component (i.e. node names, port numbers, time stamps, etc.).
    
    additionalFaultText - Any desirable additional text. The variable information.
    
    exception - Exception which causes this major issue.
  - logMinor
```
public void logMinor(java.lang.String faultCategory,
                     java.lang.String specificFault,
                     java.lang.String additionalFaultText,
                     java.lang.Exception exception)
```
    Description copied from interface: LoggerIfc
    
    Logs a Minor Error message (which is indicated with a yellow alarm) with the given text. The Minor severity level indicates the existence of a non-service affecting fault condition and that corrective action should be taken in order to prevent a more serious (for example, service affecting) fault. Such a severity can be reported, for example, when the detected alarm condition is not currently degrading the capacity of the managed object.
    
    Specified by:
    
    logMinor in interface LoggerIfc
    
    Parameters:
    
    faultCategory - A general category of the error. One of Initialization, Configuration, Connectivity Invalid data, Resources, Internal Error
    
    specificFault - A clearly worded description of this fault condition, with NO variable component (i.e. node names, port numbers, time stamps, etc.).
    
    additionalFaultText - Any desirable additional text. The variable information.
    
    exception - Exception which causes this minor issue
  - logWarning
```
public void logWarning(java.lang.String faultCategory,
                       java.lang.String specificFault,
                       java.lang.String additionalFaultText,
                       java.lang.Exception exception)
```
    Description copied from interface: LoggerIfc
    
    Logs a Warning message (which is indicated with a blue alarm) with the given text. The Warning severity level indicates the detection of a potential or impending service affecting fault, before any significant effects have been felt. Action should be taken to further diagnose (if necessary) and correct the problem in order to prevent it from becoming a more serious service affecting fault.
    
    Specified by:
    
    logWarning in interface LoggerIfc
    
    Parameters:
    
    faultCategory - A general category of the error. One of Initialization, Configuration, Connectivity Invalid data, Resources, Internal Error
    
    specificFault - A clearly worded description of this fault condition, with NO variable component (i.e. node names, port numbers, time stamps, etc.).
    
    additionalFaultText - Any desirable additional text. The variable information.
    
    exception - Exception which causes this warning
  - clearStatus
```
public void clearStatus(java.lang.String faultCategory,
                        java.lang.String specificFault)
```
    Description copied from interface: LoggerIfc
    
    Clears all log messages with a given fault category, and specific fault type.
    
    Specified by:
    
    clearStatus in interface LoggerIfc
  - getMajorType
```
public abstract java.lang.String getMajorType()
```
  - getMinorType
```
public abstract java.lang.String getMinorType()
```
  - getConfigDataGuiClass
```
public abstract java.lang.String getConfigDataGuiClass()
```
  - getConfigDataClass
```
public java.lang.String getConfigDataClass()
```
    Returns:
    
    "com.nt.udc.ndk.gui.DCNodeConfigData"
  - getDisplayString
```
public final java.lang.String getDisplayString()
```
    Returns:
    
    Values of getMajorType() and getMinorType() separated by a colon.
  - getNodeClass
```
public final java.lang.String getNodeClass()
```
    Returns:
    
    Value of getClass().getName()
  - warmRestartImplemented
```
public boolean warmRestartImplemented()
```
    Returns:
    
    boolean indicating if the node implements a warm restart capability
  - setDCStreamHandler
```
public void setDCStreamHandler(DCStreamHandler handler)
```
    Sets the DCStreamHandler object that this node is using for inter-node communication.
    
    Parameters:
    
    handler - DCStreamHandler that this node should use
  - setDCStreamHandler
```
public void setDCStreamHandler(DCStreamHandler handler,
                               int i)
```
  - getDCStreamHandler
```
public DCStreamHandler getDCStreamHandler()
```
    Returns the DCStreamHandler object that this node is using for inter-node communication.
    
    Returns:
    
    DCStreamHandler that this node should use
  - getDCStreamHandler
```
public DCStreamHandler getDCStreamHandler(int i)
```
  - saveState
```
public void saveState(Callback stateFinishedCallback)
```
    Tells the Node to save its state to disk.
    
    Specified by:
    
    saveState in interface StateManagementIfc
    
    Parameters:
    
    stateFinishedCallback - An Object to notify when the state has been successfully saved.
  - saveState
```
public void saveState()
```
    Tells the Node to save its state to disk.
    
    Specified by:
    
    saveState in interface StateManagementIfc
  - restoreState
```
public void restoreState()
```
    Tells the Node to restore its state from disk.
    
    Specified by:
    
    restoreState in interface StateManagementIfc
  - isNodeStateUsed
```
public boolean isNodeStateUsed()
```
    Returns whether the node state is used (and whether the node can be recovered.)
    
    Specified by:
    
    isNodeStateUsed in interface NodeStateManagementIfc
    
    Returns:
    
    true, if node state is being used
  - isStateUsed
```
public boolean isStateUsed()
```
    Returns whether the node state is used (and whether the node can be recovered.)
    
    Specified by:
    
    isStateUsed in interface StateManagementIfc
    
    Returns:
    
    true, if node state is being used
  - getStateManagementType
```
public StateManagementType getStateManagementType()
```
    Returns the type of state management this node is using.
    
    Specified by:
    
    getStateManagementType in interface StateManagementIfc
    
    Returns:
    
    appropriate StateManagementType
  - getNodeStateManager
```
public StateManager getNodeStateManager()
```
    Returns the Node's StateManager object.
    
    Specified by:
    
    getNodeStateManager in interface NodeStateManagementIfc
    
    Returns:
    
    StateManager object
  - getStateManager
```
public StateManager getStateManager()
```
    Returns the Node's StateManager object.
    
    Specified by:
    
    getStateManager in interface StateManagementIfc
    
    Returns:
    
    StateManager object
  - isNodeStateImplemented
```
public boolean isNodeStateImplemented()
```
    Returns whether the derived node can save and restore its state.
    
    Returns:
    
    true, if node implements node state save and restore
  - isShutdown
```
protected boolean isShutdown()
```
    Indicates whether the node is running, by returning the value of shutdown
    
    Returns:
    
    True, if the node has been stopped.
  - shuttingDown
```
protected void shuttingDown()
```
    This method is should be overridden if a particular derived node needs to do some processing just prior to the node being shut down. Default implementation does nothing.
  - setSNMPTrapGenerator
```
protected void setSNMPTrapGenerator(SnmpTrapSenderIfc stg)
```
    This method allows the node to set it's SNMP Trap Generator, so that when severe messages are sent to the logger they can be sent to SNMP Trap Hosts that are listening.
    
    Parameters:
    
    stg - The Snmp_Trap_APIInterface implementation that is being used to send SNMP traps.
  - isReconfiguring
```
protected boolean isReconfiguring()
```
    Indicates whether the node is being reconfigured for warm restart.
    
    Returns:
    
    True, if the node is being reconfigured for warm restart.
  - setIsReconfiguringFlag
```
protected void setIsReconfiguringFlag(boolean value)
```
    Set value of reconfiguring flag to true or false. This method is provided to allow derived classes to have control over when the node is in the state of being reconfigured.
  - shutdownDCStreamHandler
```
protected void shutdownDCStreamHandler()
```
    Shutdown the DCStreamHandler. The DCStreamHandler should continue to run until all data has been received, and processed, from the FieldProcessor.
  - isHealthy
```
public boolean isHealthy()
```
    This method is part of the NodeHealthIfc interface. It is to be sub-classed by children to account for node-specific criteria of determining a node's state of health.
    
    Specified by:
    
    isHealthy in interface NodeHealthIfc
    
    Returns:
    
    true if the node is fully functional (healthy), false otherwise
  - registerThreadForHealthMonitoring
```
public void registerThreadForHealthMonitoring(java.lang.Thread t)
```
    This method is part of the NodeHealthIfc interface. It is called to register a node for health monitoring.
    
    Specified by:
    
    registerThreadForHealthMonitoring in interface NodeHealthIfc
  - unregisterThreadFromHealthMonitoring
```
public void unregisterThreadFromHealthMonitoring(java.lang.Thread t)
```
    This method is part of the NodeHealthIfc interface. It is called to unregister a node from health monitoring.
    
    Specified by:
    
    unregisterThreadFromHealthMonitoring in interface NodeHealthIfc
  - inputMonitoringCallback
```
public void inputMonitoringCallback()
```
    Default behaviour is to check the NARFileManager's input to see if anything has changed, and either raise or clear the Silent Input alarm. May be overridden by subclasses to do something else.
  - inputMonitoringPollInputCounter
```
public long inputMonitoringPollInputCounter()
```
  - getInputStatsProcessor
```
public InputStatisticsMonitorIfc getInputStatsProcessor()
```
    Get the input record Statistics Monitor.
    
    Returns:
  - getOutputStatsProcessor
```
public OutputStatisticsMonitorIfc getOutputStatsProcessor()
```
    Get the output record Statistics Monitor.
    
    Returns:
  - getStoredStatsProcessor
```
public StoredStatisticsMonitorIfc getStoredStatsProcessor()
```
  - getDuplicateStatsProcessor
```
public DuplicateStatisticsMonitorIfc getDuplicateStatsProcessor()
```
  - getDiscardedStatsProcessor
```
public DiscardedStatisticsMonitorIfc getDiscardedStatsProcessor()
```
  - getAndResetRecordStatistics
```
public ReadOnlyStatisticsMonitorIfc getAndResetRecordStatistics()
```
    Description copied from interface: AdminIfc
    
    Retrieves record statistics for this node. (Record statistics are different from performance information, in that the record statistics get reset to 0 periodically, usually every hour.)
    
    Specified by:
    
    getAndResetRecordStatistics in interface AdminIfc
    
    Returns:
    
    An object that contains the statistics for the previous polling period.
  - rejectTransaction
```
public void rejectTransaction(java.lang.String transactionId)
```
  - isRejectTransaction
```
public boolean isRejectTransaction()
```
  - getRejectTransactionId
```
public java.lang.String getRejectTransactionId()
```

Class DCNode

Field Summary

Fields inherited from interface com.nt.udc.ndk.node.LoggerIfc

Fields inherited from interface com.nt.udc.ndk.node.PropertyIfc

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_PROCESSING_INTERVAL

logger

config

fileMngr

dcHandls

processingInterval

udcHome

configFile

configDir

scratchDir

backupDir

logDir

suspenseDir

nodeid

majorType

minorType

configClass

configGUIClass

shutdown

nodeStartTime

reconfiguring

node_pm

NODEINIT

NODERECONFIG

savingStateOn

stateManager

nodeStateFileName

inputMonitoringEnabled

inputMonitoringSilenceInterval

generalMonitoringTimer

inputMonitoringAlarmRaised

inputMonitoringPreviousCount

inputMonitoringNARFileMgr

inputMonitoringPollingInterval

inputMonitoringSilenceCounter

inputMonitoringSilenceIntervalText

TRANSACTION_NAR_ID

Constructor Detail

DCNode

DCNode

Method Detail

createCounters

initialize

addNodeEventListener

getNodeEventListeners

getDCNodeType

getLogger

setConfig

getConfig

setStreamHandler

setStreamHandler

getStreamHandler

getStreamHandler

getHomeDir

getConfigFile

getConfigDir

getScratchDir

getBackupDir

getSuspenseDir

getLogDir

backup

getNodeId

getPerformanceMetrics

shutdown

clearStatus

clearStatus

getStatus

reconfigure

startup

isReconfigPending

getItem

setItem