Deprecate old MD-SAL APIs for removal
[controller.git] / opendaylight / md-sal / sal-binding-api / src / main / java / org / opendaylight / controller / md / sal / binding / api / ClusteredDataTreeChangeListener.java
1 /*
2  * Copyright (c) 2015 Brocade Communications 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.controller.md.sal.binding.api;
9
10 import org.opendaylight.yangtools.yang.binding.DataObject;
11
12 /**
13  * ClusteredDataTreeChangeListener is a marker interface to enable data tree change notifications on all
14  * instances in a cluster where this listener is registered.
15  *
16  * <p>
17  * Applications should implement ClusteredDataTreeChangeListener instead of {@link DataTreeChangeListener},
18  * if they want to listen for data tree change notifications on any node of a clustered data store.
19  * {@link DataTreeChangeListener} enables notifications only at the leader of the data store.
20  *
21  * @author Thomas Pantelis
22  *
23  * @param <T> the DataObject type
24  *
25  * @deprecated Use {@link org.opendaylight.mdsal.binding.api.ClusteredDataTreeChangeListener} instead.
26  */
27 @Deprecated(forRemoval = true)
28 public interface ClusteredDataTreeChangeListener<T extends DataObject> extends DataTreeChangeListener<T> {
29
30 }