org.opennms.netmgt.config

Class SnmpPeerFactory

java.lang.Object

org.opennms.netmgt.config.SnmpPeerFactory

All Implemented Interfaces:

SnmpAgentConfigFactory

Direct Known Subclasses:

ProxySnmpAgentConfigFactory

public class SnmpPeerFactory
extends Object
implements SnmpAgentConfigFactory

This class is the main repository for SNMP configuration information used by the capabilities daemon. When this class is loaded it reads the snmp configuration into memory, and uses the configuration to find the SnmpAgentConfig 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

Constructor Summary

Constructors

Constructor and Description
SnmpPeerFactory(InputStream stream) Constructor for SnmpPeerFactory.
SnmpPeerFactory(Reader rdr) Deprecated. Use code for InputStream instead to avoid character set issues
SnmpPeerFactory(org.springframework.core.io.Resource resource) Constructor for SnmpPeerFactory.
SnmpPeerFactory(String configString) A constructor that takes a config string for use mostly in tests

Method Summary

Methods

Modifier and Type	Method and Description
void	define(SnmpEventInfo info) Enhancement: Allows specific or ranges to be merged into SNMP configuration with many other attributes.
SnmpAgentConfig	getAgentConfig(InetAddress agentAddress) getAgentConfig
static File	getFile() getFile
static SnmpPeerFactory	getInstance() Return the singleton instance of this factory.
static Lock	getReadLock()
static SnmpConfig	getSnmpConfig() getSnmpConfig
static Lock	getWriteLock()
static void	init() Load the config from the default config file and create the singleton instance of this factory.
static String	marshallConfig() Creates a string containing the XML of the current SnmpConfig
static void	saveCurrent() Saves the current settings to disk
static void	saveToFile(File file)
static void	setFile(File configFile) setFile
static void	setInstance(SnmpPeerFactory singleton) setInstance

Methods inherited from class java.lang.Object

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

Constructor Detail

SnmpPeerFactory

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

Constructor for SnmpPeerFactory.

Parameters:

resource - a Resource object.

SnmpPeerFactory

public SnmpPeerFactory(Reader rdr)
                throws IOException

Deprecated. Use code for InputStream instead to avoid character set issues

Constructor for SnmpPeerFactory.

Parameters:

rdr - a Reader object.

Throws:

IOException - if any.

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

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

SnmpPeerFactory

public SnmpPeerFactory(String configString)
                throws IOException

A constructor that takes a config string for use mostly in tests

Throws:

IOException

SnmpPeerFactory

public SnmpPeerFactory(InputStream stream)

Constructor for SnmpPeerFactory.

Parameters:

stream - a InputStream object.

Method Detail

getReadLock

public static Lock getReadLock()

getWriteLock

public static Lock getWriteLock()

init

public static void init()
                 throws IOException

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.

saveCurrent

public static void saveCurrent()
                        throws IOException

Saves the current settings to disk

Throws:

IOException - if any.

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

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

saveToFile

public static void saveToFile(File file)
                       throws UnsupportedEncodingException,
                              FileNotFoundException,
                              IOException

Throws:

UnsupportedEncodingException

FileNotFoundException

IOException

getInstance

public static SnmpPeerFactory getInstance()

Return the singleton instance of this factory.

Returns:

The current factory instance.

Throws:

IllegalStateException - Thrown if the factory has not yet been initialized.

setFile

public static void setFile(File configFile)

setFile

Parameters:

configFile - a File object.

getFile

public static File getFile()
                    throws IOException

getFile

Returns:

a File object.

Throws:

IOException - if any.

setInstance

public static void setInstance(SnmpPeerFactory singleton)

setInstance

Parameters:

singleton - a SnmpPeerFactory object.

getAgentConfig

public SnmpAgentConfig getAgentConfig(InetAddress agentAddress)

getAgentConfig

Specified by:

getAgentConfig in interface SnmpAgentConfigFactory

Parameters:

agentAddress - a InetAddress object.

Returns:

a SnmpAgentConfig object.

getSnmpConfig

public static SnmpConfig getSnmpConfig()

getSnmpConfig

Returns:

a SnmpConfig object.

define

public void define(SnmpEventInfo info)

Enhancement: Allows specific or ranges to be merged into SNMP configuration with many other attributes. Uses new classes the wrap Castor-generated code to help with merging, comparing, and optimizing definitions. Thanks for your initial work on this Gerald. Puts a specific IP address with associated read-community string into the currently loaded snmp-config.xml.

Parameters:

info - a SnmpEventInfo object.

marshallConfig

public static String marshallConfig()

Creates a string containing the XML of the current SnmpConfig

Returns:

Marshalled SnmpConfig