applications/notification-supplier/src/main/java/org/opendaylight/openflowplugin/applications/notification/supplier/NotificationSupplierDefinition.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.openflowplugin.applications.notification.supplier;
   9
  10 import org.opendaylight.mdsal.binding.api.DataTreeChangeListener;
  11 import org.opendaylight.yangtools.yang.binding.DataObject;
  12 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  13
  14 /**
  15  * Default definition for every Notification Supplier. Migration from notification
  16  * to {@link DataTreeChangeListener} has one
  17  * keyed component - WildCarded Path which represent a changes checker in DataStoreTreeNode
  18  *
  19  * @param <O> - {@link DataObject} represent Data Tree Item from DataStore
  20  */
  21 public interface NotificationSupplierDefinition<O extends DataObject> extends AutoCloseable, DataTreeChangeListener<O> {
  22
  23     /**
  24      * Method return wildCardPath for Listener registration and for identify
  25      * the correct KeyInstanceIdentifier from Data Tree Item in DataStore.
  26      *
  27      * @return {@link InstanceIdentifier}
  28      */
  29     InstanceIdentifier<O> getWildCardPath();
  30 }
  31