org.opennms.netmgt.provision

Class SimplerQueuedProvisioningAdapter

java.lang.Object

org.opennms.netmgt.provision.SimpleQueuedProvisioningAdapter

org.opennms.netmgt.provision.SimplerQueuedProvisioningAdapter

All Implemented Interfaces:

ProvisioningAdapter

Direct Known Subclasses:

GeolocationProvisioningAdapter, SnmpAssetProvisioningAdapter, SnmpHardwareInventoryProvisioningAdapter, WsManAssetProvisioningAdapter

public abstract class SimplerQueuedProvisioningAdapter
extends SimpleQueuedProvisioningAdapter

SimplerQueuedProvisioningAdapter

Version:

$Id: $

Author:

brozow

Nested Class Summary

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

SimpleQueuedProvisioningAdapter.AdapterOperationQueue, SimpleQueuedProvisioningAdapter.AdapterOperationQueueListener

Field Summary

Fields

Modifier and Type	Field and Description
protected long	m_delay
protected org.springframework.transaction.support.TransactionTemplate	m_template
protected TimeUnit	m_timeUnit

Constructor Summary

Constructors

Constructor and Description
SimplerQueuedProvisioningAdapter(String name) Constructor for SimplerQueuedProvisioningAdapter.

Method Summary

Modifier and Type	Method and Description
void	doAddNode(int nodeid) doAddNode
void	doDeleteNode(int nodeid) doDeleteNode
void	doNotifyConfigChange(int nodeid) doNotifyConfigChange
void	doUpdateNode(int nodeid) doUpdateNode
String	getName() getName
void	init() (non-Javadoc)
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	setDelay(long delay) setDelay
void	setTemplate(org.springframework.transaction.support.TransactionTemplate template) setTemplate
void	setTimeUnit(TimeUnit timeUnit) setTimeUnit

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

addNode, deleteNode, getOperationQueue, nodeConfigChanged, updateNode

Methods inherited from class java.lang.Object

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

Field Detail

m_delay

protected long m_delay

m_timeUnit

protected TimeUnit m_timeUnit

m_template

protected org.springframework.transaction.support.TransactionTemplate m_template

Constructor Detail

SimplerQueuedProvisioningAdapter

public SimplerQueuedProvisioningAdapter(String name)

Constructor for SimplerQueuedProvisioningAdapter.

Parameters:

name - a String object.

Method Detail

setTemplate

public void setTemplate(org.springframework.transaction.support.TransactionTemplate template)

setTemplate

Parameters:

template - a TransactionTemplate object.

setTimeUnit

public void setTimeUnit(TimeUnit timeUnit)

setTimeUnit

Parameters:

timeUnit - a TimeUnit object.

setDelay

public void setDelay(long delay)

setDelay

Parameters:

delay - a long.

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 final 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.

init

public void init()

(non-Javadoc)

Specified by:

init in interface ProvisioningAdapter

Overrides:

init in class SimpleQueuedProvisioningAdapter

See Also:

Override this implementation if needed.

doAddNode

public void doAddNode(int nodeid)

doAddNode

Parameters:

nodeid - a int.

doUpdateNode

public void doUpdateNode(int nodeid)

doUpdateNode

Parameters:

nodeid - a int.

doDeleteNode

public void doDeleteNode(int nodeid)

doDeleteNode

Parameters:

nodeid - a int.

doNotifyConfigChange

public void doNotifyConfigChange(int nodeid)

doNotifyConfigChange

Parameters:

nodeid - a int.