Provisioner (OpenNMS 14.0.2-SNAPSHOT API)

java.lang.Object
- org.opennms.netmgt.provision.service.Provisioner

All Implemented Interfaces:

SpringServiceDaemon, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean
```
public class Provisioner
extends Object
implements SpringServiceDaemon
```
Massively Parallel Java Provisioning ServiceDaemon for OpenNMS.

Author:

Mathew Brozowski

Field Summary

Fields
Modifier and Type Field and Description

static String NAME
Constant NAME="Provisiond"

Fields
Modifier and Type	Field and Description
`static String`	`NAME` Constant `NAME="Provisiond"`

Constructor Summary

Constructors
Constructor and Description

Provisioner()

Constructors
Constructor and Description
`Provisioner()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`addToScheduleQueue(NodeScanSchedule schedule)` addToScheduleQueue
`void`	`afterPropertiesSet()` afterPropertiesSet
`protected void`	`checkNodeListForRemovals(List<NodeScanSchedule> schedules)` checkNodeListForRemovals
`ForceRescanScan`	`createForceRescanScan(Integer nodeId)` createForceRescanScan
`NewSuspectScan`	`createNewSuspectScan(InetAddress ipAddress, String foreignSource)` createNewSuspectScan
`NodeScan`	`createNodeScan(Integer nodeId, String foreignSource, String foreignId)` createNodeScan
`void`	`destroy()` destroy
`void`	`doImport()` doImport
`void`	`doImport(Event event)` Begins importing from resource specified in model-importer.properties file or in event parameter: url.
`void`	`doImport(String url, String rescanExisting)` doImport
`void`	`doNodeScan(int nodeId)` doNodeScan
`protected String`	`getEventForeignSource(Event event)` getEventForeignSource
`EventForwarder`	`getEventForwarder()` getEventForwarder
`ImportScheduler`	`getImportSchedule()` getImportSchedule
`ProvisionService`	`getProvisionService()` getProvisionService
`ScheduledFuture<?>`	`getScheduledFutureForNode(int nodeId)` getScheduledFutureForNode
`int`	`getScheduleLength()` getScheduleLength
`String`	`getStats()` getStats
`void`	`handleAddInterface(Event event)` handleAddInterface
`void`	`handleAddNode(Event event)` handleAddNode
`void`	`handleChangeService(Event event)` handleChangeService
`void`	`handleDeleteInterface(Event event)` handleDeleteInterface
`void`	`handleDeleteNode(Event event)` handleDeleteNode
`void`	`handleDeleteService(Event event)` handleDeleteService
`void`	`handleForceRescan(Event e)` handleForceRescan
`void`	`handleNewSuspectEvent(Event e)` handleNewSuspectEvent
`void`	`handleNodeAddedEvent(Event e)` handleNodeAddedEvent
`void`	`handleNodeDeletedEvent(Event e)` handleNodeDeletedEvent
`void`	`handleNodeUpdated(Event e)` handleNodeUpdated
`void`	`handleReloadConfigEvent(Event e)` handleReloadConfigEvent
`void`	`handleUpdateServer(Event event)` handleUpdateServer
`void`	`handleUpdateService(Event event)` handleUpdateService
`protected void`	`importModelFromResource(org.springframework.core.io.Resource resource, String rescanExisting)` importModelFromResource
`protected void`	`importModelFromResource(org.springframework.core.io.Resource resource, String rescanExisting, ProvisionMonitor monitor)` importModelFromResource
`protected void`	`removeFromScheduleQueue(List<Integer> nodeIds)` removeFromScheduleQueue
`protected void`	`removeNodeFromScheduleQueue(Integer nodeId)` removeNodeFromScheduleQueue
`protected void`	`scheduleRescanForExistingNodes()` scheduleRescanForExistingNodes
`void`	`setAgentConfigFactory(SnmpAgentConfigFactory agentConfigFactory)` setAgentConfigFactory
`void`	`setEventForwarder(EventForwarder eventForwarder)` setEventForwarder
`void`	`setImportActivities(CoreImportActivities importActivities)` setImportActivities
`void`	`setImportSchedule(ImportScheduler schedule)` setImportSchedule
`void`	`setLifeCycleRepository(LifeCycleRepository lifeCycleRepository)` setLifeCycleRepository
`void`	`setProvisionService(ProvisionService provisionService)` setProvisionService
`void`	`setScheduledExecutor(ScheduledExecutorService scheduledExecutor)` setScheduledExecutor
`void`	`setTaskCoordinator(DefaultTaskCoordinator taskCoordinator)` setTaskCoordinator
`void`	`start()` start
`protected void`	`updateNodeScheduleInQueue(NodeScanSchedule schedule)` updateNodeScheduleInQueue
`void`	`waitFor()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NAME
```
public static final String NAME
```
    Constant NAME="Provisiond"
    
    See Also:
    Constant Field Values
- Constructor Detail
  - Provisioner
```
public Provisioner()
```
- Method Detail
  - setProvisionService
