DCNodeConfigData (Oracle Communications Offline Mediation Controller Java API Reference)

java.lang.Object
- com.nt.udc.ndk.gui.DCNodeConfigData

All Implemented Interfaces:

ConfigIfc, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

FtpEIConfigData, FtpFileEIConfigData, SoapXmlEIConfigData
```
public class DCNodeConfigData
extends java.lang.Object
implements ConfigIfc, java.io.Serializable, java.lang.Cloneable
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ASCODEBASE`
`static java.lang.String`	`BACKUP`
`static java.lang.String`	`BULKIO`
`protected java.util.Hashtable`	`configFiles` Hashtable containing byte arrays representing secondary configuration files.
`static java.lang.String`	`DATAFILESIZE`
`static java.lang.String`	`DEBUG`
`protected boolean`	`dirtyFlag` True, if a value has changed
`static java.lang.String`	`EXPCHANOPERATOR`
`static java.lang.String`	`EXPCHANVALUE`
`static java.lang.String`	`EXPCHANVALUE2`
`static java.lang.String`	`FILELEVELTRANSACTION`
`static java.lang.String`	`INPUTMONTIME`
`static java.lang.String`	`INPUTMONTIMEUNIT`
`static java.lang.String`	`LOGFILESIZE`
`static java.lang.String`	`MONITORINPUT`
`static java.lang.String`	`NARBACKUP`
`static java.lang.String`	`NARBACKUPDAYS`
`protected java.lang.String`	`nodeId` ID for the node that this DCNodeConfigData Object represents
`static java.lang.String`	`NUMCHANNELS`
`static java.lang.String`	`NUMEXPCHANVALUES`
`static java.lang.String`	`NUMEXPCHANVALUES2`
`static java.lang.String`	`PULLTIME`
`static java.lang.String`	`PUSHTIME`
`static java.lang.String`	`RECORDSTATS`
`static java.lang.String`	`ROUTING`
`static java.lang.String`	`ROUTINGATTRIBUTE`
`protected java.lang.String`	`ruleName` Name of the rules file or Class name
`protected byte[]`	`rules` Rules information for the node that this DCNodeConfigData Object contains configuration information for.
`static java.lang.String`	`RULESFILE`
`protected java.lang.String`	`secFileName` Name of the file which contains the list of secondary configuration file names.
`static java.lang.String`	`SECONDARYCFG`
`protected java.lang.String`	`udcHome` Location of the UDC installation
`protected boolean`	`useFile` Indicates whether the node should use a rules file or a Class
`protected java.util.Hashtable`	`varTable` Hashtable that holds all the variables

Constructor Summary

