org.opennms.netmgt.linkd

Class SnmpCollection

java.lang.Object

org.opennms.netmgt.linkd.SnmpCollection

All Implemented Interfaces:

Runnable, ReadyRunnable

public final class SnmpCollection
extends Object
implements ReadyRunnable

This class is designed to collect the necessary SNMP information from the target address and store the collected information. When the class is initially constructed no information is collected. The SNMP Session creating and collection occurs in the main run method of the instance. This allows the collection to occur in a thread if necessary.

Field Summary

Fields

Modifier and Type	Field and Description
CdpCacheTable	m_cdpCache
CdpGlobalGroup	m_cdpGlobalGroup The CdpCache table information
CdpInterfaceTable	m_cdpInterface
IpNetToMediaTable	m_ipNetToMedia The ipnettomedia table information
SnmpTable<SnmpStore>	m_ipRoute The ipRoute table information
IsisCircTable	m_isisCircTable
IsisISAdjTable	m_isisISAdjTable
IsIsSystemObjectGroup	m_isisSystemObjectGroup
LldpLocalGroup	m_lldpLocalGroup
LldpLocTable	m_lldpLocTable
LldpRemTable	m_lldpRemTable
MtxrWlRtabTable	m_mtxrWlRtabTable
OspfGeneralGroup	m_ospfGeneralGroup
OspfNbrTable	m_ospfNbrTable
Map<OnmsVlan,SnmpVlanCollection>	m_snmpVlanCollection The list of VLAN SNMP collection object
SnmpTable<SnmpStore>	m_vlanTable The VLAN Table information

Constructor Summary

Constructors

Constructor and Description
SnmpCollection(Linkd linkd, int nodeid, SnmpAgentConfig config) Constructs a new SNMP collector for a node using the passed interface as the collection point.

Method Summary

Methods

Modifier and Type	Method and Description
void	collectBridge(boolean bridgeForwardingTable) collectBridgeForwardingTable
void	collectCdp(boolean cdpTable) collectCdpTable
void	collectIpNetToMedia(boolean collectIpNetToMedia) collectBridgeForwardingTable
void	collectIpRoute(boolean ipRouteTable) collectIpRouteTable
void	collectIsIs(boolean collectIsIs)
void	collectLldp(boolean collectLldpTable)
void	collectOspf(boolean collectOspfTable)
void	collectStp(boolean stpNode) collectStpNode
boolean	collectVlanTable() collectVlanTable
void	collectWifi(boolean collectWifi)
boolean	equals(Object run)
SnmpAgentConfig	getAgentConfig()
boolean	getCollectBridge() getCollectBridgeForwardingTable
boolean	getCollectCdp() getCollectCdpTable
boolean	getCollectIpNetToMedia() getCollectBridgeForwardingTable
boolean	getCollectIpRoute() getCollectIpRouteTable
boolean	getCollectIsIs()
boolean	getCollectLldp()
boolean	getCollectOspf()
boolean	getCollectStp() getCollectStpNode
boolean	getCollectWifi()
String	getInfo() getInfo
long	getInitialSleepTime() getInitialSleepTime
String	getIpRouteClass()
String	getPackageName() Getter for the field packageName.
SnmpAgentConfig	getPeer() getPeer
long	getPollInterval() getPollInterval
int	getPort() getPort
String	getReadCommunity() getReadCommunity
Scheduler	getScheduler() getScheduler
InetAddress	getTarget() Returns the target address that the collection occurred for.
String	getVlanClass() getVlanClass
boolean	hasOspfNbrTable()
boolean	isReady() isReady
boolean	isSuspended() isSuspended
void	run()
void	schedule() schedule
void	setAgentConfig(SnmpAgentConfig agentConfig)
void	setInitialSleepTime(long initial_sleep_time) setInitialSleepTime
void	setIpRouteClass(String className)
void	setPackageName(String packageName) setPackageName
void	setPollInterval(long interval) setPollInterval
void	setScheduler(Scheduler scheduler) setScheduler
void	setVlanClass(String className) setVlanClass
void	suspend() suspend
void	unschedule() unschedule
void	wakeUp() wakeUp

Methods inherited from class java.lang.Object

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

Field Detail

m_mtxrWlRtabTable

public MtxrWlRtabTable m_mtxrWlRtabTable

m_lldpLocalGroup

public LldpLocalGroup m_lldpLocalGroup

m_lldpLocTable

public LldpLocTable m_lldpLocTable

m_lldpRemTable

public LldpRemTable m_lldpRemTable

m_ospfGeneralGroup

public OspfGeneralGroup m_ospfGeneralGroup

m_ospfNbrTable

public OspfNbrTable m_ospfNbrTable

m_isisSystemObjectGroup

public IsIsSystemObjectGroup m_isisSystemObjectGroup

m_isisISAdjTable

public IsisISAdjTable m_isisISAdjTable

m_isisCircTable

public IsisCircTable m_isisCircTable

m_ipNetToMedia

public IpNetToMediaTable m_ipNetToMedia

The ipnettomedia table information

m_ipRoute

public SnmpTable<SnmpStore> m_ipRoute

The ipRoute table information

m_cdpGlobalGroup

public CdpGlobalGroup m_cdpGlobalGroup

The CdpCache table information

m_cdpCache

public CdpCacheTable m_cdpCache

m_cdpInterface

public CdpInterfaceTable m_cdpInterface

m_vlanTable

