|
OpenNMS API 1.2.3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opennms.netmgt.config.ScriptdConfigFactory
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.
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 |
private static ScriptdConfigFactory m_singleton
private ScriptdConfiguration m_config
private static boolean m_loaded
Constructor Detail |
private ScriptdConfigFactory(java.lang.String configFile) throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
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 |
public static void init() throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
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.public static void reload() throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
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.public static ScriptdConfigFactory getInstance()
java.lang.IllegalStateException
- Thrown if the factory has not yet been initialized.public Engine[] getEngines()
public StartScript[] getStartScripts()
public StopScript[] getStopScripts()
public ReloadScript[] getReloadScripts()
public EventScript[] getEventScripts()
|
OpenNMS API 1.2.3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |