org.opennms.netmgt.config

Class ThreshdConfigFactory

java.lang.Object

org.opennms.netmgt.config.ThreshdConfigManager

org.opennms.netmgt.config.ThreshdConfigFactory

public final class ThreshdConfigFactory
extends ThreshdConfigManager

This is the singleton class used to load the configuration for the OpenNMS Thresholding Daemon from the threshd-configuration xml file. A mapping of the configured URLs to the iplist they contain is built at init() time so as to avoid numerous file reads. 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:

Mike Davidson , Sowmya Nataraj , OpenNMS

Field Summary

Fields inherited from class org.opennms.netmgt.config.ThreshdConfigManager

m_config, m_localServer, m_verifyServer

Constructor Summary

Constructors

Constructor and Description
ThreshdConfigFactory(InputStream stream, String localServer, boolean verifyServer) Constructor for ThreshdConfigFactory.

Method Summary

Modifier and Type	Method and Description
static ThreshdConfigFactory	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
void	reloadXML() reloadXML
protected void	saveXML(String xmlString) saveXML
static void	setInstance(ThreshdConfigFactory configFactory) setInstance

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

createPackageIpListMap, createUrlIpMap, getConfiguration, getPackage, interfaceInPackage, rebuildPackageIpListMap, saveCurrent, serviceInPackageAndEnabled

Methods inherited from class java.lang.Object

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

Constructor Detail

ThreshdConfigFactory

public ThreshdConfigFactory(InputStream stream,
                            String localServer,
                            boolean verifyServer)
                     throws IOException,
                            org.exolab.castor.xml.MarshalException,
                            org.exolab.castor.xml.ValidationException

Constructor for ThreshdConfigFactory.

Parameters:

stream - a InputStream object.

localServer - a String object.

verifyServer - a boolean.

Throws:

IOException - if any.

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.

reloadXML

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

reloadXML

Specified by:

reloadXML in class ThreshdConfigManager

Throws:

IOException - if any.

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

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

saveXML

protected void saveXML(String xmlString)
                throws IOException

saveXML

Specified by:

saveXML in class ThreshdConfigManager

Parameters:

xmlString - a String object.

Throws:

IOException - if any.

getInstance

public static ThreshdConfigFactory 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(ThreshdConfigFactory configFactory)

setInstance

Parameters:

configFactory - a ThreshdConfigFactory object.