Constructors
Constructor and Description
`DCNodeConfigData()` Constructor to be used by GUI to create a DCNodeConfigData with initial set of default values
`DCNodeConfigData(java.lang.String inUdcHome, java.lang.String inNodeId)` Constructor to be used by NodeManager which is aware of the udcHome and nodeId

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`clone()` Deep clone the HashTable (varTable)
`void`	`defaultValue(java.lang.String name, java.lang.String value)` Sets the default value for the given key
`void`	`deleteItem(java.lang.String itemName)` Removes the given item from `varTable`
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getBackupDir()` Returns the absolute path name for the backup directory for the node represented by this DCNodeConfigData Object.
`java.lang.String`	`getConfigDir()` Returns the absolute path name for the config directory for the node represented by this DCNodeConfigData Object.
`byte[]`	`getConfigFile(java.lang.String filename)` Returns the contents of given secondary configuration file name
`java.util.Enumeration`	`getConfigFileNames()` Returns the names of secondary configuration files used by this node.
`boolean`	`getDirty()`
`java.lang.String`	`getGenConfigFilePathName()` Returns the absolute path name of the rules file containing the "General" information being used for the node associated with this DCNodeConfigData Object.
`java.lang.String`	`getHomeDir()` Returns the directory location of the UDC installation.
`java.lang.String`	`getItem(java.lang.String itemName)` Called by the GUI to retrieve items from `varTable`
`java.lang.String`	`getNodeId()`
`java.util.Vector`	`getPreferredRules()` Returns the preferred rule set for this node
`java.lang.String`	`getPrefRulesFilePathName()` Returns the absolute path name of the file containing the preferred rules file names being used for the node associated with this DCNodeConfigData Object.
`byte[]`	`getRuleClass()`
`java.lang.String`	`getRuleFilePathName()` Returns the absolute path name of the rules file being used for the node associated with this DCNodeConfigData Object.
`java.lang.String`	`getRuleName()` Returns the name of the rule file.
`byte[]`	`getRules()`
`java.util.Enumeration`	`getSettingsKeys()` Returns the set of `String` keys used for setting values of this node.
`boolean`	`getUseFile()`
`void`	`load()` Used by the NodeManager to load the general configuration and rules files into memory.
`void`	`load(boolean getPasswords)`
`protected void`	`readConfigFiles()` Builds the `configFiles` Hashtable based on the contents of the "secondary.cfg" file.
`protected byte[]`	`readFile(java.lang.String fileSpec)` Returns the contents of the given configuration filename
`void`	`save()` Used by the NodeManager to persist the general configuration and rules files to disk.
`protected void`	`setBaseDefaults()` Sets the default values for this DCNodeConfigData's general configuration parameters.
`void`	`setConfigFile(java.lang.String filename, byte[] data)` Stores a secondary configuration file in this DCNodeConfigData object
`protected void`	`setDefaults()` Should be overridden by derived classes to set node specific default values.
`void`	`setDirty(boolean d)` Sets value of `dirtyFlag` to `d`
`void`	`setHomeDir(java.lang.String inUdcHome)` Sets `udcHome`.
`void`	`setItem(java.lang.String itemName, java.lang.String value)` Called by the GUI to add items to `varTable` .
`void`	`setNodeId(java.lang.String inNodeId)` Used by the NodeManager to set the nodeId for the node associated with this DCNodeConfigData Object.
`void`	`setPreferredRules(java.util.Vector prefRules)` Sets the preferred rule set for this node.
`void`	`setRuleClass(byte[] ruleClass)`
`void`	`setRuleFileName(java.lang.String name)` Sets the name of the rule file.
`void`	`setRuleFilePathName(java.lang.String inRuleFilePathName)` Sets the absolute path name of the rules file being used for the node associated with this DCNodeConfigData Object.
`void`	`setRules(byte[] rules)`
`void`	`setRulesFromClass(java.io.File ruleClassFile, java.lang.String classString)` Reads the contents of the given file and sets the rule name to the given String.
`void`	`setRulesFromClass(java.lang.String inRuleClassName, java.lang.String asHostName, int urlPort)` Used by the AdminServer to set the given Class file.
`void`	`setRulesFromFile(java.lang.String inRuleFileName)` Used by the AdminServer to read the given rules file.
`void`	`setUseFile(boolean useFile)`
`java.lang.String`	`toString()`
`protected void`	`writeConfigFiles()` Writes out the secondary configuration files to disk.
`protected void`	`writeFile(java.lang.String outputFile, byte[] bytes)` Writes the given byte stream to the given configuration filename

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

- Field Detail
  - varTable
```
protected java.util.Hashtable varTable
```
    Hashtable that holds all the variables
  - nodeId
```
protected java.lang.String nodeId
```
    ID for the node that this DCNodeConfigData Object represents
  - udcHome
```
protected java.lang.String udcHome
```
    Location of the UDC installation
  - ruleName
```
protected java.lang.String ruleName
```
    Name of the rules file or Class name
  - secFileName
```
protected java.lang.String secFileName
```
    Name of the file which contains the list of secondary configuration file names.
  - useFile
```
protected boolean useFile
```
    Indicates whether the node should use a rules file or a Class
  - rules
```
protected byte[] rules
```
    Rules information for the node that this DCNodeConfigData Object contains configuration information for.
  - dirtyFlag
```
protected boolean dirtyFlag
```
    True, if a value has changed
  - configFiles
```
protected java.util.Hashtable configFiles
```
    Hashtable containing byte arrays representing secondary configuration files. The hashtable is keyed by the path/name of the file. This provides base-level access to the data for generic purposes while still allowing derived classes access for specific purposes.
  - DEBUG
```
public static final java.lang.String DEBUG
```
    See Also:
    
    Constant Field Values
  - DATAFILESIZE
```
public static final java.lang.String DATAFILESIZE
```
    See Also:
    
    Constant Field Values
  - PUSHTIME
```
public static final java.lang.String PUSHTIME
```
    See Also:
    
    Constant Field Values
  - PULLTIME
```
public static final java.lang.String PULLTIME
```
    See Also:
    
    Constant Field Values
  - LOGFILESIZE
```
public static final java.lang.String LOGFILESIZE
```
    See Also:
    
    Constant Field Values
  - RULESFILE
```
public static final java.lang.String RULESFILE
```
    See Also:
    
    Constant Field Values
  - ROUTING
```
public static final java.lang.String ROUTING
```
    See Also:
    
    Constant Field Values
  - ROUTINGATTRIBUTE
```
public static final java.lang.String ROUTINGATTRIBUTE
```
    See Also:
    
    Constant Field Values
  - NUMCHANNELS
```
public static final java.lang.String NUMCHANNELS
```
    See Also:
    
    Constant Field Values
  - EXPCHANVALUE
```
public static final java.lang.String EXPCHANVALUE
```
    See Also:
    
    Constant Field Values
  - EXPCHANVALUE2
```
public static final java.lang.String EXPCHANVALUE2
```
    See Also:
    
    Constant Field Values
  - EXPCHANOPERATOR
```
public static final java.lang.String EXPCHANOPERATOR
```
    See Also:
    
    Constant Field Values
  - NUMEXPCHANVALUES
```
public static final java.lang.String NUMEXPCHANVALUES
```
    See Also:
    
    Constant Field Values
  - NUMEXPCHANVALUES2
```
public static final java.lang.String NUMEXPCHANVALUES2
```
    See Also:
    
    Constant Field Values
  - NARBACKUP
```
public static final java.lang.String NARBACKUP
```
    See Also:
    
    Constant Field Values
  - BULKIO
```
public static final java.lang.String BULKIO
```
    See Also:
    
    Constant Field Values
  - NARBACKUPDAYS
```
public static final java.lang.String NARBACKUPDAYS
```
    See Also:
    
    Constant Field Values
  - BACKUP
```
public static final java.lang.String BACKUP
```
    See Also:
    
    Constant Field Values
  - ASCODEBASE
```
public static final java.lang.String ASCODEBASE
```
    See Also:
    
    Constant Field Values
  - SECONDARYCFG
```
public static final java.lang.String SECONDARYCFG
```
    See Also:
    
    Constant Field Values
  - MONITORINPUT
```
public static final java.lang.String MONITORINPUT
```
    See Also:
    
    Constant Field Values
  - INPUTMONTIME
```
public static final java.lang.String INPUTMONTIME
```
    See Also:
    
    Constant Field Values
  - INPUTMONTIMEUNIT
```
public static final java.lang.String INPUTMONTIMEUNIT
```
    See Also:
    
    Constant Field Values
  - RECORDSTATS
```
public static final java.lang.String RECORDSTATS
```
    See Also:
    
    Constant Field Values
  - FILELEVELTRANSACTION
```
public static final java.lang.String FILELEVELTRANSACTION
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DCNodeConfigData
```
public DCNodeConfigData()
```
    Constructor to be used by GUI to create a DCNodeConfigData with initial set of default values
  - DCNodeConfigData
