org.opennms.netmgt.config

Class SnmpInterfacePollerConfigFactory

java.lang.Object

org.opennms.netmgt.config.SnmpInterfacePollerConfigManager

org.opennms.netmgt.config.SnmpInterfacePollerConfigFactory

All Implemented Interfaces:

SnmpInterfacePollerConfig

public final class SnmpInterfacePollerConfigFactory
extends SnmpInterfacePollerConfigManager

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 IP list 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.

Version:

$Id: $

Author:

James Zuo , Mike Davidson , Sowmya Nataraj , OpenNMS , James Zuo , Mike Davidson , Sowmya Nataraj , OpenNMS , James Zuo , Mike Davidson , Sowmya Nataraj , OpenNMS , James Zuo , Mike Davidson , Sowmya Nataraj , OpenNMS

Constructor Summary

Constructors

Constructor and Description
SnmpInterfacePollerConfigFactory(long currentVersion, InputStream stream, String localServer, boolean verifyServer) Constructor for SnmpInterfacePollerConfigFactory.

Method Summary

Modifier and Type	Method and Description
static SnmpInterfacePollerConfig	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) saveXml
static void	setInstance(SnmpInterfacePollerConfig instance) setInstance
void	update() update

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

addPackage, enumeratePackage, getAllPackageMatches, getConfiguration, getCriteria, getCriticalServiceIds, getInterfaceOnPackage, getInterval, getInterval, getIpList, getMaxVarsPerPdu, getPackage, getPackageForAddress, getPackageName, getPort, getRetries, getService, getStatus, getThreads, getTimeout, hasMaxVarsPerPdu, hasPort, hasRetries, hasTimeout, includeURLs, interfaceInPackage, packages, rebuildPackageIpListMap, reloadXML, save, useCriteriaFilters

Methods inherited from class java.lang.Object

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

Constructor Detail

SnmpInterfacePollerConfigFactory

public SnmpInterfacePollerConfigFactory(long currentVersion,
                                        InputStream stream,
                                        String localServer,
                                        boolean verifyServer)
                                 throws org.exolab.castor.xml.MarshalException,
                                        org.exolab.castor.xml.ValidationException,
                                        IOException

Constructor for SnmpInterfacePollerConfigFactory.

Parameters:

currentVersion - a long.

stream - a InputStream object.

localServer - a String object.

verifyServer - a boolean.

Throws:

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

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

IOException - 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.

saveXml

protected void saveXml(String xml)
                throws IOException

saveXml

Specified by:

saveXml in class SnmpInterfacePollerConfigManager

Parameters:

xml - a String object.

Throws:

IOException - if any.

getInstance

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

setInstance

Parameters:

instance - a SnmpInterfacePollerConfig object.

update

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

update

Specified by:

update in interface SnmpInterfacePollerConfig

Specified by:

update in class SnmpInterfacePollerConfigManager

Throws:

IOException - if any.

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

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