Package org.opennms.netmgt.provision.service

Class NodeScan

java.lang.Object

org.opennms.netmgt.provision.service.NodeScan

All Implemented Interfaces:

RunInBatch, Scan

public class NodeScan
extends Object
implements Scan

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	NodeScan.AgentScan	AgentScan TODO: Make this static
class	NodeScan.BaseAgentScan	TODO: Make this static
class	NodeScan.NoAgentScan	TODO: Make this static

Constructor Summary

Constructors

Constructor	Description
NodeScan(Integer nodeId, String foreignSource, String foreignId, OnmsMonitoringLocation location, ProvisionService provisionService, EventForwarder eventForwarder, SnmpAgentConfigFactory agentConfigFactory, TaskCoordinator taskCoordinator, io.opentracing.Span span, ProvisionMonitor monitor)	Constructor for NodeScan.

Method Summary

Modifier and Type	Method	Description
void	abort(String reason)	abort
NodeScan.AgentScan	createAgentScan(InetAddress agentAddress, String agentType)	createAgentScan
Task	createTask()
void	detectAgents(BatchTask currentPhase)	detectAgents
EventForwarder	getEventForwarder()	getEventForwarder
String	getForeignId()	getForeignId
String	getForeignSource()	getForeignSource
OnmsMonitoringLocation	getLocation()
OnmsNode	getNode()	getNode
Integer	getNodeId()	getNodeId
ProvisionService	getProvisionService()	getProvisionService
Date	getScanStamp()	getScanStamp
TaskCoordinator	getTaskCoordinator()	getTaskCoordinator
void	handleAgentUndetected(BatchTask currentPhase)	handleAgentUndetected
boolean	isAborted()	isAborted
void	loadNode(BatchTask loadNode)	loadNode
void	run(BatchTask parent)	run
void	scanCompleted(BatchTask currentPhase)	scanCompleted
String	toString()	toString

Methods inherited from class java.lang.Object

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

Constructor Detail

NodeScan

public NodeScan(Integer nodeId,
                String foreignSource,
                String foreignId,
                OnmsMonitoringLocation location,
                ProvisionService provisionService,
                EventForwarder eventForwarder,
                SnmpAgentConfigFactory agentConfigFactory,
                TaskCoordinator taskCoordinator,
                io.opentracing.Span span,
                ProvisionMonitor monitor)

Constructor for NodeScan.

Parameters:

nodeId - a Integer object.

foreignSource - a String object.

foreignId - a String object.

location - a OnmsMonitoringLocation object.

provisionService - a ProvisionService object.

eventForwarder - a EventForwarder object.

agentConfigFactory - a SnmpAgentConfigFactory object.

taskCoordinator - a TaskCoordinator object.

monitor - a ProvisionMonitor object. (optional)

Method Detail

getForeignSource

public String getForeignSource()

getForeignSource

Returns:

a String object.

getForeignId

public String getForeignId()

getForeignId

Returns:

a String object.

getNodeId

public Integer getNodeId()

getNodeId

Returns:

a Integer object.

getLocation

public OnmsMonitoringLocation getLocation()

getNode

public OnmsNode getNode()

getNode

Returns:

a OnmsNode object.

getScanStamp

public Date getScanStamp()

getScanStamp

Returns:

a Date object.

getProvisionService

public ProvisionService getProvisionService()

getProvisionService

Returns:

the provisionService

getEventForwarder

public EventForwarder getEventForwarder()

getEventForwarder

Returns:

the eventForwarder

getTaskCoordinator

public TaskCoordinator getTaskCoordinator()

getTaskCoordinator

Returns:

a TaskCoordinator object.

isAborted

public boolean isAborted()

isAborted

Returns:

a boolean.

abort

public void abort(String reason)

abort

Parameters:

reason - a String object.

createTask

public Task createTask()

Specified by:

createTask in interface Scan

run

public void run(BatchTask parent)

run

Specified by:

run in interface RunInBatch

Parameters:

parent - a BatchTask object.

loadNode

public void loadNode(BatchTask loadNode)

loadNode

Parameters:

loadNode - a BatchTask object.

createAgentScan

public NodeScan.AgentScan createAgentScan(InetAddress agentAddress,
                                          String agentType)

createAgentScan

Parameters:

agentAddress - a InetAddress object.

agentType - a String object.

Returns:

a NodeScan.AgentScan object.

toString

public String toString()

toString

Overrides:

toString in class Object

Returns:

a String object.

detectAgents

public void detectAgents(BatchTask currentPhase)

detectAgents

Parameters:

currentPhase - a BatchTask object.

handleAgentUndetected

public void handleAgentUndetected(BatchTask currentPhase)

handleAgentUndetected

Parameters:

currentPhase - a BatchTask object.

scanCompleted

public void scanCompleted(BatchTask currentPhase)

scanCompleted

Parameters:

currentPhase - a BatchTask object.