```
public DCNodeConfigData(java.lang.String inUdcHome,
                        java.lang.String inNodeId)
                 throws java.io.IOException
```
    Constructor to be used by NodeManager which is aware of the udcHome and nodeId
    
    Throws:
    
    java.io.IOException
- Method Detail
  - getDirty
```
public boolean getDirty()
```
    Returns:
    
    value of dirtyFlag
  - setDirty
```
public void setDirty(boolean d)
```
    Sets value of dirtyFlag to d
  - getConfigDir
```
public java.lang.String getConfigDir()
                              throws java.io.IOException
```
    Returns the absolute path name for the config directory for the node represented by this DCNodeConfigData Object.
    
    Returns:
    
    Absolute path name for the node's config directory. Default is: udcHome/config/ nodeId
    
    Throws:
    
    java.io.IOException - If udcHome or nodeId have not been set.
  - getBackupDir
```
public java.lang.String getBackupDir()
                              throws java.io.IOException
```
    Returns the absolute path name for the backup directory for the node represented by this DCNodeConfigData Object.
    
    Returns:
    
    Absolute path name for the node's back up directory. Default is: udcHome/backup/ nodeId
    
    Throws:
    
    java.io.IOException - If udcHome or nodeId have not been set.
  - getUseFile
```
public boolean getUseFile()
```
  - setUseFile
