6017e7d7f63e7489e59bc047caca737f37fe3e3c
[openflowplugin.git] / 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
9 package org.opendaylight.openflowplugin.applications.notification.supplier;
10
11 import org.opendaylight.controller.md.sal.binding.api.DataTreeChangeListener;
12 import org.opendaylight.yangtools.yang.binding.DataObject;
13 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
14
15 /**
16  * Default definition for every Notification Supplier. Migration from notification
17  * to {@link org.opendaylight.controller.md.sal.binding.api.DataTreeChangeListener} has one
18  * keyed component - WildCarded Path which represent a changes checker in DataStoreTreeNode
19  *
20  * @param <O> - {@link DataObject} represent Data Tree Item from DataStore
21  */
22 public interface NotificationSupplierDefinition<O extends DataObject> extends AutoCloseable, DataTreeChangeListener<O> {
23
24     /**
25      * Method return wildCardPath for Listener registration and for identify
26      * the correct KeyInstanceIdentifier from Data Tree Item in DataStore.
27      *
28      * @return {@link InstanceIdentifier}
29      */
30     InstanceIdentifier<O> getWildCardPath();
31 }
32