org.opennms.netmgt.config

Class RWSConfigFactory

java.lang.Object

org.opennms.netmgt.config.RWSConfigManager

org.opennms.netmgt.config.RWSConfigFactory

All Implemented Interfaces:

RWSConfig

public final class RWSConfigFactory
extends RWSConfigManager

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.

Version:

$Id: $

Author:

James Zuo , Mike Davidson , Sowmya Nataraj , OpenNMS

Constructor Summary

Constructors

Constructor and Description
RWSConfigFactory(long currentVersion, InputStream stream) Constructor for RWSConfigFactory.

Method Summary

Modifier and Type	Method and Description
static RWSConfig	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.
protected void	saveXml(String xml) Reload the config from the default config file
static void	setInstance(RWSConfig instance) setInstance
void	update() update

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

getBase, getBaseUrl, getConfiguration, getNextStandBy, getNextStandbyUrl, getReadLock, getStanbyUrls, getStandBy, getWriteLock, hasStandbyUrl, reloadXML

Methods inherited from class java.lang.Object

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

Constructor Detail

RWSConfigFactory

public RWSConfigFactory(long currentVersion,
                        InputStream stream)
                 throws org.exolab.castor.xml.MarshalException,
                        org.exolab.castor.xml.ValidationException,
                        IOException

Constructor for RWSConfigFactory.

Parameters:

currentVersion - a long.

stream - a InputStream object.

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.

getInstance

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

setInstance

Parameters:

instance - a RWSConfig object.

saveXml

protected void saveXml(String xml)
                throws IOException

Reload the config from the default config file

Parameters:

xml - a String object.

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.

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.