```
public void setProvisionService(ProvisionService provisionService)
```
    setProvisionService
    
    Parameters:
    provisionService - a ProvisionService object.
  - getProvisionService
```
public ProvisionService getProvisionService()
```
    getProvisionService
    
    Returns:
    a ProvisionService object.
  - setScheduledExecutor
```
public void setScheduledExecutor(ScheduledExecutorService scheduledExecutor)
```
    setScheduledExecutor
    
    Parameters:
    scheduledExecutor - a ScheduledExecutorService object.
  - setLifeCycleRepository
```
public void setLifeCycleRepository(LifeCycleRepository lifeCycleRepository)
```
    setLifeCycleRepository
    
    Parameters:
    lifeCycleRepository - a LifeCycleRepository object.
  - setImportSchedule
```
public void setImportSchedule(ImportScheduler schedule)
```
    setImportSchedule
    
    Parameters:
    schedule - a ImportScheduler object.
  - setImportActivities
```
public void setImportActivities(CoreImportActivities importActivities)
```
    setImportActivities
    
    Parameters:
    importActivities - the importActivities to set
  - setTaskCoordinator
```
public void setTaskCoordinator(DefaultTaskCoordinator taskCoordinator)
```
    setTaskCoordinator
    
    Parameters:
    taskCoordinator - the taskCoordinator to set
  - setAgentConfigFactory
```
public void setAgentConfigFactory(SnmpAgentConfigFactory agentConfigFactory)
```
    setAgentConfigFactory
    
    Parameters:
    agentConfigFactory - the agentConfigFactory to set
  - getImportSchedule
```
public ImportScheduler getImportSchedule()
```
    getImportSchedule
    
    Returns:
    a ImportScheduler object.
  - start
```
public void start()
           throws Exception
```
    start
    
    Specified by:
    
    start in interface SpringServiceDaemon
    
    Throws:
    
    Exception - if any.
  - destroy
```
public void destroy()
             throws Exception
```
    destroy
    
    Specified by:
    
    destroy in interface org.springframework.beans.factory.DisposableBean
    
    Throws:
    
    Exception - if any.
  - afterPropertiesSet
```
public void afterPropertiesSet()
                        throws Exception
```
    afterPropertiesSet
    
    Specified by:
    
    afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean
    
    Throws:
    
    Exception - if any.
  - scheduleRescanForExistingNodes
```
protected void scheduleRescanForExistingNodes()
```
    scheduleRescanForExistingNodes
  - doNodeScan
```
public void doNodeScan(int nodeId)
                throws InterruptedException,
                       ExecutionException
```
    doNodeScan
    
    Parameters:
    nodeId - a int.
    
    Throws:
    
    InterruptedException - if any.
    
    ExecutionException - if any.
  - createNodeScan
```
public NodeScan createNodeScan(Integer nodeId,
                      String foreignSource,
                      String foreignId)
```
    createNodeScan
    
    Parameters:
    nodeId - a Integer object.
    foreignSource - a String object.
    foreignId - a String object.
    
    Returns:
    a NodeScan object.
  - createNewSuspectScan
```
public NewSuspectScan createNewSuspectScan(InetAddress ipAddress,
                                  String foreignSource)
```
    createNewSuspectScan
    
    Parameters:
    ipAddress - a InetAddress object.
    
    Returns:
    a NewSuspectScan object.
  - createForceRescanScan
```
public ForceRescanScan createForceRescanScan(Integer nodeId)
```
    createForceRescanScan
    
    Parameters:
    ipAddress - a InetAddress object.
    
    Returns:
    a ForceRescanScan object.
  - addToScheduleQueue
```
protected void addToScheduleQueue(NodeScanSchedule schedule)
```
    addToScheduleQueue
    
    Parameters:
    schedule - a NodeScanSchedule object.
  - updateNodeScheduleInQueue
```
protected void updateNodeScheduleInQueue(NodeScanSchedule schedule)
```
    updateNodeScheduleInQueue
    
    Parameters:
    schedule - a NodeScanSchedule object.
  - getScheduledFutureForNode
```
public ScheduledFuture<?> getScheduledFutureForNode(int nodeId)
```
    getScheduledFutureForNode
    
    Parameters:
    nodeId - a int.
    
    Returns:
    a ScheduledFuture object.
  - removeNodeFromScheduleQueue
```
protected void removeNodeFromScheduleQueue(Integer nodeId)
```
    removeNodeFromScheduleQueue
    
    Parameters:
    nodeId - a Integer object.
  - removeFromScheduleQueue
```
protected void removeFromScheduleQueue(List<Integer> nodeIds)
```
    removeFromScheduleQueue
    
    Parameters:
    nodeIds - a List object.
  - checkNodeListForRemovals
```
protected void checkNodeListForRemovals(List<NodeScanSchedule> schedules)
```
    checkNodeListForRemovals
    
    Parameters:
    schedules - a List object.
  - getScheduleLength
```
public int getScheduleLength()
```
    getScheduleLength
    
    Returns:
    a int.
  - importModelFromResource
