Package 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	Description
SnmpPeerFactory(org.springframework.core.io.Resource resource)	Constructor for SnmpPeerFactory.

Method Summary

Modifier and Type	Method	Description
void	define(SnmpEventInfo info)	Enhancement: Allows specific or ranges to be merged into SNMP configuration with many other attributes.
SnmpAgentConfig	getAgentConfig(InetAddress agentAddress)
SnmpAgentConfig	getAgentConfig(InetAddress agentInetAddress, int requestedSnmpVersion)
SnmpAgentConfig	getAgentConfig(InetAddress agentAddress, String location)	getAgentConfig
SnmpAgentConfig	getAgentConfig(InetAddress agentInetAddress, String location, int requestedSnmpVersion)
SnmpAgentConfig	getAgentConfigFromProfile(SnmpProfile snmpProfile, InetAddress address)	getAgentConfig for a given profile
static File	getFile()
static SnmpPeerFactory	getInstance()	Load the config from the default config file and create the singleton instance of this factory.
List<SnmpProfile>	getProfiles()	Get all the SNMP profiles from SNMP Config.
protected Lock	getReadLock()
SnmpConfig	getSnmpConfig()	getSnmpConfig
String	getSnmpConfigAsString()	Creates a string containing the XML of the current SnmpConfig
int	getVersionCode(Definition def, SnmpConfig config, int requestedSnmpVersion)
protected Lock	getWriteLock()
static void	init()
boolean	removeFromDefinition(InetAddress inetAddress, String location, String module)	Remove an address from the definitions.
void	saveAgentConfigAsDefinition(SnmpAgentConfig snmpAgentConfig, String location, String module)	Create definition and merge this definition into Current SNMP Config.
void	saveCurrent()	Saves the current settings to disk
void	saveDefinition(Definition definition)	Merge this definition into current config.
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.

Method Detail

getReadLock

protected Lock getReadLock()

getWriteLock

protected Lock getWriteLock()

init

public static void init()
                 throws IOException

Throws:

IOException

getInstance

public static SnmpPeerFactory getInstance()

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

setInstance

public static void setInstance(SnmpPeerFactory singleton)

setInstance

Parameters:

singleton - a SnmpPeerFactory object.

getFile

public static File getFile()
                    throws IOException

Throws:

IOException

setFile

public static void setFile(File configFile)

setFile

Parameters:

configFile - a File object.

saveCurrent

public void saveCurrent()
                 throws IOException

Saves the current settings to disk

Throws:

IOException - if any.

saveToFile

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

Throws:

UnsupportedEncodingException

FileNotFoundException

IOException

getAgentConfig

public SnmpAgentConfig getAgentConfig(InetAddress agentAddress)

getAgentConfig

public SnmpAgentConfig getAgentConfig(InetAddress agentAddress,
                                      String location)

Description copied from interface: SnmpAgentConfigFactory

getAgentConfig

Specified by:

getAgentConfig in interface SnmpAgentConfigFactory

Parameters:

agentAddress - a InetAddress object.

location - a String object.

Returns:

a SnmpAgentConfig object.

getAgentConfigFromProfile

public SnmpAgentConfig getAgentConfigFromProfile(SnmpProfile snmpProfile,
                                                 InetAddress address)

Description copied from interface: SnmpAgentConfigFactory

getAgentConfig for a given profile

Specified by:

getAgentConfigFromProfile in interface SnmpAgentConfigFactory

Parameters:

snmpProfile - a @Definition object.

address - a InetAddress object.

Returns:

a SnmpAgentConfig object.

getAgentConfig

public SnmpAgentConfig getAgentConfig(InetAddress agentInetAddress,
                                      int requestedSnmpVersion)

getAgentConfig

public SnmpAgentConfig getAgentConfig(InetAddress agentInetAddress,
                                      String location,
                                      int requestedSnmpVersion)

getVersionCode

public int getVersionCode(Definition def,
                          SnmpConfig config,
                          int requestedSnmpVersion)

getSnmpConfig

public 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 JAXB-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.

saveDefinition

public void saveDefinition(Definition definition)

Description copied from interface: SnmpAgentConfigFactory

Merge this definition into current config.

Specified by:

saveDefinition in interface SnmpAgentConfigFactory

Parameters:

definition - Definition that has SNMP parameters associated with a specific IP address or Range.

removeFromDefinition

public boolean removeFromDefinition(InetAddress inetAddress,
                                    String location,
                                    String module)

Description copied from interface: SnmpAgentConfigFactory

Remove an address from the definitions.

Specified by:

removeFromDefinition in interface SnmpAgentConfigFactory

Parameters:

inetAddress - IP address that needs to be removed from definition.

location - location at which this ipaddress belongs.

module - module from which the definition is getting removed.

saveAgentConfigAsDefinition

public void saveAgentConfigAsDefinition(SnmpAgentConfig snmpAgentConfig,
                                        String location,
                                        String module)

Description copied from interface: SnmpAgentConfigFactory

Create definition and merge this definition into Current SNMP Config.

Specified by:

saveAgentConfigAsDefinition in interface SnmpAgentConfigFactory

Parameters:

snmpAgentConfig - agentConfig that might have succeeded in SNMP walk/get.

location - the location that this agent config belongs.

module - module from which the definition is getting saved.

getProfiles

public List<SnmpProfile> getProfiles()

Description copied from interface: SnmpAgentConfigFactory

Get all the SNMP profiles from SNMP Config.

Specified by:

getProfiles in interface SnmpAgentConfigFactory

Returns:

a List of snmp profiles.

getSnmpConfigAsString

public String getSnmpConfigAsString()

Creates a string containing the XML of the current SnmpConfig

Returns:

Marshalled SnmpConfig