Package org.opennms.netmgt.config.api

Interface SnmpAgentConfigFactory

All Known Implementing Classes:

ProxySnmpAgentConfigFactory, SnmpPeerFactory

public interface SnmpAgentConfigFactory

Method Summary

Modifier and Type	Method	Description
SnmpAgentConfig	getAgentConfig(java.net.InetAddress address, java.lang.String location)	getAgentConfig
SnmpAgentConfig	getAgentConfigFromProfile(SnmpProfile snmpProfile, java.net.InetAddress address)	getAgentConfig for a given profile
java.util.List<SnmpProfile>	getProfiles()	Get all the SNMP profiles from SNMP Config.
boolean	removeFromDefinition(java.net.InetAddress ipAddress, java.lang.String location, java.lang.String module)	Remove an address from the definitions.
void	saveAgentConfigAsDefinition(SnmpAgentConfig snmpAgentConfig, java.lang.String location, java.lang.String module)	Create definition and merge this definition into Current SNMP Config.
void	saveDefinition(Definition definition)	Merge this definition into current config.

Method Detail

getAgentConfig

SnmpAgentConfig getAgentConfig(java.net.InetAddress address,
                               java.lang.String location)

getAgentConfig

Parameters:

address - a InetAddress object.

location - a String object.

Returns:

a SnmpAgentConfig object.

getAgentConfigFromProfile

SnmpAgentConfig getAgentConfigFromProfile(SnmpProfile snmpProfile,
                                          java.net.InetAddress address)

getAgentConfig for a given profile

Parameters:

snmpProfile - a @Definition object.

address - a InetAddress object.

Returns:

a SnmpAgentConfig object.

saveDefinition

void saveDefinition(Definition definition)

Merge this definition into current config.

Parameters:

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

removeFromDefinition

boolean removeFromDefinition(java.net.InetAddress ipAddress,
                             java.lang.String location,
                             java.lang.String module)

Remove an address from the definitions.

Parameters:

ipAddress - 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

void saveAgentConfigAsDefinition(SnmpAgentConfig snmpAgentConfig,
                                 java.lang.String location,
                                 java.lang.String module)

Create definition and merge this definition into Current SNMP Config.

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

java.util.List<SnmpProfile> getProfiles()

Get all the SNMP profiles from SNMP Config.

Returns:

a List of snmp profiles.