```
protected void importModelFromResource(org.springframework.core.io.Resource resource,
                           String rescanExisting)
                                throws Exception
```
    importModelFromResource
    
    Parameters:
    resource - a Resource object.
    rescanExisting - TODO
    
    Throws:
    
    Exception - if any.
  - importModelFromResource
```
protected void importModelFromResource(org.springframework.core.io.Resource resource,
                           String rescanExisting,
                           ProvisionMonitor monitor)
                                throws Exception
```
    importModelFromResource
    
    Parameters:
    resource - a Resource object.
    rescanExisting - TODO
    monitor - a ProvisionMonitor object.
    
    Throws:
    
    Exception - if any.
  - setEventForwarder
```
public void setEventForwarder(EventForwarder eventForwarder)
```
    setEventForwarder
    
    Parameters:
    eventForwarder - a EventForwarder object.
  - getEventForwarder
```
public EventForwarder getEventForwarder()
```
    getEventForwarder
    
    Returns:
    a EventForwarder object.
  - doImport
```
public void doImport()
```
    doImport
  - doImport
```
public void doImport(Event event)
```
    Begins importing from resource specified in model-importer.properties file or in event parameter: url. Import Resources are managed with a "key" called "foreignSource" specified in the XML retrieved by the resource and can be overridden as a parameter of an event.
    
    Parameters:
    event - a Event object.
  - doImport
```
public void doImport(String url,
            String rescanExisting)
```
    doImport
    
    Parameters:
    url - a String object.
    rescanExisting - TODO
  - handleNodeAddedEvent
```
public void handleNodeAddedEvent(Event e)
```
    handleNodeAddedEvent
    
    Parameters:
    e - a Event object.
  - handleForceRescan
```
public void handleForceRescan(Event e)
```
    handleForceRescan
    
    Parameters:
    e - a Event object.
  - handleNewSuspectEvent
```
public void handleNewSuspectEvent(Event e)
```
    handleNewSuspectEvent
    
    Parameters:
    e - a Event object.
  - handleNodeUpdated
```
public void handleNodeUpdated(Event e)
```
    handleNodeUpdated
    A re-import has occurred, attempt a rescan now.
    
    Parameters:
    e - a Event object.
  - handleNodeDeletedEvent
```
public void handleNodeDeletedEvent(Event e)
```
    handleNodeDeletedEvent
    
    Parameters:
    e - a Event object.
  - handleReloadConfigEvent
```
public void handleReloadConfigEvent(Event e)
```
    handleReloadConfigEvent
    
    Parameters:
    e - a Event object.
  - handleAddInterface
```
public void handleAddInterface(Event event)
```
    handleAddInterface
    
    Parameters:
    event - a Event object.
  - handleAddNode
```
public void handleAddNode(Event event)
```
    handleAddNode
    
    Parameters:
    event - a Event object.
  - handleChangeService
```
public void handleChangeService(Event event)
```
    handleChangeService
    
    Parameters:
    event - a Event object.
  - handleDeleteInterface
```
public void handleDeleteInterface(Event event)
```
    handleDeleteInterface
    
    Parameters:
    event - a Event object.
  - handleDeleteNode
```
public void handleDeleteNode(Event event)
```
    handleDeleteNode
    
    Parameters:
    event - a Event object.
  - handleDeleteService
```
public void handleDeleteService(Event event)
```
    handleDeleteService
    
    Parameters:
    event - a Event object.
  - handleUpdateServer
```
public void handleUpdateServer(Event event)
```
    handleUpdateServer
    
    Parameters:
    event - a Event object.
  - handleUpdateService
```
public void handleUpdateService(Event event)
```
    handleUpdateService
    
    Parameters:
    event - a Event object.
  - getStats
```
public String getStats()
```
    getStats
    
    Returns:
    a String object.
  - getEventForeignSource
```
protected String getEventForeignSource(Event event)
```
    getEventForeignSource
    
    Parameters:
    event - a Event object.
    
    Returns:
    a String object.
  - waitFor
```
public void waitFor()
```

Class Provisioner

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NAME

Constructor Detail

Provisioner

Method Detail

setProvisionService

getProvisionService

setScheduledExecutor

setLifeCycleRepository

setImportSchedule

setImportActivities

setTaskCoordinator

setAgentConfigFactory

getImportSchedule

start

destroy

afterPropertiesSet

scheduleRescanForExistingNodes

doNodeScan

createNodeScan

createNewSuspectScan

createForceRescanScan

addToScheduleQueue

updateNodeScheduleInQueue

getScheduledFutureForNode

removeNodeFromScheduleQueue

removeFromScheduleQueue

checkNodeListForRemovals

getScheduleLength

importModelFromResource

importModelFromResource

setEventForwarder

getEventForwarder

doImport

doImport

doImport

handleNodeAddedEvent

handleForceRescan

handleNewSuspectEvent

handleNodeUpdated

handleNodeDeletedEvent

handleReloadConfigEvent

handleAddInterface

handleAddNode

handleChangeService

handleDeleteInterface

handleDeleteNode

handleDeleteService

handleUpdateServer

handleUpdateService

getStats

getEventForeignSource

waitFor