org.opennms.netmgt.enlinkd

Class NodeDiscovery

java.lang.Object

org.opennms.netmgt.enlinkd.NodeDiscovery

All Implemented Interfaces:

Runnable, ReadyRunnable

Direct Known Subclasses:

NodeDiscoveryBridge, NodeDiscoveryBridgeTopology, NodeDiscoveryCdp, NodeDiscoveryIpNetToMedia, NodeDiscoveryIsis, NodeDiscoveryLldp, NodeDiscoveryOspf

public abstract class NodeDiscovery
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
protected EnhancedLinkd	m_linkd
protected Node	m_node The node ID of the system used to collect the SNMP information

Constructor Summary

Constructors

Constructor and Description
NodeDiscovery(EnhancedLinkd linkd, Node node) Constructs a new SNMP collector for a node using the passed interface as the collection point.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getInfo() getInfo
long	getInitialSleepTime() getInitialSleepTime
String	getLocation()
abstract String	getName()
int	getNodeId()
String	getPackageName() Getter for the field packageName.
long	getPollInterval() getPollInterval
InetAddress	getPrimaryIpAddress() Returns the target address that the collection occurred for.
String	getPrimaryIpAddressString()
Scheduler	getScheduler() getScheduler
String	getSysname()
String	getSysoid()
int	hashCode()
boolean	isReady() isReady
boolean	isSuspended() isSuspended
void	reschedule()
void	run() Performs the collection for the targeted IP address.
protected abstract void	runCollection()
void	schedule() schedule
protected void	sendCompletedEvent(int nodeid)
protected void	sendStartEvent(int nodeid)
protected void	sendSuspendedEvent(int nodeid)
void	setInitialSleepTime(long initial_sleep_time) setInitialSleepTime
void	setPackageName(String pkgName) setPackageName
void	setPollInterval(long interval) setPollInterval
void	setScheduler(Scheduler scheduler) setScheduler
void	suspend() suspend
void	unschedule() unschedule
void	wakeUp() wakeUp

Methods inherited from class java.lang.Object

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

Field Detail

m_node

protected final Node m_node

The node ID of the system used to collect the SNMP information

m_linkd

protected final EnhancedLinkd m_linkd

Constructor Detail

NodeDiscovery

public NodeDiscovery(EnhancedLinkd linkd,
                     Node node)

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

run

public void run()

Performs the collection for the targeted IP address. The success or failure of the collection should be tested via the failed method.

No synchronization is performed, so if this is used in a separate thread context synchronization must be added.

Specified by:

run in interface Runnable

sendSuspendedEvent

protected void sendSuspendedEvent(int nodeid)

sendStartEvent

protected void sendStartEvent(int nodeid)

sendCompletedEvent

protected void sendCompletedEvent(int nodeid)

runCollection

protected abstract void runCollection()

getScheduler

public Scheduler getScheduler()

getScheduler

Returns:

a Scheduler object.

setScheduler

public void setScheduler(Scheduler scheduler)

setScheduler

Parameters:

scheduler - a Scheduler object.

schedule

public void schedule()

schedule

Specified by:

schedule in interface ReadyRunnable

reschedule

public void reschedule()

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

getPrimaryIpAddress

public InetAddress getPrimaryIpAddress()

Returns the target address that the collection occurred for.

Returns:

a InetAddress object.

getPrimaryIpAddressString

public String getPrimaryIpAddressString()

getInfo

public String getInfo()

getInfo

Specified by:

getInfo in interface ReadyRunnable

Returns:

a String object.

getPackageName

public String getPackageName()

Getter for the field packageName.

Specified by:

getPackageName in interface ReadyRunnable

Returns:

a String object.

setPackageName

public void setPackageName(String pkgName)

Description copied from interface: ReadyRunnable

setPackageName

Specified by:

setPackageName in interface ReadyRunnable

Parameters:

pkgName - a String 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.

getNodeId

public int getNodeId()

getSysoid

public String getSysoid()

getSysname

public String getSysname()

getLocation

public String getLocation()

getName

public abstract String getName()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object