Package org.opennms.netmgt.provision

Class RancidProvisioningAdapter

  • All Implemented Interfaces:
    ProvisioningAdapter, org.springframework.beans.factory.InitializingBean
    public class RancidProvisioningAdapter
extends SimpleQueuedProvisioningAdapter
implements org.springframework.beans.factory.InitializingBean
    A Rancid provisioning adapter for integration with OpenNMS Provisioning daemon API.
    Version:
    $Id: $
    Author:
    Antonio Russo

    • Field Detail

      • NAME

        public static final java.lang.String NAME
        Constant NAME="RancidProvisioningAdapter"
        See Also:
        Constant Field Values

    • Constructor Detail

      • RancidProvisioningAdapter

        public RancidProvisioningAdapter()

    • Method Detail

      • setTemplate

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

        setTemplate

        Parameters:
        template - a TransactionTemplate object.

      • afterPropertiesSet

        public void afterPropertiesSet()
                        throws java.lang.Exception

        afterPropertiesSet

        Specified by:
        afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean
        Throws:
        java.lang.Exception - if any.

      • doUpdate

        public void doUpdate​(int nodeId,
                     org.opennms.rancid.ConnectionProperties cp,
                     boolean retry)
              throws ProvisioningAdapterException

        doUpdate

        Parameters:
        nodeId - a int.
        cp - a ConnectionProperties object.
        retry - a boolean.
        Throws:
        ProvisioningAdapterException - if any.

      • doDelete

        public void doDelete​(int nodeId,
                     org.opennms.rancid.ConnectionProperties cp,
                     boolean retry)
              throws ProvisioningAdapterException

        doDelete

        Parameters:
        nodeId - a int.
        cp - a ConnectionProperties object.
        retry - a boolean.
        Throws:
        ProvisioningAdapterException - if any.

      • doNodeConfigChanged

        public void doNodeConfigChanged​(int nodeId,
                                org.opennms.rancid.ConnectionProperties cp,
                                boolean retry)
                         throws ProvisioningAdapterException

        doNodeConfigChanged

        Parameters:
        nodeId - a int.
        cp - a ConnectionProperties object.
        retry - a boolean.
        Throws:
        ProvisioningAdapterException - if any.

      • getNodeDao

        public NodeDao getNodeDao()

        getNodeDao

        Returns:
        a NodeDao object.

      • setNodeDao

        public void setNodeDao​(NodeDao dao)

        setNodeDao

        Parameters:
        dao - a NodeDao object.

      • setEventForwarder

        public void setEventForwarder​(EventForwarder eventForwarder)

        setEventForwarder

        Parameters:
        eventForwarder - a EventForwarder object.

      • getRwsConfig

        public RWSConfig getRwsConfig()

        getRwsConfig

        Returns:
        a RWSConfig object.

      • setRwsConfig

        public void setRwsConfig​(RWSConfig rwsConfig)

        setRwsConfig

        Parameters:
        rwsConfig - a RWSConfig object.

      • setRancidAdapterConfig

        public void setRancidAdapterConfig​(RancidAdapterConfig rancidAdapterConfig)

        setRancidAdapterConfig

        Parameters:
        rancidAdapterConfig - a RancidAdapterConfig 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.

      • handleReloadConfigEvent

        public void handleReloadConfigEvent​(IEvent event)

        handleReloadConfigEvent

        Parameters:
        event - a IEvent object.

      • handleRancidDownLoadFailure

        public void handleRancidDownLoadFailure​(IEvent e)

        handleRancidDownLoadFailure

        Parameters:
        e - a IEvent object.

      • handleRancidDownLoadSuccess

        public void handleRancidDownLoadSuccess​(IEvent e)

        handleRancidDownLoadSuccess

        Parameters:
        e - a IEvent object.

      • handleRancidGroupProcessingCompleted

        public void handleRancidGroupProcessingCompleted​(IEvent e)

        handleRancidGroupProcessingCompleted

        Parameters:
        e - a IEvent object.