```
public void setUseFile(boolean useFile)
```
  - getRuleFilePathName
```
public java.lang.String getRuleFilePathName()
                                     throws java.io.IOException
```
    Returns the absolute path name of the rules file being used for the node associated with this DCNodeConfigData Object.
    
    Returns:
    
    Absolute path name of the rules file. Default is:
    getConfigDir() + File.separator + "rules.cfg".
    
    Throws:
    
    java.io.IOException
  - getRuleName
```
public java.lang.String getRuleName()
```
    Returns the name of the rule file. Default is rules.cfg
  - setRuleFileName
```
public void setRuleFileName(java.lang.String name)
```
    Sets the name of the rule file. Default is rules.cfg
  - setRuleFilePathName
```
public void setRuleFilePathName(java.lang.String inRuleFilePathName)
```
    Sets the absolute path name of the rules file being used for the node associated with this DCNodeConfigData Object.
    
    Parameters:
    
    inRuleFilePathName - Absolute path name of the rules file.
  - getRules
```
public byte[] getRules()
```
  - setRules
```
public void setRules(byte[] rules)
```
  - getRuleClass
```
public byte[] getRuleClass()
```
  - setRuleClass
```
public void setRuleClass(byte[] ruleClass)
```
  - getPrefRulesFilePathName
```
public java.lang.String getPrefRulesFilePathName()
                                          throws java.io.IOException
```
    Returns the absolute path name of the file containing the preferred rules file names being used for the node associated with this DCNodeConfigData Object.
    
    Returns:
    
    Absolute path name of the preferred rules file. Default is:
    getConfigDir() + File.separator + "preferredRules.cfg".
    
    Throws:
    
    java.io.IOException
  - getGenConfigFilePathName
```
public java.lang.String getGenConfigFilePathName()
                                          throws java.io.IOException
```
    Returns the absolute path name of the rules file containing the "General" information being used for the node associated with this DCNodeConfigData Object.
    
    Returns:
    
    Absolute path name of the General config file. Default is:
    getConfigDir() + File.separator + "general.cfg".
    
    Throws:
    
    java.io.IOException
  - defaultValue
```
public void defaultValue(java.lang.String name,
                         java.lang.String value)
```
    Sets the default value for the given key
    
    Parameters:
    
    name - name of the configuration parameter
    
    value - default value
  - getHomeDir
```
public java.lang.String getHomeDir()
                            throws java.io.IOException
```
    Returns the directory location of the UDC installation.
    
    Returns:
    
    Value of udcHome
    
    Throws:
    
    java.io.IOException - If udcHome has not been set
  - setHomeDir
```
public void setHomeDir(java.lang.String inUdcHome)
```
    Sets udcHome. This is used by the NodeManager to set the directory location of the UDC installation.
    
    Parameters:
    
    inUdcHome - Directory where the UDC program is installed
  - setNodeId
