Package org.opendaylight.serviceutils.tools.listener

Class AbstractSyncDataTreeChangeListener<T extends org.opendaylight.yangtools.yang.binding.DataObject>

java.lang.Object
org.opendaylight.serviceutils.tools.listener.AbstractSyncDataTreeChangeListener<T>
Type Parameters:
T - type of the data object the listener is registered to.
All Implemented Interfaces:
AutoCloseable, EventListener, org.opendaylight.mdsal.binding.api.DataTreeChangeListener<T>, ChainableDataTreeChangeListener<T>
public abstract class AbstractSyncDataTreeChangeListener<T extends org.opendaylight.yangtools.yang.binding.DataObject> extends Object
Abstract class providing some common functionality to specific listeners. This should be the most common parent class for any listener that does not need to be either cluster-aware (see AbstractClusteredSyncDataTreeChangeListener) or to process notifications asynchronously (see AbstractAsyncDataTreeChangeListener) or even both characteristics (see AbstractClusteredAsyncDataTreeChangeListener).
Author:
David Suárez (david.suarez.fuentes@gmail.com)

  • Constructor Summary

    Constructors
    Constructor
    Description
    AbstractSyncDataTreeChangeListener(org.opendaylight.mdsal.binding.api.DataBroker dataBroker, org.opendaylight.mdsal.binding.api.DataTreeIdentifier<T> dataTreeIdentifier)
     
    AbstractSyncDataTreeChangeListener(org.opendaylight.mdsal.binding.api.DataBroker dataBroker, org.opendaylight.mdsal.common.api.LogicalDatastoreType datastoreType, org.opendaylight.yangtools.yang.binding.InstanceIdentifier<T> instanceIdentifier)
     
    AbstractSyncDataTreeChangeListener(org.opendaylight.mdsal.binding.api.DataBroker dataBroker, org.opendaylight.mdsal.common.api.LogicalDatastoreType datastoreType, org.opendaylight.yangtools.yang.binding.InstanceIdentifier<T> instanceIdentifier, MetricProvider metricProvider)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    add(@NonNull org.opendaylight.yangtools.yang.binding.InstanceIdentifier<T> instanceIdentifier, T newDataObject)
    Invoked when a new data object is added.
    void
    add(T newDataObject)
    Deprecated.
    void
    addAfterListener(org.opendaylight.mdsal.binding.api.DataTreeChangeListener<T> listener)
    Adds a "chained" DataTreeChangeListener, to which DataTreeChangeListener.onDataTreeChanged(java.util.Collection) calls are forwarded AFTER having been processed by this DataTreeChangeListener.
    void
    addBeforeListener(org.opendaylight.mdsal.binding.api.DataTreeChangeListener<T> listener)
    Adds a "chained" DataTreeChangeListener, to which DataTreeChangeListener.onDataTreeChanged(java.util.Collection) calls are forwarded BEFORE having been processed by this DataTreeChangeListener.
    void
    close()
     
    protected org.opendaylight.mdsal.binding.api.DataBroker
    getDataBroker()
     
    protected org.opendaylight.serviceutils.tools.listener.DataStoreMetrics
    getDataStoreMetrics()
     
    final void
    onDataTreeChanged(Collection<org.opendaylight.mdsal.binding.api.DataTreeModification<T>> collection)
     
    default void
    onDataTreeChanged(Collection<org.opendaylight.mdsal.binding.api.DataTreeModification<T>> changes, org.opendaylight.serviceutils.tools.listener.DataStoreMetrics dataStoreMetrics)
    Default method invoked upon data tree change, in turn it calls the appropriate method (add, update, remove) depending on the type of change.
    void
    register()
     
    default void
    remove(@NonNull org.opendaylight.yangtools.yang.binding.InstanceIdentifier<T> instanceIdentifier, T removedDataObject)
    Invoked when the data object has been removed.
    void
    remove(T removedDataObject)
    Deprecated.
    default void
    update(@NonNull org.opendaylight.yangtools.yang.binding.InstanceIdentifier<T> instanceIdentifier, T originalDataObject, T updatedDataObject)
    Invoked when there is a change in the data object.
    void
    update(T originalDataObject, T updatedDataObject)
    Deprecated.

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.opendaylight.mdsal.binding.api.DataTreeChangeListener

    onInitialData

  • Constructor Details

    • AbstractSyncDataTreeChangeListener

      public AbstractSyncDataTreeChangeListener(org.opendaylight.mdsal.binding.api.DataBroker dataBroker, org.opendaylight.mdsal.binding.api.DataTreeIdentifier<T> dataTreeIdentifier)

    • AbstractSyncDataTreeChangeListener

      public AbstractSyncDataTreeChangeListener(org.opendaylight.mdsal.binding.api.DataBroker dataBroker, org.opendaylight.mdsal.common.api.LogicalDatastoreType datastoreType, org.opendaylight.yangtools.yang.binding.InstanceIdentifier<T> instanceIdentifier)

    • AbstractSyncDataTreeChangeListener

      public AbstractSyncDataTreeChangeListener(org.opendaylight.mdsal.binding.api.DataBroker dataBroker, org.opendaylight.mdsal.common.api.LogicalDatastoreType datastoreType, org.opendaylight.yangtools.yang.binding.InstanceIdentifier<T> instanceIdentifier, MetricProvider metricProvider)

  • Method Details

    • onDataTreeChanged

      public final void onDataTreeChanged(Collection<org.opendaylight.mdsal.binding.api.DataTreeModification<T>> collection)

    • addBeforeListener

      public void addBeforeListener(org.opendaylight.mdsal.binding.api.DataTreeChangeListener<T> listener)
      Description copied from interface: ChainableDataTreeChangeListener
      Adds a "chained" DataTreeChangeListener, to which DataTreeChangeListener.onDataTreeChanged(java.util.Collection) calls are forwarded BEFORE having been processed by this DataTreeChangeListener.

      If an asychronous DataTreeChangeListener supports chaining, it must forward the onDataTreeChanged() call BEFORE event are submitted to its async executor for processing.

      Specified by:
      addBeforeListener in interface ChainableDataTreeChangeListener<T extends org.opendaylight.yangtools.yang.binding.DataObject>
      Parameters:
      listener - the chained DataTreeChangeListener to invoke after this one

    • addAfterListener

      public void addAfterListener(org.opendaylight.mdsal.binding.api.DataTreeChangeListener<T> listener)
      Description copied from interface: ChainableDataTreeChangeListener
      Adds a "chained" DataTreeChangeListener, to which DataTreeChangeListener.onDataTreeChanged(java.util.Collection) calls are forwarded AFTER having been processed by this DataTreeChangeListener.

      If an asychronous DataTreeChangeListener supports chaining, it must forward the onDataTreeChanged() call ONLY AFTER its async executor processed the event.

      Specified by:
      addAfterListener in interface ChainableDataTreeChangeListener<T extends org.opendaylight.yangtools.yang.binding.DataObject>
      Parameters:
      listener - the chained DataTreeChangeListener to invoke after this one

    • register

      @PostConstruct public void register()

    • getDataBroker

      protected org.opendaylight.mdsal.binding.api.DataBroker getDataBroker()

    • getDataStoreMetrics

      protected org.opendaylight.serviceutils.tools.listener.DataStoreMetrics getDataStoreMetrics()

    • close

      @PreDestroy public void close()
      Specified by:
      close in interface AutoCloseable

    • add

      @Deprecated public void add(T newDataObject)
      Deprecated.

    • remove

      @Deprecated public void remove(T removedDataObject)
      Deprecated.

    • update

      @Deprecated public void update(T originalDataObject, T updatedDataObject)
      Deprecated.

    • onDataTreeChanged

      default void onDataTreeChanged(Collection<org.opendaylight.mdsal.binding.api.DataTreeModification<T>> changes, org.opendaylight.serviceutils.tools.listener.DataStoreMetrics dataStoreMetrics)
      Default method invoked upon data tree change, in turn it calls the appropriate method (add, update, remove) depending on the type of change.
      Parameters:
      changes - collection of changes
      dataStoreMetrics - data store metrics

    • add

      default void add(@NonNull org.opendaylight.yangtools.yang.binding.InstanceIdentifier<T> instanceIdentifier, T newDataObject)
      Invoked when a new data object is added.
      Parameters:
      instanceIdentifier - instance id for this data object
      newDataObject - newly added object

    • remove

      default void remove(@NonNull org.opendaylight.yangtools.yang.binding.InstanceIdentifier<T> instanceIdentifier, T removedDataObject)
      Invoked when the data object has been removed.
      Parameters:
      instanceIdentifier - instance id for this data object
      removedDataObject - existing object being removed

    • update

      default void update(@NonNull org.opendaylight.yangtools.yang.binding.InstanceIdentifier<T> instanceIdentifier, T originalDataObject, T updatedDataObject)
      Invoked when there is a change in the data object.
      Parameters:
      instanceIdentifier - instance id for this data object
      originalDataObject - existing object being modified
      updatedDataObject - modified data object