OpenNMS API 1.2.3

org.opennms.netmgt.config
Class ScriptdConfigFactory

java.lang.Object
  extended byorg.opennms.netmgt.config.ScriptdConfigFactory

public final class ScriptdConfigFactory
extends java.lang.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.

Author:
Jim Doble , OpenNMS

Field Summary
private  ScriptdConfiguration m_config
          The config class loaded from the config file
private static boolean m_loaded
          This member is set to true if the configuration file has been loaded.
private static ScriptdConfigFactory m_singleton
          The singleton instance of this factory
 
Constructor Summary
private ScriptdConfigFactory(java.lang.String configFile)
          Private constructor
 
Method Summary
 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
 

Field Detail

m_singleton

private static ScriptdConfigFactory m_singleton
The singleton instance of this factory


m_config

private ScriptdConfiguration m_config
The config class loaded from the config file


m_loaded

private static boolean m_loaded
This member is set to true if the configuration file has been loaded.

Constructor Detail

ScriptdConfigFactory

private ScriptdConfigFactory(java.lang.String configFile)
                      throws java.io.IOException,
                             org.exolab.castor.xml.MarshalException,
                             org.exolab.castor.xml.ValidationException
Private constructor

Throws:
java.io.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.
Method Detail

init

public static void init()
                 throws java.io.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:
java.io.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.

reload

public static void reload()
                   throws java.io.IOException,
                          org.exolab.castor.xml.MarshalException,
                          org.exolab.castor.xml.ValidationException
Reload the config from the default config file

Throws:
java.io.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.

getInstance

public static ScriptdConfigFactory getInstance()
Return the singleton instance of this factory.

Returns:
The current factory instance.
Throws:
java.lang.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

OpenNMS API 1.2.3

Generated by eevans on May 29 2005 2015.