Deprecate Clustered(DOM)DataTreeChangeListener
[mdsal.git] / dom / mdsal-dom-api / src / main / java / org / opendaylight / mdsal / dom / api / ClusteredDOMDataTreeChangeListener.java
1 /*
2  * Copyright (c) 2017 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.mdsal.dom.api;
9
10 import org.opendaylight.mdsal.dom.api.DOMDataBroker.DataTreeChangeExtension;
11
12 /**
13  * ClusteredDOMDataTreeChangeListener is a marker interface to enable data tree change notifications on all instances in
14  * a cluster where this listener is registered.
15  *
16  * <p>
17  * Applications should implement ClusteredDOMDataTreeChangeListener instead of {@link DOMDataTreeChangeListener},
18  * if they want to listen for data tree change notifications on any node of a clustered data store.
19  * {@link DOMDataTreeChangeListener} enables notifications only at the leader of the data store.
20  *
21  * @deprecated Use plain {@link DOMDataTreeChangeListener} and use
22  *             {@link DataTreeChangeExtension#registerTreeChangeListener(DOMDataTreeIdentifier,
23  *                    DOMDataTreeChangeListener)} instead.
24  * @author Thomas Pantelis
25  */
26 @Deprecated(since = "13.0.0", forRemoval = true)
27 public interface ClusteredDOMDataTreeChangeListener extends DOMDataTreeChangeListener {
28     // Just a marker
29 }