From: Robert Varga Date: Wed, 2 Aug 2017 21:18:57 +0000 (+0200) Subject: Deprecated controller fine-grained sharding APIs X-Git-Tag: release/nitrogen~17 X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=commitdiff_plain;h=89b1c5b7d66614d1b98ec14abc3326fb878eb056 Deprecated controller fine-grained sharding APIs 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 --- diff --git a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeInaccessibleException.java b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeInaccessibleException.java index eea1be51bb..2f8eeb0c2a 100644 --- a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeInaccessibleException.java +++ b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeInaccessibleException.java @@ -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; diff --git a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeListener.java b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeListener.java index 7392b15345..5431c86138 100644 --- a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeListener.java +++ b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeListener.java @@ -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, diff --git a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeListeningException.java b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeListeningException.java index e0d9b427d9..435257d3a2 100644 --- a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeListeningException.java +++ b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeListeningException.java @@ -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; diff --git a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeLoopException.java b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeLoopException.java index 8f498a887d..9105b94494 100644 --- a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeLoopException.java +++ b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeLoopException.java @@ -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; diff --git a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeProducer.java b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeProducer.java index 48f47d181d..404de1c00f 100644 --- a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeProducer.java +++ b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeProducer.java @@ -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 diff --git a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeProducerBusyException.java b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeProducerBusyException.java index a83a5ca3d2..f80eb1294d 100644 --- a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeProducerBusyException.java +++ b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeProducerBusyException.java @@ -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; diff --git a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeProducerException.java b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeProducerException.java index 16c26760ff..e57022da2d 100644 --- a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeProducerException.java +++ b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeProducerException.java @@ -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; diff --git a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeProducerFactory.java b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeProducerFactory.java index 46726da421..f94b6ce52d 100644 --- a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeProducerFactory.java +++ b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeProducerFactory.java @@ -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. diff --git a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeService.java b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeService.java index bb4d54720a..5323cea747 100644 --- a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeService.java +++ b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeService.java @@ -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 diff --git a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeShard.java b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeShard.java index e9ef0034ea..1aae65aca5 100644 --- a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeShard.java +++ b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeShard.java @@ -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. diff --git a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeShardingConflictException.java b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeShardingConflictException.java index d44316d39d..779a474b9c 100644 --- a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeShardingConflictException.java +++ b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeShardingConflictException.java @@ -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; diff --git a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeShardingService.java b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeShardingService.java index c087224090..e8c09a32fb 100644 --- a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeShardingService.java +++ b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeShardingService.java @@ -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. diff --git a/opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/broker/impl/ShardRegistration.java b/opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/broker/impl/ShardRegistration.java index 9a71089946..4411599de6 100644 --- a/opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/broker/impl/ShardRegistration.java +++ b/opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/broker/impl/ShardRegistration.java @@ -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 extends AbstractListenerRegistration { private final DOMDataTreeIdentifier prefix; private final ShardedDOMDataTree tree; diff --git a/opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/broker/impl/ShardedDOMDataTree.java b/opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/broker/impl/ShardedDOMDataTree.java index cd9f7bd379..7af8d2c720 100644 --- a/opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/broker/impl/ShardedDOMDataTree.java +++ b/opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/broker/impl/ShardedDOMDataTree.java @@ -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 shardingTables = new EnumMap<>(LogicalDatastoreType.class); diff --git a/opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/broker/impl/ShardedDOMDataTreeProducer.java b/opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/broker/impl/ShardedDOMDataTreeProducer.java index 9b485df13a..edf6aec5cc 100644 --- a/opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/broker/impl/ShardedDOMDataTreeProducer.java +++ b/opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/broker/impl/ShardedDOMDataTreeProducer.java @@ -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 shardToChain; diff --git a/opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/broker/impl/ShardedDOMDataWriteTransaction.java b/opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/broker/impl/ShardedDOMDataWriteTransaction.java index 33f15e3f67..6e89c8e44c 100644 --- a/opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/broker/impl/ShardedDOMDataWriteTransaction.java +++ b/opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/broker/impl/ShardedDOMDataWriteTransaction.java @@ -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); diff --git a/opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/broker/impl/ShardingTableEntry.java b/opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/broker/impl/ShardingTableEntry.java index 1fdbb6d2e4..3990c7fb0b 100644 --- a/opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/broker/impl/ShardingTableEntry.java +++ b/opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/broker/impl/ShardingTableEntry.java @@ -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 { private static final Logger LOG = LoggerFactory.getLogger(ShardingTableEntry.class); private final Map children = Collections.emptyMap();