org.opennms.netmgt.provision

Class ReverseDnsProvisioningAdapter

java.lang.Object

org.opennms.netmgt.provision.SimpleQueuedProvisioningAdapter

org.opennms.netmgt.provision.ReverseDnsProvisioningAdapter

All Implemented Interfaces:

ProvisioningAdapter, org.springframework.beans.factory.InitializingBean

public class ReverseDnsProvisioningAdapter
extends SimpleQueuedProvisioningAdapter
implements org.springframework.beans.factory.InitializingBean

A Dynamic DNS provisioning adapter for integration with OpenNMS Provisioning daemon API.

Version:

$Id: $

Author:

David Hustace

Nested Class Summary

Nested classes/interfaces inherited from class org.opennms.netmgt.provision.SimpleQueuedProvisioningAdapter

SimpleQueuedProvisioningAdapter.AdapterOperationQueue, SimpleQueuedProvisioningAdapter.AdapterOperationQueueListener

Constructor Summary

Constructors

Constructor and Description
ReverseDnsProvisioningAdapter()

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet() afterPropertiesSet
EventForwarder	getEventForwarder() getEventForwarder
String	getName() getName
ReverseDnsProvisioningAdapterService	getReverseProvisioningAdapterService()
boolean	isNodeReady(org.opennms.netmgt.provision.SimpleQueuedProvisioningAdapter.AdapterOperation op) Adapters extending this class must implement this method.
void	processPendingOperationForNode(org.opennms.netmgt.provision.SimpleQueuedProvisioningAdapter.AdapterOperation op) The class implements the API and therefore the concrete class implements this method to handle dequeued operations.
void	setEventForwarder(EventForwarder eventForwarder) setEventForwarder
void	setReverseDnsProvisioningAdapterService(ReverseDnsProvisioningAdapterService reverseProvisioningAdapterService)

Methods inherited from class org.opennms.netmgt.provision.SimpleQueuedProvisioningAdapter

addNode, deleteNode, getOperationQueue, init, nodeConfigChanged, updateNode

Methods inherited from class java.lang.Object

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

Constructor Detail

ReverseDnsProvisioningAdapter

public ReverseDnsProvisioningAdapter()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

afterPropertiesSet

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception - if any.

getReverseProvisioningAdapterService

public ReverseDnsProvisioningAdapterService getReverseProvisioningAdapterService()

setReverseDnsProvisioningAdapterService

public void setReverseDnsProvisioningAdapterService(ReverseDnsProvisioningAdapterService reverseProvisioningAdapterService)

setEventForwarder

public void setEventForwarder(EventForwarder eventForwarder)

setEventForwarder

Parameters:

eventForwarder - a EventForwarder object.

getEventForwarder

public EventForwarder getEventForwarder()

getEventForwarder

Returns:

a EventForwarder object.

getName

public String getName()

getName

Specified by:

getName in interface ProvisioningAdapter

Specified by:

getName in class SimpleQueuedProvisioningAdapter

Returns:

a String object.

isNodeReady

public boolean isNodeReady(org.opennms.netmgt.provision.SimpleQueuedProvisioningAdapter.AdapterOperation op)

Adapters extending this class must implement this method. This method is called in the run method of an operation to insure that the adapter is ready for the operation to run for the associated node. The adapter is responsible for setting the schedule, however, something could have altered the state of readiness for the provisioning system in the meantime. If this method returns false, the operation is rescheduled with the and the attempts remaining on the operation are not decremented.

Specified by:

isNodeReady in class SimpleQueuedProvisioningAdapter

Parameters:

op - a SimpleQueuedProvisioningAdapter.AdapterOperation object.

Returns:

a boolean representing the state of readiness from the underlying system integrated by the implementing adapter.

processPendingOperationForNode

public void processPendingOperationForNode(org.opennms.netmgt.provision.SimpleQueuedProvisioningAdapter.AdapterOperation op)
                                    throws ProvisioningAdapterException

The class implements the API and therefore the concrete class implements this method to handle dequeued operations. The concrete implementation should check the operation type to derive the its behavior.

Specified by:

processPendingOperationForNode in class SimpleQueuedProvisioningAdapter

Parameters:

op - a SimpleQueuedProvisioningAdapter.AdapterOperation object.

Throws:

ProvisioningAdapterException - if any.