```
public void setNodeId(java.lang.String inNodeId)
```
    Used by the NodeManager to set the nodeId for the node associated with this DCNodeConfigData Object.
    
    Parameters:
    
    inNodeId - String identifier for the node
  - getNodeId
```
public java.lang.String getNodeId()
```
  - setRulesFromFile
```
public void setRulesFromFile(java.lang.String inRuleFileName)
                      throws java.io.IOException
```
    Used by the AdminServer to read the given rules file.
    
    Parameters:
    
    inRuleFileName - name of the rules file to read
    
    Throws:
    
    java.io.IOException
  - setRulesFromClass
```
public void setRulesFromClass(java.io.File ruleClassFile,
                              java.lang.String classString)
                       throws java.lang.ClassNotFoundException
```
    Reads the contents of the given file and sets the rule name to the given String.
    
    Parameters:
    
    ruleClassFile - File object representing the NPL class file to be used.
    
    classString - Name of the Java class for ruleClassFile
    
    Throws:
    
    java.lang.ClassNotFoundException
  - setRulesFromClass
```
public void setRulesFromClass(java.lang.String inRuleClassName,
                              java.lang.String asHostName,
                              int urlPort)
                       throws java.lang.ClassNotFoundException
```
    Used by the AdminServer to set the given Class file.
    
    Parameters:
    
    inRuleClassName - name of the Class to load
    
    Throws:
    
    java.lang.ClassNotFoundException
  - load
```
public void load()
          throws java.io.IOException
```
    Used by the NodeManager to load the general configuration and rules files into memory.
    The path for the general config file is always
    udcHome/config/nodeId/general.cfg
    
    Throws:
    
    java.io.IOException - If either the general.cfg or ruleName file could not be read
  - load
```
public void load(boolean getPasswords)
          throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - save
```
public void save()
          throws java.io.IOException
```
    Used by the NodeManager to persist the general configuration and rules files to disk.
    The path for the general config file is always
    udcHome/config/nodeId/general.cfg
    
    Throws:
    
    java.io.IOException - If the config directory does not exist, or either the general.cfg or rules.cfg file could not be written to
  - deleteItem
```
public void deleteItem(java.lang.String itemName)
```
    Removes the given item from varTable
  - getConfigFileNames
```
public java.util.Enumeration getConfigFileNames()
```
    Returns the names of secondary configuration files used by this node.
    
    Returns:
    
    an Enumeration of the filenames
    
    See Also:
    
    getConfigFile(String )
  - setConfigFile
```
public void setConfigFile(java.lang.String filename,
                          byte[] data)
```
    Stores a secondary configuration file in this DCNodeConfigData object
    
    Parameters:
    
    filename - The name of the secondary configuration file
    
    data - A byte array representing the contenst of the file
  - getConfigFile
```
public byte[] getConfigFile(java.lang.String filename)
```
    Returns the contents of given secondary configuration file name
    
    Parameters:
    
    filename - name of the secondary configuration file
    
    Returns:
    
    a byte[] representing the contents of the file
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - getItem
```
public java.lang.String getItem(java.lang.String itemName)
```
    Called by the GUI to retrieve items from varTable
    
    Specified by:
    
    getItem in interface ConfigIfc
  - setItem
```
public void setItem(java.lang.String itemName,
                    java.lang.String value)
```
    Called by the GUI to add items to varTable . Calls setDirty if value is different from the current value stored at itemName by calling the equals() method.
    
    Specified by:
    
    setItem in interface ConfigIfc
  - setPreferredRules
```
public void setPreferredRules(java.util.Vector prefRules)
```
    Sets the preferred rule set for this node.
    This Vector holds display-name/file-name pairs for the set of rules files that are appropriate for this node given its market segment (which is set at node creation time). The set of rules available to this node are the intersection of the files named in this Vector and the files physically present on disk. The display names are used in the configuration GUI.
    Vector format is as follows:
    [0] display name 1 [1] file name 1 ... When this data is written to and read from disk, it is NOT placed in varTable. Rather, the prefix "preferredRules" is used for each key, and this is stored via a Properties object.
  - getPreferredRules
```
public java.util.Vector getPreferredRules()
```
    Returns the preferred rule set for this node
  - getSettingsKeys
```
public java.util.Enumeration getSettingsKeys()
```
    Returns the set of String keys used for setting values of this node.
    
    Returns:
    
    an Enumeration of the keys used
    
    See Also:
    
    setItem(String, String ), getItem(String )
  - readFile
```
protected byte[] readFile(java.lang.String fileSpec)
                   throws java.io.IOException
