org.opennms.netmgt.provision

Class MapProvisioningAdapter

java.lang.Object

org.opennms.netmgt.provision.SimpleQueuedProvisioningAdapter

org.opennms.netmgt.provision.MapProvisioningAdapter

All Implemented Interfaces:

ProvisioningAdapter, org.springframework.beans.factory.InitializingBean

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

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

Version:

$Id: $

Author:

Antonio Russo

Nested Class Summary

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

SimpleQueuedProvisioningAdapter.AdapterOperationQueue, SimpleQueuedProvisioningAdapter.AdapterOperationQueueListener

Constructor Summary

Constructors

Constructor and Description
MapProvisioningAdapter()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet() afterPropertiesSet
EventForwarder	getEventForwarder() getEventForwarder
MapsAdapterConfig	getMapsAdapterConfig() getMapsAdapterConfig
String	getName() getName
OnmsMapDao	getOnmsMapDao() getOnmsMapDao
OnmsMapElementDao	getOnmsMapElementDao() getOnmsMapElementDao
NodeDao	getOnmsNodeDao() getOnmsNodeDao
String	getSuitableIp(OnmsNode node) getSuitableIp
void	handleReloadConfigEvent(Event event) handleReloadConfigEvent
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	setEventForwarder(EventForwarder eventForwarder) setEventForwarder
void	setMapsAdapterConfig(MapsAdapterConfig mapsAdapterConfig) setMapsAdapterConfig
void	setOnmsMapDao(OnmsMapDao onmsMapDao) setOnmsMapDao
void	setOnmsMapElementDao(OnmsMapElementDao onmsMapElementDao) setOnmsMapElementDao
void	setOnmsNodeDao(NodeDao onmsNodeDao) setOnmsNodeDao
void	setTemplate(org.springframework.transaction.support.TransactionTemplate template) setTemplate

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

Constructor Detail

MapProvisioningAdapter

public MapProvisioningAdapter()

Method Detail

getOnmsMapDao

public OnmsMapDao getOnmsMapDao()

getOnmsMapDao

Returns:

a OnmsMapDao object.

setOnmsMapDao

public void setOnmsMapDao(OnmsMapDao onmsMapDao)

setOnmsMapDao

Parameters:

onmsMapDao - a OnmsMapDao object.

getOnmsMapElementDao

public OnmsMapElementDao getOnmsMapElementDao()

getOnmsMapElementDao

Returns:

a OnmsMapElementDao object.

setOnmsMapElementDao

public void setOnmsMapElementDao(OnmsMapElementDao onmsMapElementDao)

setOnmsMapElementDao

Parameters:

onmsMapElementDao - a OnmsMapElementDao object.

getMapsAdapterConfig

public MapsAdapterConfig getMapsAdapterConfig()

getMapsAdapterConfig

Returns:

a MapsAdapterConfig object.

setMapsAdapterConfig

public void setMapsAdapterConfig(MapsAdapterConfig mapsAdapterConfig)

setMapsAdapterConfig

Parameters:

mapsAdapterConfig - a MapsAdapterConfig object.

setEventForwarder

public void setEventForwarder(EventForwarder eventForwarder)

setEventForwarder

Parameters:

eventForwarder - a EventForwarder object.

getEventForwarder

public EventForwarder getEventForwarder()

getEventForwarder

Returns:

a EventForwarder object.

getOnmsNodeDao

public NodeDao getOnmsNodeDao()

getOnmsNodeDao

Returns:

a NodeDao object.

setOnmsNodeDao

public void setOnmsNodeDao(NodeDao onmsNodeDao)

setOnmsNodeDao

Parameters:

onmsNodeDao - a NodeDao object.

setTemplate

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

setTemplate

Parameters:

template - a TransactionTemplate object.

handleReloadConfigEvent

public void handleReloadConfigEvent(Event event)

handleReloadConfigEvent

Parameters:

event - a Event 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.

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

afterPropertiesSet

Specified by:

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

Throws:

Exception - if any.

init

public void init()
          throws ProvisioningAdapterException

(non-Javadoc)

Specified by:

init in interface ProvisioningAdapter

Overrides:

init in class SimpleQueuedProvisioningAdapter

Throws:

ProvisioningAdapterException - if any.

See Also:

Override this implementation if needed.

getSuitableIp

public String getSuitableIp(OnmsNode node)

getSuitableIp

Parameters:

node - a OnmsNode object.

Returns:

a String object.