org.opennms.netmgt.config

Class ThresholdingConfigFactory

java.lang.Object

org.opennms.netmgt.config.ThresholdingConfigFactory

public final class ThresholdingConfigFactory
extends Object

This class is the main repository for thresholding configuration information used by the thresholding daemon.. When this class is loaded it reads the thresholding configuration into memory. 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:

Mike Davidson , OpenNMS , Mike Davidson , OpenNMS

Constructor Summary

Constructors

Constructor and Description
ThresholdingConfigFactory(InputStream stream) Constructor for ThresholdingConfigFactory.

Method Summary

Modifier and Type	Method and Description
Group	getGroup(String groupName) getGroup
Collection<String>	getGroupNames() getGroupNames
static ThresholdingConfigFactory	getInstance() Return the singleton instance of this factory.
String	getRrdRepository(String groupName) Retrieves the configured path to the RRD file repository for the specified thresholding group.
Collection<Basethresholddef>	getThresholds(String groupName) Retrieves a Collection object consisting of all the org.opennms.netmgt.config.Threshold objects which make up the specified thresholding group.
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	saveCurrent() Saves the current in-memory configuration to disk and reloads
static void	setInstance(ThresholdingConfigFactory instance) setInstance
void	update() update

Methods inherited from class java.lang.Object

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

Constructor Detail

ThresholdingConfigFactory

public ThresholdingConfigFactory(InputStream stream)
                          throws org.exolab.castor.xml.MarshalException,
                                 org.exolab.castor.xml.ValidationException

Constructor for ThresholdingConfigFactory.

Parameters:

stream - a InputStream object.

Throws:

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.

getInstance

public static ThresholdingConfigFactory 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(ThresholdingConfigFactory instance)

setInstance

Parameters:

instance - a ThresholdingConfigFactory object.

getRrdRepository

public String getRrdRepository(String groupName)

Retrieves the configured path to the RRD file repository for the specified thresholding group.

Parameters:

groupName - Group name to lookup

Returns:

RRD repository path.

Throws:

IllegalArgumentException - if group name does not exist in the group map.

getGroup

public Group getGroup(String groupName)

getGroup

Parameters:

groupName - a String object.

Returns:

a Group object.

getThresholds

public Collection<Basethresholddef> getThresholds(String groupName)

Retrieves a Collection object consisting of all the org.opennms.netmgt.config.Threshold objects which make up the specified thresholding group.

Parameters:

groupName - Group name to lookup

Returns:

Collection consisting of all the Threshold objects for the specified group..

Throws:

IllegalArgumentException - if group name does not exist in the group map.

getGroupNames

public Collection<String> getGroupNames()

getGroupNames

Returns:

a Collection object.

saveCurrent

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

Saves the current in-memory configuration to disk and reloads

Throws:

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

IOException - if any.

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

update

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

update

Throws:

IOException - if any.

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

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