```
    Returns the contents of the given configuration filename
    
    Returns:
    
    Contents of fileSpec; an empty byte array is returned if the file could not be found.
    
    Throws:
    
    java.io.IOException
  - writeFile
```
protected void writeFile(java.lang.String outputFile,
                         byte[] bytes)
                  throws java.io.IOException
```
    Writes the given byte stream to the given configuration filename
    
    Parameters:
    
    outputFile - Name of the file to write to
    
    bytes - Contents of the file to be written
    
    Throws:
    
    java.io.IOException
  - setBaseDefaults
```
protected void setBaseDefaults()
```
    Sets the default values for this DCNodeConfigData's general configuration parameters.
    These are:
    DEBUG = 1 DATAFILESIZE = 2000 PUSHTIME = 60 PULLTIME = 20 LOGFILESIZE = 10000 BACKUP = false SECONDARYCFG = "secondary.cfg"
  - setDefaults
```
protected void setDefaults()
```
    Should be overridden by derived classes to set node specific default values. Default implementation is empty.
  - writeConfigFiles
```
protected void writeConfigFiles()
                         throws java.io.IOException
```
    Writes out the secondary configuration files to disk. The default file location is the value returned by getConfigDir(), which is generally the node's config directory.
    
    Throws:
    
    java.io.IOException
  - readConfigFiles
```
protected void readConfigFiles()
                        throws java.io.IOException
```
    Builds the configFiles Hashtable based on the contents of the "secondary.cfg" file. The "secondary.cfg" file contains a list of all of the filenames originally stored in configFiles. By default, this method assumes that all files were stored in the node's config directory (the value returned by getConfigDir(). If the "secondary.cfg" file does not exist (indicating that no secondary files were designated, then the configFiles Hashtable is initialized to an empty table.
    
    Throws:
    
    java.io.IOException
  - clone
```
public java.lang.Object clone()
```
    Deep clone the HashTable (varTable)
    
    Overrides:
    
    clone in class java.lang.Object

Class DCNodeConfigData

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

varTable

nodeId

udcHome

ruleName

secFileName

useFile

rules

dirtyFlag

configFiles

DEBUG

DATAFILESIZE

PUSHTIME

PULLTIME

LOGFILESIZE

RULESFILE

ROUTING

ROUTINGATTRIBUTE

NUMCHANNELS

EXPCHANVALUE

EXPCHANVALUE2

EXPCHANOPERATOR

NUMEXPCHANVALUES

NUMEXPCHANVALUES2

NARBACKUP

BULKIO

NARBACKUPDAYS

BACKUP

ASCODEBASE

SECONDARYCFG

MONITORINPUT

INPUTMONTIME

INPUTMONTIMEUNIT

RECORDSTATS

FILELEVELTRANSACTION

Constructor Detail

DCNodeConfigData

DCNodeConfigData

Method Detail

getDirty

setDirty

getConfigDir

getBackupDir

getUseFile

setUseFile

getRuleFilePathName

getRuleName

setRuleFileName

setRuleFilePathName

getRules

setRules

getRuleClass

setRuleClass

getPrefRulesFilePathName

getGenConfigFilePathName

defaultValue

getHomeDir

setHomeDir

setNodeId

getNodeId

setRulesFromFile

setRulesFromClass

setRulesFromClass

load

load

save

deleteItem

getConfigFileNames

setConfigFile

getConfigFile

toString

equals

getItem

setItem

setPreferredRules