public SnmpTable<SnmpStore> m_vlanTable

The VLAN Table information

m_snmpVlanCollection

public final Map<OnmsVlan,SnmpVlanCollection> m_snmpVlanCollection

The list of VLAN SNMP collection object

Constructor Detail

SnmpCollection

public SnmpCollection(Linkd linkd,
              int nodeid,
              SnmpAgentConfig config)

Constructs a new SNMP collector for a node using the passed interface as the collection point. The collection does not occur until the run method is invoked.

Parameters:

nodeid -

config - The SnmpPeer object to collect from.

Method Detail

getAgentConfig

public SnmpAgentConfig getAgentConfig()

setAgentConfig

public void setAgentConfig(SnmpAgentConfig agentConfig)

hasOspfNbrTable

public boolean hasOspfNbrTable()

run

public void run()

Specified by:

run in interface Runnable

getScheduler

public Scheduler getScheduler()

getScheduler

Returns:

a Scheduler object.

setScheduler

public void setScheduler(Scheduler scheduler)

setScheduler

Parameters:

scheduler - a Scheduler object.

getInitialSleepTime

public long getInitialSleepTime()

getInitialSleepTime

Returns:

Returns the initial_sleep_time.

setInitialSleepTime

public void setInitialSleepTime(long initial_sleep_time)

setInitialSleepTime

Parameters:

initial_sleep_time - The initial_sleep_timeto set.

getPollInterval

public long getPollInterval()

getPollInterval

Returns:

Returns the initial_sleep_time.

setPollInterval

public void setPollInterval(long interval)

setPollInterval

Parameters:

interval - a long.

schedule

public void schedule()

schedule

Specified by:

schedule in interface ReadyRunnable

isReady

public boolean isReady()

isReady

Specified by:

isReady in interface ReadyRunnable

Returns:

a boolean.

isSuspended

public boolean isSuspended()

isSuspended

Specified by:

isSuspended in interface ReadyRunnable

Returns:

Returns the suspendCollection.

suspend

public void suspend()

suspend

Specified by:

suspend in interface ReadyRunnable

wakeUp

public void wakeUp()

wakeUp

Specified by:

wakeUp in interface ReadyRunnable

unschedule

public void unschedule()

unschedule

Specified by:

unschedule in interface ReadyRunnable

getIpRouteClass

public String getIpRouteClass()

setIpRouteClass

public void setIpRouteClass(String className)

getVlanClass

public String getVlanClass()

getVlanClass

Returns:

Returns the m_vlanClass.

setVlanClass

public void setVlanClass(String className)

setVlanClass

Parameters:

className - a String object.

getTarget

public InetAddress getTarget()

Returns the target address that the collection occurred for.

Returns:

a InetAddress object.

collectVlanTable

public boolean collectVlanTable()

collectVlanTable

Returns:

Returns the m_collectVlanTable.

getReadCommunity

public String getReadCommunity()

getReadCommunity

Returns:

a String object.

getPeer

public SnmpAgentConfig getPeer()

getPeer

Returns:

a SnmpAgentConfig object.

getPort

public int getPort()

getPort

Returns:

a int.

equals

public boolean equals(Object run)

Overrides:

equals in class Object

getInfo

public String getInfo()

getInfo

Specified by:

getInfo in interface ReadyRunnable

Returns:

a String object.

getCollectLldp

public boolean getCollectLldp()

collectLldp

public void collectLldp(boolean collectLldpTable)

getCollectBridge

public boolean getCollectBridge()

getCollectBridgeForwardingTable

Returns:

a boolean.

collectIpNetToMedia

public void collectIpNetToMedia(boolean collectIpNetToMedia)

collectBridgeForwardingTable

Parameters:

bridgeForwardingTable - a boolean.

getCollectIpNetToMedia

public boolean getCollectIpNetToMedia()

getCollectBridgeForwardingTable

Returns:

a boolean.

collectBridge

public void collectBridge(boolean bridgeForwardingTable)

collectBridgeForwardingTable

Parameters:

bridgeForwardingTable - a boolean.

getCollectCdp

public boolean getCollectCdp()

getCollectCdpTable

Returns:

a boolean.

collectCdp

public void collectCdp(boolean cdpTable)

collectCdpTable

Parameters:

cdpTable - a boolean.

getCollectIpRoute

public boolean getCollectIpRoute()

getCollectIpRouteTable

Returns:

a boolean.

collectIpRoute

public void collectIpRoute(boolean ipRouteTable)

collectIpRouteTable

Parameters:

ipRouteTable - a boolean.

getCollectStp

public boolean getCollectStp()

getCollectStpNode

Returns:

a boolean.

collectStp

public void collectStp(boolean stpNode)

collectStpNode

Parameters:

stpNode - a boolean.

getPackageName

public String getPackageName()

Getter for the field packageName.

Specified by:

getPackageName in interface ReadyRunnable

Returns:

a String object.

setPackageName

public void setPackageName(String packageName)

setPackageName

Specified by:

setPackageName in interface ReadyRunnable

Parameters:

packageName - a String object.

collectOspf

public void collectOspf(boolean collectOspfTable)

getCollectOspf

public boolean getCollectOspf()

collectIsIs

public void collectIsIs(boolean collectIsIs)

getCollectIsIs

public boolean getCollectIsIs()

collectWifi

public void collectWifi(boolean collectWifi)

getCollectWifi

public boolean getCollectWifi()