org.opennms.netmgt.config
Class PollOutagesConfigFactory

java.lang.Object
  org.opennms.netmgt.config.PollOutagesConfigManager
      org.opennms.netmgt.config.PollOutagesConfigFactory

All Implemented Interfaces:

PollOutagesConfig

public final class PollOutagesConfigFactory
extends PollOutagesConfigManager

This is the singleton class used to load the configuration for the poller outages from the poll-outages 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

Constructor Summary

PollOutagesConfigFactory(Reader rdr)

Method Summary

static PollOutagesConfigFactory	getInstance() Return the singleton instance of this factory.
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
protected void	saveXML(String xmlString)
static void	setInstance(PollOutagesConfigFactory instance)
void	update()

Methods inherited from class org.opennms.netmgt.config.PollOutagesConfigManager

addOutage, getConfig, getEndOfOutage, getEndOfOutage, getInterfaces, getNodeIds, getOutage, getOutages, getOutageTimes, getOutageType, isCurTimeInOutage, isCurTimeInOutage, isInterfaceInOutage, isInterfaceInOutage, isNodeIdInOutage, isNodeIdInOutage, isTimeInOutage, isTimeInOutage, isTimeInOutage, removeOutage, removeOutage, replaceOutage, saveCurrent, setConfig

Methods inherited from class java.lang.Object

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

Constructor Detail

PollOutagesConfigFactory

public PollOutagesConfigFactory(Reader rdr)
                         throws org.exolab.castor.xml.MarshalException,
                                org.exolab.castor.xml.ValidationException

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

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 PollOutagesConfigFactory 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(PollOutagesConfigFactory instance)

saveXML

protected void saveXML(String xmlString)
                throws IOException,
                       org.exolab.castor.xml.MarshalException,
                       org.exolab.castor.xml.ValidationException

Specified by:

saveXML in class PollOutagesConfigManager

Throws:

IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

update

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

Specified by:

update in interface PollOutagesConfig

Specified by:

update in class PollOutagesConfigManager

Throws:

IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException