org.opennms.netmgt.config

Class ScriptdConfigFactory

java.lang.Object

org.opennms.netmgt.config.ScriptdConfigFactory

public final class ScriptdConfigFactory
extends Object

This is the singleton class used to load the configuration for the OpenNMS Scriptd from the scriptd-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.

Version:

$Id: $

Author:

Jim Doble , OpenNMS , Jim Doble , OpenNMS

Method Summary

Modifier and Type	Method and Description
Engine[]	getEngines() Return the array of configured engines.
EventScript[]	getEventScripts() Return the array of configured event scripts.
static ScriptdConfigFactory	getInstance() Return the singleton instance of this factory.
ReloadScript[]	getReloadScripts() Return the array of reload scripts.
StartScript[]	getStartScripts() Return the array of start scripts.
StopScript[]	getStopScripts() Return the array of stop scripts.
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

Methods inherited from class java.lang.Object

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

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 ScriptdConfigFactory getInstance()

Return the singleton instance of this factory.

Returns:

The current factory instance.

Throws:

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

getEngines

public Engine[] getEngines()

Return the array of configured engines.

Returns:

the array of configured engines

getStartScripts

public StartScript[] getStartScripts()

Return the array of start scripts.

Returns:

the array of start scripts

getStopScripts

public StopScript[] getStopScripts()

Return the array of stop scripts.

Returns:

the array of stop scripts

getReloadScripts

public ReloadScript[] getReloadScripts()

Return the array of reload scripts.

Returns:

the array of reload scripts

getEventScripts

public EventScript[] getEventScripts()

Return the array of configured event scripts.

Returns:

the array of configured event scripts