org.opennms.netmgt.enlinkd

Class Discovery

java.lang.Object

org.opennms.netmgt.enlinkd.Discovery

All Implemented Interfaces:

Runnable, ReadyRunnable

Direct Known Subclasses:

DiscoveryBridgeDomains, DiscoveryBridgeTopology, NodeDiscovery

public abstract class Discovery
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 long	m_initial_sleep_time
protected EnhancedLinkd	m_linkd
protected long	m_poll_interval The interval, default value 30 minutes
protected boolean	m_suspendCollection The initial sleep time, default value 5 minutes

Constructor Summary

Constructors

Constructor and Description
Discovery(EnhancedLinkd linkd, long interval, long initial) 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
abstract String	getName()
long	getPollInterval() getPollInterval
Scheduler	getScheduler() getScheduler
int	hashCode()
boolean	isReady() isReady
boolean	isSuspended() isSuspended
void	reschedule()
void	run()
abstract void	runDiscovery()
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	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_poll_interval

protected long m_poll_interval

The interval, default value 30 minutes

m_initial_sleep_time

protected long m_initial_sleep_time

m_suspendCollection

protected boolean m_suspendCollection

The initial sleep time, default value 5 minutes

m_linkd

protected final EnhancedLinkd m_linkd

Constructor Detail

Discovery

public Discovery(EnhancedLinkd linkd,
                 long interval,
                 long initial)

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

getName

public abstract String getName()

runDiscovery

public abstract void runDiscovery()

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.

schedule

public void schedule()

schedule

Specified by:

schedule in interface ReadyRunnable

unschedule

public void unschedule()

unschedule

Specified by:

unschedule 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

getInfo

public String getInfo()

getInfo

Specified by:

getInfo in interface ReadyRunnable

Returns:

a String object.

getPollInterval

public long getPollInterval()

getPollInterval

Returns:

Returns the initial_sleep_time.

setPollInterval

public void setPollInterval(long interval)

setPollInterval

Parameters:

interval - a long.

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.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

sendSuspendedEvent

protected void sendSuspendedEvent(int nodeid)

sendStartEvent

protected void sendStartEvent(int nodeid)

sendCompletedEvent

protected void sendCompletedEvent(int nodeid)