org.opennms.netmgt.config

Class WmiPeerFactory

java.lang.Object

org.opennms.netmgt.config.WmiPeerFactory

public class WmiPeerFactory
extends Object

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

Constructor Summary

Constructors

Constructor and Description
WmiPeerFactory(InputStream stream) Constructor for WmiPeerFactory.

Method Summary

Modifier and Type	Method and Description
WmiAgentConfig	getAgentConfig(InetAddress agentInetAddress) getAgentConfig
static WmiPeerFactory	getInstance() Return the singleton instance of this factory.
static WmiConfig	getWmiConfig() getWmiConfig
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
static void	saveCurrent() Saves the current settings to disk
static void	setInstance(WmiPeerFactory singleton) setInstance
static void	setWmiConfig(WmiConfig m_config) setWmiConfig

Methods inherited from class java.lang.Object

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

Constructor Detail

WmiPeerFactory

public WmiPeerFactory(InputStream stream)
               throws org.exolab.castor.xml.MarshalException,
                      org.exolab.castor.xml.ValidationException

Constructor for WmiPeerFactory.

Parameters:

stream - a InputStream object.

Throws:

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

org.exolab.castor.xml.ValidationException - 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.

saveCurrent

public static void saveCurrent()
                        throws Exception

Saves the current settings to disk

Throws:

Exception - if saving settings to disk fails.

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 singleton)

setInstance

Parameters:

singleton - a WmiPeerFactory object.

getAgentConfig

public WmiAgentConfig getAgentConfig(InetAddress agentInetAddress)

getAgentConfig

Parameters:

agentInetAddress - a InetAddress object.

Returns:

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

getWmiConfig

public static WmiConfig getWmiConfig()

getWmiConfig

Returns:

a WmiConfig object.

setWmiConfig

public static void setWmiConfig(WmiConfig m_config)

setWmiConfig

Parameters:

m_config - a WmiConfig object.