Deprecated controller fine-grained sharding APIs 77/61077/1
authorRobert Varga <robert.varga@pantheon.tech>
Wed, 2 Aug 2017 21:18:57 +0000 (23:18 +0200)
committerRobert Varga <robert.varga@pantheon.tech>
Wed, 2 Aug 2017 21:18:57 +0000 (23:18 +0200)
These are not maintained nor were they ever implemented. Deprecate
them and point to their mdsal counterparts to reduce confusion.

Change-Id: Idd1908c65b0737df0a3731e6e81a7d1c71f272d0
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>
17 files changed:
opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeInaccessibleException.java
opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeListener.java
opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeListeningException.java
opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeLoopException.java
opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeProducer.java
opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeProducerBusyException.java
opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeProducerException.java
opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeProducerFactory.java
opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeService.java
opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeShard.java
opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeShardingConflictException.java
opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeShardingService.java
opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/broker/impl/ShardRegistration.java
opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/broker/impl/ShardedDOMDataTree.java
opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/broker/impl/ShardedDOMDataTreeProducer.java
opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/broker/impl/ShardedDOMDataWriteTransaction.java
opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/broker/impl/ShardingTableEntry.java

index eea1be5..2f8eeb0 100644 (file)
@@ -9,10 +9,12 @@ package org.opendaylight.controller.md.sal.dom.api;
 
 import com.google.common.base.Preconditions;
 
-
 /**
  * Failure reported when a data tree is no longer accessible.
+ *
+ * @deprecated Use {@link org.opendaylight.mdsal.dom.api.DOMDataTreeInaccessibleException} instead.
  */
