Configuration (Apache OODT 1.2-SNAPSHOT API)

java.lang.Object
- org.apache.oodt.commons.Configuration

```
public class Configuration
extends Object
```
EDA Configuration. An object of this class represents the configuration information for the EDA software.

Author:

Kelly

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ALT_CONFIG_FILE` Alternate config file.
`static File`	`ALT_LIB_CONFIG_FILE` Non-JRE library location of config file.
`static String`	`DEFAULT_CONFIG_FILE` Name of the default config file.
`static String`	`DTD_FPI` The formal public identifier (FPI) of the configuration document type definition (DTD).
`static String`	`DTD_OLD_FPI` The old formal public identifier (FPI) of the configuration document type definition (DTD).
`static String`	`DTD_URL` The system identifier of the configuration document type definition (DTD).
`static String`	`ENTITY_DIRS_PROP` Name of property that specifies the direcotries that contains XML entities.
`static int`	`INT`
`static int`	`INT1`
`static File`	`LIB_CONFIG_FILE` Library-location config file.
`static String`	`WEB_PROTOCOL_PROPERTY` Name of the system property that names the web protocol to use.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Configuration`	`getConfiguration()` Get the singleton configuration.
`static Configuration`	`getConfiguration(URL configFileUrl)` Get the singleton configuration.
`static Configuration`	`getConfigurationWithoutException()` Get the singleton configuration without exception.
`List`	`getEntityRefDirs()` Get the entity reference directories.
`ExecServerConfig`	`getExecServerConfig(String objectKey)` Get an exec-server configuration.
`Collection`	`getExecServerConfigs()` Get the exec-server configurations.
`Collection`	`getExecServerConfigs(Class clazz)` Get the exec-server configurations.
`String`	`getNameServerPort()` Get the name server port, if any.
`int`	`getNameServerStateFrequency()` Get the frequency with which the name server saves its state.
`String`	`getNameServerURL()` Get the name server URL.
`Context`	`getObjectContext()` Get the object context.
`int`	`getServerMgrPort()` Get the port number on which the server manager is listening.
`String`	`getWebServerBaseURL()` Get the web server base URL.
`File`	`getWebServerDocumentDirectory()` Get the web server document directory.
`void`	`mergeProperties(Properties targetProps)` Merge the properties in the configuration into the given properties.
`String`	`toXML()` Serialize this configuration into a serialized XML document.
`Node`	`toXML(Document document)`

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

- Field Detail
  - INT
```
public static final int INT
```
    See Also:
    
    Constant Field Values
  - INT1
```
public static final int INT1
```
    See Also:
    
    Constant Field Values
  - ENTITY_DIRS_PROP
```
public static final String ENTITY_DIRS_PROP
```
    Name of property that specifies the direcotries that contains XML entities.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_CONFIG_FILE
```
public static final String DEFAULT_CONFIG_FILE
```
    Name of the default config file.
    
    See Also:
    
    Constant Field Values
  - ALT_CONFIG_FILE
```
public static final String ALT_CONFIG_FILE
```
    Alternate config file.
    
    See Also:
    
    Constant Field Values
  - LIB_CONFIG_FILE
```
public static final File LIB_CONFIG_FILE
```
    Library-location config file.
  - ALT_LIB_CONFIG_FILE
```
public static final File ALT_LIB_CONFIG_FILE
```
    Non-JRE library location of config file.
  - DTD_FPI
```
public static final String DTD_FPI
```
    The formal public identifier (FPI) of the configuration document type definition (DTD).
    
    See Also:
    
    Constant Field Values
  - DTD_OLD_FPI
```
public static final String DTD_OLD_FPI
```
    The old formal public identifier (FPI) of the configuration document type definition (DTD).
    
    See Also:
    
    Constant Field Values
  - DTD_URL
```
public static final String DTD_URL
```
    The system identifier of the configuration document type definition (DTD).
    
    See Also:
    
    Constant Field Values
  - WEB_PROTOCOL_PROPERTY
```
public static final String WEB_PROTOCOL_PROPERTY
```
    Name of the system property that names the web protocol to use.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getConfiguration
```
public static Configuration getConfiguration()
                                      throws IOException,
                                             SAXException
```
    Get the singleton configuration. This method returns the singleton configuration object, or creates it if it doesn't yet exist. To create it, it reads the configuration file specified by the system property org.apache.oodt.commons.Configuration.url or the file in the user's home directory called .edarc.xml if the system property isn't specified. It parses the file and returns a Configuration object initialized with the data specified therein.
    
    Returns:
    
    An initialized configuration object.
    
    Throws:
    
    IOException - If reading the configuration file fails.
    
    SAXException - If parsing the configuration file fails.
    
    MalformedURLException - If the URL specification is invalid.
  - getConfiguration
