CommonMachineConfig (Autonomous Unmanned Vehicle (AUV) Workbench Documentation)

java.lang.Object
- edu.nps.util.CommonMachineConfig

```
public class CommonMachineConfig
extends Object
```
The idea behind these classes is to implement an interface to an Apache commons Configuration system/object which is common across all JVMs running on a single machine. This is to provide a lightweight ability for execution JVMs to access (heavy) XML-parsing code, which has already been done in the first application module. A localhost socket is used. Must use apache commons config 1.1 for this, since we'll want multiple xml files Autonomous Underwater Vehicle Workbench Naval Postgraduate School, Monterey, CA www.nps.edu

Since:

Jan 27, 2005, 3:10:56 PM

Version:

$Id: CommonMachineConfig.java 9109 2015-07-29 22:39:46Z brutzman $

Author:

Mike Bailey

Field Summary

Fields
Modifier and Type Field and Description

static int CMC_PORT

static String COUNT_PREFIX

static String DELIMITER

static String REMOVE_PREFIX

static String SET_PREFIX

Fields
Modifier and Type	Field and Description
`static int`	`CMC_PORT`
`static String`	`COUNT_PREFIX`
`static String`	`DELIMITER`
`static String`	`REMOVE_PREFIX`
`static String`	`SET_PREFIX`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`addLocalConfig(String rootFile)` The controller uses this to add project-level configuration to the system.
`String`	`configValue(String key)` Public entry to the CommonMachineConfig object.
`int`	`configValueCount(String key)` Public entry to the CommonMachineConfig object.
`String[]`	`configValues(String key)` public entry to the CommonMachineConfig object.
`static CommonMachineConfig`	`instance()` Return an instance of CommonMachineConfig which is the only one on the machine.
`static CommonMachineConfig`	`instance(String implementer, String rootFile)` Return an instance of CommonMachineConfig which is the only one on the machine.
`int`	`num(String key)` Alternate name for configValueCount() method in the interest of code readability
`void`	`removeLocalConfig(Object key)` Controller uses this to remove project-level config.
`void`	`removeVal(String key)` Remove a configuration property
`void`	`setVal(String key, String val)` Write a configuration value back to XML
`static CommonMachineConfig`	`soleInstance()` Return an instance of CommonMachineConfig which is the only one on the machine.
`static CommonMachineConfig`	`soleInstance(String rootFile)` Return an instance of CommonMachineConfig which is the only one on the machine.
`String`	`val(String key)` Alternate name for configValue() method, in the interest of code readability
`String[]`	`vals(String key)` Alternate name for configValues() method, in the interest of code readability

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

- Field Detail
  - CMC_PORT
```
public static final int CMC_PORT
```
    See Also:
    
    Constant Field Values
  - COUNT_PREFIX
```
public static final String COUNT_PREFIX
```
    See Also:
    
    Constant Field Values
  - SET_PREFIX
```
public static final String SET_PREFIX
```
    See Also:
    
    Constant Field Values
  - REMOVE_PREFIX
```
public static final String REMOVE_PREFIX
```
    See Also:
    
    Constant Field Values
  - DELIMITER
```
public static final String DELIMITER
```
    See Also:
    
    Constant Field Values
- Method Detail
  - soleInstance
```
public static CommonMachineConfig soleInstance()
                                        throws Exception
```
    Return an instance of CommonMachineConfig which is the only one on the machine.
    
    Returns:
    
    the instance using default rootFile path
    
    Throws:
    
    Exception - Thrown if a previously-instantiated instance has been detected
  - soleInstance
```
public static CommonMachineConfig soleInstance(String rootFile)
                                        throws Exception
```
    Return an instance of CommonMachineConfig which is the only one on the machine.
    
    Parameters:
    
    rootFile - Master XML file listing other XML files
    
    Returns:
    
    the instance specifying rootFile path
    
    Throws:
    
    Exception - Thrown if a previously-instantiated instance has been detected
  - instance
```
public static CommonMachineConfig instance()
```
    Return an instance of CommonMachineConfig which is the only one on the machine.
    
    Returns:
    
    the instance using the default rootFile path (not used if subordinate instance)
  - instance
```
public static CommonMachineConfig instance(String implementer,
                                           String rootFile)
```
    Return an instance of CommonMachineConfig which is the only one on the machine.
    
    Parameters:
    
    implementer -
    
    rootFile -
    
    Returns:
    
    the instance using the specified rootFile path (not used if subordinate instance)
  - configValue
```
public String configValue(String key)
```
    Public entry to the CommonMachineConfig object. We delegate our operation to either ourselves, if we are the "master", or the cmcNetDelegate object we built which talks to the external master.
    
    Parameters:
    
    key - the key to any value(s)
    
    Returns:
    
    value, possibly empty string
  - val
```
public String val(String key)
```
    Alternate name for configValue() method, in the interest of code readability
    
    Parameters:
    
    key - the key for the held value
    
    Returns:
    
    value, possibly empty string
  - setVal
```
public void setVal(String key,
                   String val)
```
    Write a configuration value back to XML
    
    Parameters:
    
    key -
    
    val -
  - removeVal
```
public void removeVal(String key)
```
    Remove a configuration property
    
    Parameters:
    
    key -
  - configValues
```
public String[] configValues(String key)
```
    public entry to the CommonMachineConfig object. See comments for configValue(). We always return an array, even if size==1.
    
    Parameters:
    
    key - the key for the desired values
    
    Returns:
    
    possibly zero-length String array
  - vals
```
public String[] vals(String key)
```
    Alternate name for configValues() method, in the interest of code readability
    
    Parameters:
    
    key -
    
    Returns:
    
    possibly zero-length String array
  - configValueCount
```
public int configValueCount(String key)
```
    Public entry to the CommonMachineConfig object. See comments for configValue().
    
    Parameters:
    
    key -
    
    Returns:
    
    number of values attached to the supplied key
  - num
```
public int num(String key)
```
    Alternate name for configValueCount() method in the interest of code readability
    
    Parameters:
    
    key -
    
    Returns:
    
    number of values attached to the supplied key
  - addLocalConfig
```
public Object addLocalConfig(String rootFile)
                      throws Exception
```
    The controller uses this to add project-level configuration to the system.
    
    Parameters:
    
    rootFile - path to the root xml file (I.e., "commonsConfig.xml")
    
    Returns:
    
    key to be used in @see removeLocalConfig.
    
    Throws:
    
    Exception - if error configuring xml files.
  - removeLocalConfig
```
public void removeLocalConfig(Object key)
```
    Controller uses this to remove project-level config.
    
    Parameters:
    
    key - obtained from @see addLocalConfig

Class CommonMachineConfig

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CMC_PORT

COUNT_PREFIX

SET_PREFIX

REMOVE_PREFIX

DELIMITER

Method Detail

soleInstance

soleInstance

instance

instance

configValue

val

setVal

removeVal

configValues

vals

configValueCount

num

addLocalConfig

removeLocalConfig