com.redhat.rhn.common.conf

Class Config

java.lang.Object

com.redhat.rhn.common.conf.Config

public class Config
extends java.lang.Object

The Config class acts as an abstraction layer between our configuration system, and the actual implementation. The basic idea is that there is a global config, but you can instantiate one of your own if you want. This layer insulates us from changing the underlying implementation.

Config files are properties, with /usr/share/rhn/config-defaults/rhn.conf setting defaults that can be overridden by /etc/rhn/rhn.conf.

Constructor Summary

Constructors

Constructor and Description
Config() public constructor.

Method Summary

Modifier and Type	Method and Description
void	addPath(java.lang.String path) Add a path to the config object for parsing
boolean	containsKey(java.lang.String name)
static Config	get() static method to get the singleton Config option
boolean	getBoolean(java.lang.String s) get the config entry for string s
static java.lang.String	getDefaultConfigFilePath() Get the path to the rhn.conf file we use.
int	getInt(java.lang.String s) get the config entry for string s
int	getInt(java.lang.String s, int defaultValue) get the config entry for string s, if no value is found return the defaultValue specified.
java.lang.Integer	getInteger(java.lang.String s) get the config entry for string s
java.util.List<java.lang.String>	getList(java.lang.String name) Parses a comma-delimited list of values as a java.util.List
java.util.Properties	getNamespaceProperties(java.lang.String namespace) Returns a subset of the properties for the given namespace.
java.lang.String	getString(java.lang.String value) get the config entry for string s
java.lang.String	getString(java.lang.String name, java.lang.String defValue) Get the configuration entry for the given string name.
java.lang.String[]	getStringArray(java.lang.String s) get the config entry for string s
void	parseFiles() Parse all of the added files.
void	remove(java.lang.String name) remove the config entry for key
void	setBoolean(java.lang.String s, java.lang.String b) set the config entry for string name
java.lang.String	setString(java.lang.String name, java.lang.String value) get the config entry for string name

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Config

public Config()
       throws ConfigException

public constructor. Rereads config entries every time it is called.

Throws:

ConfigException - error from the Configuration layers. the jakarta commons conf system just throws Exception, which makes it hard to react. sometioes it is an IOExceptions, sometimes a SAXParserException, sometimes a VindictiveException. so we just turn them into our own exception type and toss them up. as we discover ones we might meaningfully want to react to, we can specilize ConfigException and catch those

Method Detail

addPath

public void addPath(java.lang.String path)

Add a path to the config object for parsing

Parameters:

path - The path to add

get

public static Config get()

static method to get the singleton Config option

Returns:

the config option

getDefaultConfigFilePath

public static java.lang.String getDefaultConfigFilePath()

Get the path to the rhn.conf file we use.

Returns:

String path.

getString

public java.lang.String getString(java.lang.String name,
                                  java.lang.String defValue)

Get the configuration entry for the given string name. If the value is null, then return the given defValue. defValue can be null as well.

Parameters:

name - name of property

defValue - default value for property if it is null.

Returns:

the value of the property with the given name, or defValue.

containsKey

public boolean containsKey(java.lang.String name)

Parameters:

name - Key to check for

Returns:

true if the config contains key

getString

public java.lang.String getString(java.lang.String value)

get the config entry for string s

Parameters:

value - string to get the value of

Returns:

the value

getInt

public int getInt(java.lang.String s)

get the config entry for string s

Parameters:

s - string to get the value of

Returns:

the value

getInt

public int getInt(java.lang.String s,
                  int defaultValue)

get the config entry for string s, if no value is found return the defaultValue specified.

Parameters:

s - string to get the value of

defaultValue - Default value if entry is not found.

Returns:

the value

getInteger

public java.lang.Integer getInteger(java.lang.String s)

get the config entry for string s

Parameters:

s - string to get the value of

Returns:

the value

getList

public java.util.List<java.lang.String> getList(java.lang.String name)

Parses a comma-delimited list of values as a java.util.List

Parameters:

name - config entry name

Returns:

instance of java.util.List populated with config values

getStringArray

public java.lang.String[] getStringArray(java.lang.String s)

get the config entry for string s

Parameters:

s - string to get the value of

Returns:

the value

setString

public java.lang.String setString(java.lang.String name,
                                  java.lang.String value)

get the config entry for string name

Parameters:

name - string to set the value of

value - new value

Returns:

the previous value of the property

remove

public void remove(java.lang.String name)

remove the config entry for key

Parameters:

name - key to remove

getBoolean

public boolean getBoolean(java.lang.String s)

get the config entry for string s

Parameters:

s - string to get the value of

Returns:

the value

setBoolean

public void setBoolean(java.lang.String s,
                       java.lang.String b)

set the config entry for string name

Parameters:

s - string to set the value of

b - new value

parseFiles

public void parseFiles()

Parse all of the added files.

getNamespaceProperties

public java.util.Properties getNamespaceProperties(java.lang.String namespace)

Returns a subset of the properties for the given namespace. This is not a particularly fast method and should be used only at startup or some other discreet time. Repeated calls to this method are guaranteed to be slow.

Parameters:

namespace - Namespace of properties to be returned.

Returns:

subset of the properties that begin with the given namespace.