Bug 4651: Add ClusteredDataTreeChangeListener interface and binding adapter

[controller.git] / opendaylight / md-sal / sal-dom-api / src / main / java / org / opendaylight / controller / md / sal / dom / api / ClusteredDOMDataTreeChangeListener.java

diff --git a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/ClusteredDOMDataTreeChangeListener.java b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/ClusteredDOMDataTreeChangeListener.java
new file mode 100644 (file)
index 0000000..5da80e4
--- /dev/null
+++ b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/ClusteredDOMDataTreeChangeListener.java
@@ -0,0 +1,22 @@
+/*
+ * Copyright (c) 2015 Brocade Communications Systems, Inc. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.opendaylight.controller.md.sal.dom.api;
+
+/**
+ *  ClusteredDOMDataTreeChangeListener is a marker interface to enable data tree change notifications on all
+ * instances in a cluster where this listener is registered.
+ * <p>
+ * Applications should implement ClusteredDOMDataTreeChangeListener instead of {@link DOMDataTreeChangeListener},
+ * if they want to listen for data tree change notifications on any node of a clustered data store.
+ * {@link DOMDataTreeChangeListener} enables notifications only at the leader of the data store.
+ *
+ * @author Thomas Pantelis
+ */
+public interface ClusteredDOMDataTreeChangeListener extends DOMDataTreeChangeListener {
+
+}