```
public static Configuration getConfiguration(URL configFileUrl)
                                      throws SAXException,
                                             IOException
```
    Get the singleton configuration. This method returns the singleton configuration object from a specified file url. It parses the file and returns a Configuration object initialized with the data specified therein. Added by Chris Mattmann 12/05/03.
    
    Returns:
    
    An initialized configuration object.
    
    Throws:
    
    IOException - If an I/O error occurs.
    
    SAXException
  - getConfigurationWithoutException
```
public static Configuration getConfigurationWithoutException()
```
    Get the singleton configuration without exception. This method is identical to getConfiguration() but traps all checked exceptions. If the configuration can't be read, it returns null.
    
    Returns:
    
    An initialized configuration object, or null if an error occurred.
  - toXML
```
public String toXML()
             throws DOMException
```
    Serialize this configuration into a serialized XML document.
    
    Returns:
    
    Serialized XML version of this configuration.
    
    Throws:
    
    DOMException - If an error occurs constructing the XML structure.
  - toXML
```
public Node toXML(Document document)
           throws DOMException
```
    Parameters:
    
    document - The document to which the XML structure will belong.
    
    Returns:
    
    The root node representing this configuration.
    
    Throws:
    
    DOMException - If an error occurs constructing the XML structure.
  - mergeProperties
```
public void mergeProperties(Properties targetProps)
```
    Merge the properties in the configuration into the given properties. Properties that already exist in the targetProps won't be overwritten.
    
    Parameters:
    
    targetProps - The target properties.
  - getExecServerConfigs
```
public Collection getExecServerConfigs()
```
    Get the exec-server configurations.
    
    Returns:
    
    A collection of exec server configurations, each of class ExecServerConfig.
  - getExecServerConfigs
```
public Collection getExecServerConfigs(Class clazz)
```
    Get the exec-server configurations.
    
    Parameters:
    
    clazz - The class of exec servers that will be returned.
    
    Returns:
    
    A collection of exec server configurations, each of class ExecServerConfig.
  - getExecServerConfig
```
public ExecServerConfig getExecServerConfig(String objectKey)
```
    Get an exec-server configuration.
    
    Parameters:
    
    objectKey - The object key of the Exec Server to retrieve.
    
    Returns:
    
    An ExecServerConfig or null if object key not found.
  - getWebServerBaseURL
```
public String getWebServerBaseURL()
```
    Get the web server base URL.
    
    Returns:
    
    The base web server URL.
  - getWebServerDocumentDirectory
```
public File getWebServerDocumentDirectory()
```
    Get the web server document directory.
    
    Returns:
    
    The document directory.
  - getNameServerURL
```
public String getNameServerURL()
```
    Get the name server URL.
    
    Returns:
    
    The name server URL.
  - getNameServerPort
```
public String getNameServerPort()
```
    Get the name server port, if any.
    
    Returns:
    
    The port.
  - getNameServerStateFrequency
```
public int getNameServerStateFrequency()
```
    Get the frequency with which the name server saves its state.
    
    Returns:
    
    The state-save frequency in milliseconds; <= 0 means never save state.
  - getObjectContext
```
public Context getObjectContext()
                         throws NamingException
```
    Get the object context.
    
    Returns:
    
    The object context based on this configuration.
    
    Throws:
    
    NamingException - If the context can't be created.
  - getEntityRefDirs
```
public List getEntityRefDirs()
```
    Get the entity reference directories.
    
    Returns:
    
    A list of Strings naming directories for entity references.
  - getServerMgrPort
```
public int getServerMgrPort()
```
    Get the port number on which the server manager is listening.
    
    Returns:
    
    The port number, or 0 if there is no server manager.

Class Configuration

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

INT

INT1

ENTITY_DIRS_PROP

DEFAULT_CONFIG_FILE

ALT_CONFIG_FILE

LIB_CONFIG_FILE

ALT_LIB_CONFIG_FILE

DTD_FPI

DTD_OLD_FPI

DTD_URL

WEB_PROTOCOL_PROPERTY

Method Detail

getConfiguration

getConfiguration

getConfigurationWithoutException

toXML

toXML

mergeProperties

getExecServerConfigs

getExecServerConfigs

getExecServerConfig

getWebServerBaseURL

getWebServerDocumentDirectory

getNameServerURL

getNameServerPort

getNameServerStateFrequency

getObjectContext

getEntityRefDirs

getServerMgrPort