org.opennms.netmgt.config
Class ActiondConfigFactory

java.lang.Object
  org.opennms.netmgt.config.ActiondConfigFactory

public final class ActiondConfigFactory
extends Object

This is the singleton class used to load the configuration for the OpenNMS Actiond from the actiond-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:

Sowmya Nataraj , OpenNMS

Method Summary

static ActiondConfigFactory	getInstance() Return the singleton instance of this factory.
int	getMaxOutstandingActions() Return the maximum number of processes that run simultaneously.
long	getMaxProcessTime() Return the maximum time that can be taken by a process.
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.

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.

getInstance

public static ActiondConfigFactory getInstance()

Return the singleton instance of this factory.

Returns:

The current factory instance.

Throws:

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

getMaxProcessTime

public long getMaxProcessTime()

Return the maximum time that can be taken by a process.

Returns:

the maximum time that can be taken by a process

getMaxOutstandingActions

public int getMaxOutstandingActions()

Return the maximum number of processes that run simultaneously.

Returns:

the maximum number of processes that run simultaneously