org.opennms.netmgt.provision

Interface ProvisioningAdapter

All Known Implementing Classes:

DnsProvisioningAdapter, LinkProvisioningAdapter, MapProvisioningAdapter, PuppetProvisioningAdapter, RancidProvisioningAdapter, ReverseDnsProvisioningAdapter, SimpleQueuedProvisioningAdapter, SimpleQueuedProvisioningAdapter2, SimplerQueuedProvisioningAdapter, SnmpAssetProvisioningAdapter, SnmpHardwareInventoryProvisioningAdapter

public interface ProvisioningAdapter

This class provides an API for implementing provider "extensions" to the OpenNMS Provisioning daemon.

Version:

$Id: $

Author:

David Hustace

Method Summary

Methods

Modifier and Type	Method and Description
ScheduledFuture<?>	addNode(int nodeId) This method is called by the Provisioner when a new node is provisioned.
ScheduledFuture<?>	deleteNode(int nodeId) This method is called by the Provisioner when a node is deleted through provisioning.
String	getName() getName
void	init() This method is called in case the adapter needs to perform some initialization prior to receiving calls from the AdapterManager.
ScheduledFuture<?>	nodeConfigChanged(int nodeid) This method is called when a configuration change event has occurred from any source.
ScheduledFuture<?>	updateNode(int nodeId) This method is called by the Provisioner when a node is updated through provisioning.

Method Detail

addNode

ScheduledFuture<?> addNode(int nodeId)
                           throws ProvisioningAdapterException

This method is called by the Provisioner when a new node is provisioned.

Parameters:

nodeId - a int.

Returns:

Throws:

ProvisioningAdapterException - if any.

updateNode

ScheduledFuture<?> updateNode(int nodeId)
                              throws ProvisioningAdapterException

This method is called by the Provisioner when a node is updated through provisioning.

Parameters:

nodeId - a int.

Throws:

ProvisioningAdapterException - if any.

deleteNode

ScheduledFuture<?> deleteNode(int nodeId)
                              throws ProvisioningAdapterException

This method is called by the Provisioner when a node is deleted through provisioning.

Parameters:

nodeId - a int.

Throws:

ProvisioningAdapterException - if any.

getName

String getName()

getName

Returns:

a String object.

nodeConfigChanged

ScheduledFuture<?> nodeConfigChanged(int nodeid)
                                     throws ProvisioningAdapterException

This method is called when a configuration change event has occurred from any source. Typically, Traps sent from a device are converted to an event and that event is then identified for translation and translated into a generic configuration changed event.

Parameters:

nodeid - a int.

Throws:

ProvisioningAdapterException - if any.

init

void init()
          throws ProvisioningAdapterException

This method is called in case the adapter needs to perform some initialization prior to receiving calls from the AdapterManager.

Throws:

ProvisioningAdapterException - if any.