org.opennms.netmgt.config
Class PollerConfigFactory

java.lang.Object
  org.opennms.netmgt.config.PollerConfigManager
      org.opennms.netmgt.config.PollerConfigFactory

All Implemented Interfaces:

PollerConfig

public final class PollerConfigFactory
extends PollerConfigManager

This is the singleton class used to load the configuration for the OpenNMS Poller service from the poller-configuration xml file. A mapping of the configured URLs to the iplist they contain is built at init() time so as to avoid numerous file reads. 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:

James Zuo , Mike Davidson , Sowmya Nataraj , OpenNMS

Constructor Summary

PollerConfigFactory(long currentVersion, Reader reader, String localServer, boolean verifyServer)
Private constructor

Method Summary

static PollerConfig	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 xml)
static void	setInstance(PollerConfig instance)
void	update()

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

addMonitor, addPackage, enumerateMonitor, enumeratePackage, getAllPackageMatches, getConfiguration, getCriticalService, getFirstLocalPackageMatch, getFirstPackageMatch, getIpList, getNextOutageIdSql, getPackage, getRRAList, getServiceInPackage, getServiceMonitor, getServiceMonitorLocators, getServiceMonitors, getServiceSelectorForPackage, getStep, getThreads, getXmlrpc, includeURLs, interfaceInPackage, isPolled, isPolled, isPolled, isPolledLocally, isPolledLocally, monitors, nodeOutageProcessingEnabled, packages, parameters, pathOutageEnabled, pollAllIfNoCriticalServiceDefined, rebuildPackageIpListMap, releaseAllServiceMonitors, reloadXML, save, saveResponseTimeData, serviceInPackageAndEnabled, serviceMonitored, services, serviceUnresponsiveEnabled

Methods inherited from class java.lang.Object

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

Constructor Detail

PollerConfigFactory

public PollerConfigFactory(long currentVersion,
                           Reader reader,
                           String localServer,
                           boolean verifyServer)
                    throws org.exolab.castor.xml.MarshalException,
                           org.exolab.castor.xml.ValidationException,
                           IOException

Private constructor

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.

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.

saveXml

protected void saveXml(String xml)
                throws IOException

Specified by:

saveXml in class PollerConfigManager

Throws:

IOException

getInstance

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

update

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

Specified by:

update in interface PollerConfig

Specified by:

update in class PollerConfigManager

Throws:

IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException