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 eea1be51bb37b1aefb3bcade27f528d88b203032..2f8eeb0c2ad2ab40b597bc15389d124a26c1f6aa 100644 (file)
@@ -9,10 +9,12 @@ package org.opendaylight.controller.md.sal.dom.api;
 
 import com.google.common.base.Preconditions;
 
 
 import com.google.common.base.Preconditions;
 
-
 /**
  * Failure reported when a data tree is no longer accessible.
 /**
  * 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;
 public class DOMDataTreeInaccessibleException extends DOMDataTreeListeningException {
     private static final long serialVersionUID = 1L;
     private final DOMDataTreeIdentifier treeIdentifier;
index 7392b153454fbfae059027cce0abf2b0aa8dfe75..5431c861387efa825f35c19bf664fa22a3b55c1a 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.
 /**
  * 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,
 public interface DOMDataTreeListener extends EventListener {
     /**
      * Invoked whenever one or more registered subtrees change. The logical changes are reported,
index e0d9b427d922f5071cd661d21b5a66c9b17f76d5..435257d3a202378f3da412dcf89222e716f51c69 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.
 /**
  * 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;
 
 public class DOMDataTreeListeningException extends Exception {
     private static final long serialVersionUID = 1L;
 
index 8f498a887dbd49be52d87f79d5f0c2aa145feba1..9105b94494139679fef19fc7382bd441300e9d52 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.
 /**
  * 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;
 
 public class DOMDataTreeLoopException extends Exception {
     private static final long serialVersionUID = 1L;
 
index 48f47d181d4903ce2cc0239cb3aebd0290a3091d..404de1c00f794747f3ab17c2a63dba69e40f582e 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.
  * 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
 public interface DOMDataTreeProducer extends DOMDataTreeProducerFactory, AutoCloseable {
     /**
      * Allocate a new open transaction on this producer. Any and all transactions
index a83a5ca3d207620307d789fbe8bd968e4c27aedc..f80eb1294d2aed796d80cb90222276edcd3b92bc 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.
 /**
  * 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;
 
 public class DOMDataTreeProducerBusyException extends DOMDataTreeProducerException {
     private static final long serialVersionUID = 1L;
 
index 16c26760ffc920e3bea27e17e8a0b0b860b66ecc..e57022da2d4b702bf0aca99b2f78f998c0cc8361 100644 (file)
@@ -9,7 +9,10 @@ package org.opendaylight.controller.md.sal.dom.api;
 
 /**
  * Base exception for all exceptions related to {@link DOMDataTreeProducer}s.
 
 /**
  * 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;
 
 public class DOMDataTreeProducerException extends Exception {
     private static final long serialVersionUID = 1L;
 
index 46726da42131388e530beeb8a8b2808ae350e2b3..f94b6ce52d5ee9571ded1bf3adf62db442ae92df 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.
 /**
  * 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.
 public interface DOMDataTreeProducerFactory {
     /**
      * Create a producer, which is able to access to a set of trees.
index bb4d54720a2a5fffde9cccbbff1efbf092b597f0..5323cea7470e53bc2a6cd564838cc6d1f9df4289 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.
  * 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
 public interface DOMDataTreeService extends DOMDataTreeProducerFactory, DOMService {
     /**
      * Register a {@link DOMDataTreeListener} instance. Once registered, the listener
index e9ef0034ead60a93edcf5066e1521cfa30d8e79e..1aae65aca5494e24316bf6c743d6eea3b17682fa 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.
  * 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.
 public interface DOMDataTreeShard extends EventListener {
     /**
      * Invoked whenever a child is getting attached as a more specific prefix under this shard.
index d44316d39dc0c1d862100341856fefa5fc780266..779a474b9c3260bcfe4a472b78bc10103a0560bd 100644 (file)
@@ -10,9 +10,11 @@ package org.opendaylight.controller.md.sal.dom.api;
 import javax.annotation.Nonnull;
 
 /**
 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;
 
 public class DOMDataTreeShardingConflictException extends Exception {
     private static final long serialVersionUID = 1L;
 
index c087224090ec5779f64833388af42379f14b612a..e8c09a32fb8e9e06ee5175e06e2a85b328ac7559 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.
  *
  * 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.
 public interface DOMDataTreeShardingService extends DOMService {
     /**
      * Register a shard as responsible for a particular subtree prefix.
index 9a710899460f8d19fe8e71f269333c0467f47651..4411599de6dc45cc99219b9362d7c59af3f3a4b3 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;
 
 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;
 final class ShardRegistration<T extends DOMDataTreeShard> extends AbstractListenerRegistration<T> {
     private final DOMDataTreeIdentifier prefix;
     private final ShardedDOMDataTree tree;
index cd9f7bd37991bb03ba7861a73371bde03badc4c8..7af8d2c72026a470a654c914aa4d6b79c039cb43 100644 (file)
@@ -27,6 +27,10 @@ import org.opendaylight.yangtools.concepts.ListenerRegistration;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 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);
 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 9b485df13a95a0b4a9e038c607a016a058a543f8..edf6aec5cc0eeb0b564a956070d43420dac895b5 100644 (file)
@@ -34,6 +34,10 @@ import org.opendaylight.controller.sal.core.spi.data.DOMStoreWriteTransaction;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 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;
 final class ShardedDOMDataTreeProducer implements DOMDataTreeProducer {
     private static final Logger LOG = LoggerFactory.getLogger(ShardedDOMDataTreeProducer.class);
     private final BiMap<DOMDataTreeShard, DOMStoreTransactionChain> shardToChain;
index 33f15e3f673d0d56e6f1376d753455391a3c3aa7..6e89c8e44c579d22d8d8a947cc18ae167f3a01bb 100644 (file)
@@ -34,6 +34,10 @@ import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 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);
 @NotThreadSafe
 final class ShardedDOMDataWriteTransaction implements DOMDataWriteTransaction {
     private static final Logger LOG = LoggerFactory.getLogger(ShardedDOMDataWriteTransaction.class);
index 1fdbb6d2e42e18f6173485c994a25d22ff9651dd..3990c7fb0babdc0be624ab9988f53ba08a369d8c 100644 (file)
@@ -17,6 +17,10 @@ import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgum
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 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();
 final class ShardingTableEntry implements Identifiable<PathArgument> {
     private static final Logger LOG = LoggerFactory.getLogger(ShardingTableEntry.class);
     private final Map<PathArgument, ShardingTableEntry> children = Collections.emptyMap();