org.opennms.netmgt.config

Class WmiPeerFactory

java.lang.Object

org.opennms.core.xml.AbstractCastorConfigDao<K,V>

org.opennms.core.xml.AbstractWritableCastorConfigDao<WmiConfig,WmiConfig>

org.opennms.netmgt.config.WmiPeerFactory

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean

public class WmiPeerFactory
extends AbstractWritableCastorConfigDao<WmiConfig,WmiConfig>

This class is the main repository for WMI configuration information used by the capabilities daemon. When this class is loaded it reads the WMI configuration into memory, and uses the configuration to find the WmiAgentConfig objects for specific addresses. If an address cannot be located in the configuration then a default peer instance is returned to the caller. 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:

David Hustace , Weave , Gerald Turner , Matt Raykowski

Nested Class Summary

Nested classes/interfaces inherited from class org.opennms.core.xml.AbstractCastorConfigDao

AbstractCastorConfigDao.CastorReloadCallback

Constructor Summary

Constructors

Constructor and Description
WmiPeerFactory()
WmiPeerFactory(org.springframework.core.io.Resource resource) Create a PollOutagesConfigFactory using the specified Spring resource.

Method Summary

Modifier and Type	Method and Description
WmiAgentConfig	getAgentConfig(InetAddress agentInetAddress) getAgentConfig
WmiConfig	getConfig()
static WmiPeerFactory	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	optimize() Combine specific and range elements so that WMIPeerFactory has to spend less time iterating all these elements.
static void	reload() Reload the config from the default config file
static void	setInstance(WmiPeerFactory instance) setInstance
WmiConfig	translateConfig(WmiConfig config) translateConfig

Methods inherited from class org.opennms.core.xml.AbstractWritableCastorConfigDao

getObject, getReadLock, getWriteLock, saveCurrent, update

Methods inherited from class org.opennms.core.xml.AbstractCastorConfigDao

afterPropertiesSet, createLoadedLogMessage, getConfigResource, getContainer, getDescription, getReloadCheckInterval, loadConfig, setConfigResource, setReloadCheckInterval

Methods inherited from class java.lang.Object

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

Constructor Detail

WmiPeerFactory

public WmiPeerFactory()

WmiPeerFactory

public WmiPeerFactory(org.springframework.core.io.Resource resource)

Create a PollOutagesConfigFactory using the specified Spring resource.

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.

getInstance

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

setInstance

Parameters:

instance - a PollOutagesConfigFactory object.

translateConfig

public WmiConfig translateConfig(WmiConfig config)

Description copied from class: AbstractCastorConfigDao

translateConfig

Specified by:

translateConfig in class AbstractCastorConfigDao<WmiConfig,WmiConfig>

Parameters:

config - a K object.

Returns:

a V object.

getConfig

public WmiConfig getConfig()

optimize

public void optimize()
              throws UnknownHostException

Combine specific and range elements so that WMIPeerFactory has to spend less time iterating all these elements. TODO This really should be pulled up into PeerFactory somehow, but I'm not sure how (given that "Definition" is different for both SNMP and WMI. Maybe some sort of visitor methodology would work. The basic logic should be fine as it's all IP address manipulation Calls should be preceded by a getWriteLock().lock() and wrapped in a try / finally block with getWriteLock().unlock().

Throws:

UnknownHostException

getAgentConfig

public WmiAgentConfig getAgentConfig(InetAddress agentInetAddress)

getAgentConfig

Parameters:

agentInetAddress - a InetAddress object.

Returns:

a org.opennms.protocols.wmi.WmiAgentConfig object.