Configuration (JacORB Release 3.9 API)

All Known Implementing Classes:

JacORBConfiguration
```
public interface Configuration
```
ORB configuration objects are read-only representations of files with configuration properties. ORB configuration options for a given name are looked up and loaded as follows:
1. System properties are loaded first, but only to get properties that affect further property loading
2. the file orb.properties is loaded from java.home/lib and user.home if it exists
3. if the ORBid is property is set, the file ORBid.properties is loaded from jacorb.config.dir/etc, if that exists, or jacorb.home/etc, or '.' If ORBid is not set, the default file jacorb.properties is loaded from these places.
4. Custom properties are loaded from each file name listed int the system property custom.props
5. To also support packaged servers in jar files, the configuration file lookup mechanism finally tries to load named properties files (ORBid.properties, or jacorb.properties) from the classpath, if it cannot find them in the config dictionary.
6. After all property files have been loaded, the System properties are loaded again, so that command-line properties take precedence
7. Finally, properties hard-coded and passed in through ORB.init() are loaded.
The Configuration object is also used by JacORB components to retreive their Logger objects.
Author:

Gerald Brose

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getAttribute(String key)` Returns the value of the configuration attribute with the given key.
`String`	`getAttribute(String key, String defaultValue)` Returns the value of the configuration attribute with the given key.
`boolean`	`getAttributeAsBoolean(String key, boolean defaultValue)` Returns the value of the configuration attribute with the given key, as a boolean value.
`double`	`getAttributeAsFloat(String key, double defaultValue)` Returns the value of the configuration attribute with the given key, as a float value.
`int`	`getAttributeAsInteger(String key)` Returns the value of the configuration attribute with the given key, as an integer.
`int`	`getAttributeAsInteger(String key, int defaultValue)` Returns the value of the configuration attribute with the given key, as an integer.
`int`	`getAttributeAsInteger(String key, int defaultValue, int radix)` Returns the value of the configuration attribute with the given key, as an integer using the radix as number base for the value.
`long`	`getAttributeAsLong(String key, long defaultValue)` Returns the value of the configuration attribute with the given key, as a long value.
`Object`	`getAttributeAsObject(String key)`
`Object`	`getAttributeAsObject(String key, String defaultClass)`
`String[]`	`getAttributeAsStringsArray(String key)` For a property that has a list of comma-separated values, this method returns these values as a array of Strings.
`List<String>`	`getAttributeList(String key)` For a property that has a list of comma-separated values, this method returns these values as a list of Strings.
`List<String>`	`getAttributeNamesWithPrefix(String string)` return all attribute names that start with the specified prefix
`org.slf4j.Logger`	`getLogger(String name)`
`ORB`	`getORB()`
`boolean`	`isAttributeSet(String key)` Returns if the configuration attribute with the given key is defined.
`void`	`setAttribute(String key, int value)` Sets the given int attribute with the given value
`void`	`setAttribute(String key, String value)` Sets the given string attribute with the given value
`void`	`setAttributes(Properties value)` Sets the attributes of this configuration using Properties.

- Method Detail
  - isAttributeSet
```
boolean isAttributeSet(String key)
                       throws ConfigurationException
```
    Returns if the configuration attribute with the given key is defined.
    
    Throws:
    
    ConfigurationException
  - getAttribute
```
String getAttribute(String key)
                    throws ConfigurationException
```
    Returns the value of the configuration attribute with the given key. If the attribute value for this key is undefined, the exception ConfigurationException is thrown.
    
    Throws:
    
    ConfigurationException
  - getAttribute
```
String getAttribute(String key,
                  String defaultValue)
```
    Returns the value of the configuration attribute with the given key. If the attribute value for this key is undefined, the defaultValue is returned.
  - getAttributeAsBoolean
```
boolean getAttributeAsBoolean(String key,
                            boolean defaultValue)
```
    Returns the value of the configuration attribute with the given key, as a boolean value. If the attribute value for this key is undefined, the defaultValue is returned.
  - getAttributeAsFloat
```
double getAttributeAsFloat(String key,
                         double defaultValue)
                           throws ConfigurationException
```
    Returns the value of the configuration attribute with the given key, as a float value. If the attribute value for this key is undefined, the defaultValue is returned.
    
    Throws:
    
    ConfigurationException
  - getAttributeAsInteger
```
int getAttributeAsInteger(String key)
                          throws ConfigurationException
```
    Returns the value of the configuration attribute with the given key, as an integer. If the attribute value for this key is undefined, the exception ConfigurationException is thrown.
    
    Throws:
    
    ConfigurationException
  - getAttributeAsInteger
```
int getAttributeAsInteger(String key,
                        int defaultValue)
                          throws ConfigurationException
```
    Returns the value of the configuration attribute with the given key, as an integer. If the attribute value for this key is undefined, the defaultValue is returned.
    
    Throws:
    
    ConfigurationException
  - getAttributeAsInteger
```
int getAttributeAsInteger(String key,
                        int defaultValue,
                        int radix)
                          throws ConfigurationException
```
    Returns the value of the configuration attribute with the given key, as an integer using the radix as number base for the value. If the attribute value for this key is undefined, the defaultValue is returned.
    
    Throws:
    
    ConfigurationException
  - getAttributeAsLong
```
long getAttributeAsLong(String key,
                      long defaultValue)
                        throws ConfigurationException
```
    Returns the value of the configuration attribute with the given key, as a long value. If the attribute value for this key is undefined, the defaultValue is returned.
    
    Throws:
    
    ConfigurationException
  - getAttributeAsObject
```
Object getAttributeAsObject(String key)
                            throws ConfigurationException
```
    Returns:
    an object of the class of the keys value, or null, if no class name is found for the key
    
    Throws:
    
    ConfigurationException
  - getAttributeAsObject
```
Object getAttributeAsObject(String key,
                          String defaultClass)
                            throws ConfigurationException
```
    Throws:
    
    ConfigurationException
  - getAttributeAsStringsArray
```
String[] getAttributeAsStringsArray(String key)
```
    For a property that has a list of comma-separated values, this method returns these values as a array of Strings. If the property is not set or has empty value, null is returned.
  - getAttributeList
```
List<String> getAttributeList(String key)
```
    For a property that has a list of comma-separated values, this method returns these values as a list of Strings. If the property is not set, an empty list is returned.
  - getAttributeNamesWithPrefix
```
List<String> getAttributeNamesWithPrefix(String string)
```
    return all attribute names that start with the specified prefix
  - getLogger
```
org.slf4j.Logger getLogger(String name)
```
    Parameters:
    name - the name of the logger, which also functions as a log category
    
    Returns:
    a Logger for a given name
  - getORB
```
ORB getORB()
```
    Returns:
    the ORB for which this configuration was created
  - setAttribute
```
void setAttribute(String key,
                int value)
```
    Sets the given int attribute with the given value
    
    Parameters:
    key -
    value -
  - setAttribute
```
void setAttribute(String key,
                String value)
```
    Sets the given string attribute with the given value
    
    Parameters:
    key -
    value -
  - setAttributes
```
void setAttributes(Properties value)
```
    Sets the attributes of this configuration using Properties.
    
    Parameters:
    value -

Interface Configuration

Method Summary

Method Detail

isAttributeSet

getAttribute

getAttribute

getAttributeAsBoolean

getAttributeAsFloat

getAttributeAsInteger

getAttributeAsInteger

getAttributeAsInteger

getAttributeAsLong

getAttributeAsObject

getAttributeAsObject

getAttributeAsStringsArray

getAttributeList

getAttributeNamesWithPrefix

getLogger

getORB

setAttribute

setAttribute

setAttributes