org.opennms.netmgt.config

Class OpennmsServerConfigFactory

java.lang.Object

org.opennms.netmgt.config.OpennmsServerConfigManager

org.opennms.netmgt.config.OpennmsServerConfigFactory

public final class OpennmsServerConfigFactory
extends OpennmsServerConfigManager

This is the singleton class used to load the configuration for the OpenNMS OutageManager from the outage-configuration xml file. Note: Users of this class should make sure the init() is called before calling any other method to ensure the config is loaded before accessing other convenience methods.

Author:

James Zuo

Constructor Summary

Constructors

Constructor and Description
OpennmsServerConfigFactory(InputStream is) Constructor for OpennmsServerConfigFactory.

Method Summary

Methods

Modifier and Type	Method and Description
static OpennmsServerConfigFactory	getInstance() Return the singleton instance of this factory.
static void	init() Load the config from the default config file and create the singleton instance of this factory.
static void	reload() Reload the config from the default config file
static void	setInstance(OpennmsServerConfigFactory instance) setInstance

Methods inherited from class org.opennms.netmgt.config.OpennmsServerConfigManager

getDefaultCriticalPathIp, getDefaultCriticalPathRetries, getDefaultCriticalPathService, getDefaultCriticalPathTimeout, getServerName, verifyServer

Methods inherited from class java.lang.Object

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

Constructor Detail

OpennmsServerConfigFactory

public OpennmsServerConfigFactory(InputStream is)
                           throws org.exolab.castor.xml.MarshalException,
                                  org.exolab.castor.xml.ValidationException

Constructor for OpennmsServerConfigFactory.

Parameters:

is - a InputStream object.

Throws:

org.exolab.castor.xml.MarshalException - if any.

org.exolab.castor.xml.ValidationException - if any.

Method Detail

init

public static void init()
                 throws IOException,
                        org.exolab.castor.xml.MarshalException,
                        org.exolab.castor.xml.ValidationException

Load the config from the default config file and create the singleton instance of this factory.

Throws:

IOException - Thrown if the specified config file cannot be read

org.exolab.castor.xml.MarshalException - Thrown if the file does not conform to the schema.

org.exolab.castor.xml.ValidationException - Thrown if the contents do not match the required schema.

IOException - if any.

org.exolab.castor.xml.MarshalException - if any.

org.exolab.castor.xml.ValidationException - if any.

reload

public static void reload()
                   throws IOException,
                          org.exolab.castor.xml.MarshalException,
                          org.exolab.castor.xml.ValidationException

Reload the config from the default config file

Throws:

IOException - Thrown if the specified config file cannot be read/loaded

org.exolab.castor.xml.MarshalException - Thrown if the file does not conform to the schema.

org.exolab.castor.xml.ValidationException - Thrown if the contents do not match the required schema.

IOException - if any.

org.exolab.castor.xml.MarshalException - if any.

org.exolab.castor.xml.ValidationException - if any.

getInstance

public static OpennmsServerConfigFactory getInstance()

Return the singleton instance of this factory.

Returns:

The current factory instance.

Throws:

IllegalStateException - Thrown if the factory has not yet been initialized.

setInstance

public static void setInstance(OpennmsServerConfigFactory instance)

setInstance

Parameters:

instance - a OpennmsServerConfigFactory object.