+@Deprecated
 public class DOMDataTreeInaccessibleException extends DOMDataTreeListeningException {
     private static final long serialVersionUID = 1L;
     private final DOMDataTreeIdentifier treeIdentifier;
index 7392b15..5431c86 100644 (file)
@@ -17,7 +17,10 @@ import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
 /**
  * Interface implemented by data consumers, e.g. processes wanting to act on data
  * after it has been introduced to the conceptual data tree.
+ *
+ * @deprecated Use {@link org.opendaylight.mdsal.dom.api.DOMDataTreeListener} instead.
  */
+@Deprecated
 public interface DOMDataTreeListener extends EventListener {
     /**
      * Invoked whenever one or more registered subtrees change. The logical changes are reported,
index e0d9b42..435257d 100644 (file)
@@ -10,7 +10,10 @@ package org.opendaylight.controller.md.sal.dom.api;
 /**
  * Base exception for various causes why and {@link DOMDataTreeListener}
  * may be terminated by the {@link DOMDataTreeService} implementation.
+ *
+ * @deprecated Use {@link org.opendaylight.mdsal.dom.api.DOMDataTreeListeningException} instead.
  */
+@Deprecated
 public class DOMDataTreeListeningException extends Exception {
     private static final long serialVersionUID = 1L;
 
index 8f498a8..9105b94 100644 (file)
@@ -12,7 +12,10 @@ import javax.annotation.Nonnull;
 /**
  * Exception thrown when a loop is detected in the way {@link DOMDataTreeListener}
  * and {@link DOMDataTreeProducer} instances would be connected.
+ *
+ * @deprecated Use {@link org.opendaylight.mdsal.dom.api.DOMDataTreeLoopException} instead.
  */
+@Deprecated
 public class DOMDataTreeLoopException extends Exception {
     private static final long serialVersionUID = 1L;
 
index 48f47d1..404de1c 100644 (file)
@@ -37,7 +37,10 @@ import javax.annotation.Nonnull;
  * callback on that particular instance. Any transaction which is not submitted by the
  * time the callback returns will be implicitly cancelled. A producer becomes unbound
  * when the listener it is bound to becomes unregistered.
+ *
+ * @deprecated Use {@link org.opendaylight.mdsal.dom.api.DOMDataTreeProducer} instead.
  */
+@Deprecated
 public interface DOMDataTreeProducer extends DOMDataTreeProducerFactory, AutoCloseable {
     /**
      * Allocate a new open transaction on this producer. Any and all transactions
index a83a5ca..f80eb12 100644 (file)
@@ -10,7 +10,10 @@ package org.opendaylight.controller.md.sal.dom.api;
 /**
  * Exception indicating that the {@link DOMDataTreeProducer} has an open user
  * transaction and cannot be closed.
+ *
+ * @deprecated Use {@link org.opendaylight.mdsal.dom.api.DOMDataTreeProducerBusyException} instead.
  */
+@Deprecated
 public class DOMDataTreeProducerBusyException extends DOMDataTreeProducerException {
     private static final long serialVersionUID = 1L;
 
index 16c2676..e57022d 100644 (file)
@@ -9,7 +9,10 @@ package org.opendaylight.controller.md.sal.dom.api;
 
 /**
  * Base exception for all exceptions related to {@link DOMDataTreeProducer}s.
+ *
+ * @deprecated Use {@link org.opendaylight.mdsal.dom.api.DOMDataTreeProducerException} instead.
  */
+@Deprecated
 public class DOMDataTreeProducerException extends Exception {
     private static final long serialVersionUID = 1L;
 
index 46726da..f94b6ce 100644 (file)
@@ -13,7 +13,10 @@ import javax.annotation.Nonnull;
 /**
  * Base source of {@link DOMDataTreeProducer}s. This interface is usually not used directly,
  * but rather through one of its sub-interfaces.
+ *
+ * @deprecated Use {@link org.opendaylight.mdsal.dom.api.DOMDataTreeProducerFactory} instead.
  */
+@Deprecated
 public interface DOMDataTreeProducerFactory {
     /**
      * Create a producer, which is able to access to a set of trees.
index bb4d547..5323cea 100644 (file)
@@ -26,7 +26,10 @@ import org.opendaylight.yangtools.concepts.ListenerRegistration;
  * not go into a feedback loop, where it is impossible to block either a producer or
  * a consumer without accumulating excess work in the backlog stemming from its previous
  * activity.
+ *
+ * @deprecated Use {@link org.opendaylight.mdsal.dom.api.DOMDataTreeService} instead.
  */
+@Deprecated
 public interface DOMDataTreeService extends DOMDataTreeProducerFactory, DOMService {
     /**
      * Register a {@link DOMDataTreeListener} instance. Once registered, the listener
index e9ef003..1aae65a 100644 (file)
@@ -15,7 +15,10 @@ import javax.annotation.Nonnull;
  * a shard can receive. Each shard implementation is expected to also implement some of the
  * datastore-level APIs. Which interfaces are required depends on the {@link DOMDataTreeShardingService}
  * implementation.
+ *
+ * @deprecated Use {@link org.opendaylight.mdsal.dom.api.DOMDataTreeShard} instead.
  */
+@Deprecated
 public interface DOMDataTreeShard extends EventListener {
     /**
      * Invoked whenever a child is getting attached as a more specific prefix under this shard.
index d44316d..779a474 100644 (file)
@@ -10,9 +10,11 @@ package org.opendaylight.controller.md.sal.dom.api;
 import javax.annotation.Nonnull;
 
 /**
- * Exception thrown when an attempt to attach a conflicting shard to the global
- * table.
+ * Exception thrown when an attempt to attach a conflicting shard to the global table.
+ *
+ * @deprecated Use {@link org.opendaylight.mdsal.dom.api.DOMDataTreeShardingConflictException} instead.
  */
+@Deprecated
 public class DOMDataTreeShardingConflictException extends Exception {
     private static final long serialVersionUID = 1L;
 
index c087224..e8c09a3 100644 (file)
@@ -23,7 +23,10 @@ import org.opendaylight.yangtools.concepts.ListenerRegistration;
  *
  * Whenever a parent/child relationship is changed, the parent is notified, so it can
  * understand that a logical child has been attached.
+ *
+ * @deprecated Use {@link org.opendaylight.mdsal.dom.api.DOMDataTreeShardingService} instead.
  */
+@Deprecated
 public interface DOMDataTreeShardingService extends DOMService {
     /**
      * Register a shard as responsible for a particular subtree prefix.
index 9a71089..4411599 100644 (file)
@@ -12,6 +12,10 @@ import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeIdentifier;
 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeShard;
 import org.opendaylight.yangtools.concepts.AbstractListenerRegistration;
 
+/**
+ * @deprecated To be removed with {@link ShardedDOMDataTree}.
+ */
+@Deprecated
 final class ShardRegistration<T extends DOMDataTreeShard> extends AbstractListenerRegistration<T> {
     private final DOMDataTreeIdentifier prefix;
     private final ShardedDOMDataTree tree;
index cd9f7bd..7af8d2c 100644 (file)
@@ -27,6 +27,10 @@ import org.opendaylight.yangtools.concepts.ListenerRegistration;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+/**
+ * @deprecated Use {@link org.opendaylight.mdsal.dom.broker.ShardedDOMDataTree} instead.
+ */
+@Deprecated
 public final class ShardedDOMDataTree implements DOMDataTreeService, DOMDataTreeShardingService {
     private static final Logger LOG = LoggerFactory.getLogger(ShardedDOMDataTree.class);
     private final Map<LogicalDatastoreType, ShardingTableEntry> shardingTables = new EnumMap<>(LogicalDatastoreType.class);
index 9b485df..edf6aec 100644 (file)
@@ -34,6 +34,10 @@ import org.opendaylight.controller.sal.core.spi.data.DOMStoreWriteTransaction;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+/**
+ * @deprecated To be removed with {@link ShardedDOMDataTree}.
+ */
+@Deprecated
 final class ShardedDOMDataTreeProducer implements DOMDataTreeProducer {
     private static final Logger LOG = LoggerFactory.getLogger(ShardedDOMDataTreeProducer.class);
     private final BiMap<DOMDataTreeShard, DOMStoreTransactionChain> shardToChain;
index 33f15e3..6e89c8e 100644 (file)
@@ -34,6 +34,10 @@ import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+/**
+ * @deprecated To be removed with {@link ShardedDOMDataTree}.
+ */
+@Deprecated
 @NotThreadSafe
 final class ShardedDOMDataWriteTransaction implements DOMDataWriteTransaction {
     private static final Logger LOG = LoggerFactory.getLogger(ShardedDOMDataWriteTransaction.class);
index 1fdbb6d..3990c7f 100644 (file)
@@ -17,6 +17,10 @@ import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgum
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+/**
+ * @deprecated To be removed with {@link ShardedDOMDataTree}.
+ */
+@Deprecated
 final class ShardingTableEntry implements Identifiable<PathArgument> {
     private static final Logger LOG = LoggerFactory.getLogger(ShardingTableEntry.class);
     private final Map<PathArgument, ShardingTableEntry> children = Collections.emptyMap();

©2013 OpenDaylight, A Linux Foundation Collaborative Project. All Rights Reserved.
OpenDaylight is a registered trademark of The OpenDaylight Project, Inc.
Linux Foundation and OpenDaylight are registered trademarks of the Linux Foundation.
Linux is a registered trademark of Linus Torvalds.