org.opennms.netmgt.config

Class LinkdConfigFactory

java.lang.Object

org.opennms.netmgt.config.LinkdConfigManager

org.opennms.netmgt.config.LinkdConfigFactory

All Implemented Interfaces:

LinkdConfig

public final class LinkdConfigFactory
extends LinkdConfigManager

This is the singleton class used to load the configuration for the OpenNMS linkd service from the linkd-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:

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

Field Summary

Fields inherited from class org.opennms.netmgt.config.LinkdConfigManager

DEFAULT_IP_ROUTE_CLASS_NAME, m_config

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
static LinkdConfig	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.
void	reload() reload
protected void	reloadXML(InputStream stream) reloadXML
protected void	reloadXML(Reader reader) Deprecated.
void	save() Saves the current in-memory configuration to disk
protected void	saveXml(String xml) saveXml
static void	setInstance(LinkdConfig instance) setInstance
void	update() update

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

enableDiscoveryDownload, enumeratePackage, forceIpRouteDiscoveryOnEthernet, getAllPackageMatches, getConfiguration, getDefaultIpRouteClassName, getDiscoveryLinkInterval, getFirstPackageMatch, getInitialSleepTime, getIpList, getIpRouteClassName, getPackage, getReadLock, getSnmpPollInterval, getThreads, getVlanClassName, getWriteLock, hasClassName, hasIpRouteClassName, isAutoDiscoveryEnabled, isInterfaceInPackage, isInterfaceInPackageRange, isVlanDiscoveryEnabled, saveRouteTable, saveStpInterfaceTable, saveStpNodeTable, updateIpRouteClassNames, updatePackageIpListMap, updateUrlIpMap, updateVlanClassNames, useBridgeDiscovery, useCdpDiscovery, useIpRouteDiscovery, useLldpDiscovery, useOspfDiscovery

Methods inherited from class java.lang.Object

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

Constructor Detail

LinkdConfigFactory

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

Constructor for LinkdConfigFactory.

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.

saveXml

protected void saveXml(String xml)
                throws IOException

saveXml

Specified by:

saveXml in class LinkdConfigManager

Parameters:

xml - a String object.

Throws:

IOException - if any.

getInstance

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

setInstance

Parameters:

instance - a LinkdConfig object.

reload

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

reload

Throws:

IOException - if any.

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

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

update

public void update()

update

Specified by:

update in interface LinkdConfig

Specified by:

update in class LinkdConfigManager

reloadXML

protected void reloadXML(InputStream stream)
                  throws org.exolab.castor.xml.MarshalException,
                         org.exolab.castor.xml.ValidationException,
                         IOException

reloadXML

Parameters:

stream - a InputStream object.

Throws:

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

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

IOException - if any.

save

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

Saves the current in-memory configuration to disk

Throws:

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

IOException - if any.

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

reloadXML

@Deprecated
protected void reloadXML(Reader reader)
                  throws org.exolab.castor.xml.MarshalException,
                         org.exolab.castor.xml.ValidationException,
                         IOException

Deprecated.

reloadXML

Parameters:

reader - a Reader object.

Throws:

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

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

IOException - if any.