Deprecate controller APIs 82/74582/2
authorTom Pantelis <tompantelis@gmail.com>
Fri, 27 Jul 2018 14:23:15 +0000 (10:23 -0400)
committerTom Pantelis <tompantelis@gmail.com>
Fri, 27 Jul 2018 14:31:23 +0000 (10:31 -0400)
Deprecated the high-level interfaces, eg DataBroker.

Change-Id: I754e3a5059c05d70616f3bd4ff3a00a05115fead
Signed-off-by: Tom Pantelis <tompantelis@gmail.com>
18 files changed:
opendaylight/md-sal/sal-binding-api/pom.xml
opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/DataBroker.java
opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/MountPointService.java
opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/NotificationPublishService.java
opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/NotificationService.java
opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/BindingAwareBroker.java
opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/BindingAwareConsumer.java
opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/BindingAwareProvider.java
opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/NotificationProviderService.java
opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/NotificationService.java
opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/RpcConsumerRegistry.java
opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/RpcProviderRegistry.java
opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataBroker.java
opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMMountPointService.java
opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMNotificationPublishService.java
opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMNotificationService.java
opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMRpcProviderService.java
opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMRpcService.java

index ddfba2b..5a3a3ee 100644 (file)
       <groupId>org.opendaylight.controller</groupId>
       <artifactId>sal-common-api</artifactId>
     </dependency>
+    <dependency>
+      <groupId>org.opendaylight.mdsal</groupId>
+      <artifactId>mdsal-binding-api</artifactId>
+    </dependency>
     <dependency>
       <groupId>org.opendaylight.yangtools</groupId>
       <artifactId>concepts</artifactId>
index 8c3e17e..bc5dd21 100644 (file)
@@ -22,7 +22,10 @@ import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  *
  * @see AsyncDataBroker
  * @see TransactionChainFactory
+ *
+ * @deprecated Use {@link org.opendaylight.mdsal.binding.api.DataBroker} instead
  */
+@Deprecated
 public interface DataBroker extends  AsyncDataBroker<InstanceIdentifier<?>, DataObject>,
         TransactionChainFactory<InstanceIdentifier<?>, DataObject>, TransactionFactory, BindingService,
         DataTreeChangeService {
index 43e2d85..dec4b8c 100644 (file)
@@ -12,6 +12,12 @@ import java.util.EventListener;
 import org.opendaylight.yangtools.concepts.ListenerRegistration;
 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 
+/**
+ * Deprecated.
+ *
+ * @deprecated Use {@link org.opendaylight.mdsal.binding.api.MountPointService} instead
+ */
+@Deprecated
 public interface MountPointService extends BindingService {
 
     Optional<MountPoint> getMountPoint(InstanceIdentifier<?> mountPoint);
index db36d30..7a8b09a 100644 (file)
@@ -27,7 +27,10 @@ import org.opendaylight.yangtools.yang.binding.Notification;
  * The actual delivery to listeners is asynchronous and implementation-specific.
  * Users of this interface should not make any assumptions as to whether the
  * notification has or has not been seen.
+ *
+ * @deprecated Use {@link org.opendaylight.mdsal.binding.api.NotificationPublishService} instead
  */
+@Deprecated
 public interface NotificationPublishService extends BindingService {
 
     /**
index 3744eee..8492296 100644 (file)
@@ -68,7 +68,10 @@ import org.opendaylight.yangtools.yang.binding.NotificationListener;
  * }
  * The <code>onStart</code> method will be invoked when someone publishes a <code>Start</code> notification and
  * the <code>onStop</code> method will be invoked when someone publishes a <code>Stop</code> notification.
+ *
+ * @deprecated Use {@link org.opendaylight.mdsal.binding.api.NotificationService} instead
  */
+@Deprecated
 public interface NotificationService extends BindingService {
     /**
      * Registers a listener which implements a YANG-generated notification interface derived from
index 81f8124..385754f 100644 (file)
@@ -52,9 +52,6 @@ import org.osgi.framework.BundleContext;
  * and {@link ProviderContext}
  */
 public interface BindingAwareBroker {
-    /*
-     * @deprecated Use registerConsumer(BindingAwareConsumer cons) instead (BundleContext is no longer used)
-     */
     @Deprecated
     ConsumerContext registerConsumer(BindingAwareConsumer consumer, BundleContext ctx);
 
@@ -79,6 +76,7 @@ public interface BindingAwareBroker {
      * @throws IllegalStateException
      *             If the consumer is already registered.
      */
+    @Deprecated
     ConsumerContext registerConsumer(BindingAwareConsumer consumer);
 
     /*
@@ -115,6 +113,7 @@ public interface BindingAwareBroker {
      * @throws IllegalStateException
      *             If the consumer is already registered.
      */
+    @Deprecated
     ProviderContext registerProvider(BindingAwareProvider provider);
 
     /**
@@ -130,6 +129,7 @@ public interface BindingAwareBroker {
      * infrastructure services and other functionality provided by
      * {@link BindingAwareProvider}s.
      */
+    @Deprecated
     interface ConsumerContext extends RpcConsumerRegistry {
 
         /**
@@ -158,6 +158,7 @@ public interface BindingAwareBroker {
      * functionality provided by other {@link BindingAwareConsumer}s.
      *
      */
+    @Deprecated
     interface ProviderContext extends ConsumerContext, RpcProviderRegistry {
 
     }
index 0f183a0..9d3efc2 100644 (file)
@@ -18,7 +18,7 @@ import org.opendaylight.yangtools.yang.binding.Notification;
  * modeled notifications. This interface is a combination of the {@link NotificationService} and
  * {@link NotificationPublishService} interfaces.
  *
- * @deprecated Please use {@link org.opendaylight.controller.md.sal.binding.api.NotificationPublishService}.
+ * @deprecated Please use {@link org.opendaylight.mdsal.binding.api.NotificationPublishService}.
  */
 @Deprecated
 public interface NotificationProviderService extends NotificationService, NotificationPublishService<Notification> {
index 8f3e147..d8678d3 100644 (file)
@@ -99,7 +99,7 @@ import org.opendaylight.yangtools.yang.binding.Notification;
  * The <code>onStart</code> method will be invoked when someone publishes a <code>Start</code> notification and
  * the <code>onStop</code> method will be invoked when someone publishes a <code>Stop</code> notification.
  *
- * @deprecated Please use {@link org.opendaylight.controller.md.sal.binding.api.NotificationService} instead.
+ * @deprecated Please use {@link org.opendaylight.mdsal.binding.api.NotificationService} instead.
  */
 @Deprecated
 public interface NotificationService extends BindingAwareService {
index 83be512..d6978d7 100644 (file)
@@ -17,7 +17,9 @@ import org.opendaylight.yangtools.yang.binding.RpcService;
  * <p>
  * RPC implementations are registered using the {@link RpcProviderRegistry}.
  *
+ * @deprecated Use {@link org.opendaylight.mdsal.binding.api.RpcConsumerRegistry} instead
  */
+@Deprecated
 public interface RpcConsumerRegistry extends BindingAwareService, BindingService {
     /**
      * Returns an implementation of a requested RPC service.
index 268906f..367e55d 100644 (file)
@@ -253,7 +253,10 @@ import org.opendaylight.yangtools.yang.binding.RpcService;
  * on failure rather than purposely throwing unchecked exceptions if at all possible.
  * While unchecked exceptions will fail the returned {@link java.util.concurrent.Future Future},
  * using the intended RpcResult to convey the error information is more user-friendly.
+ *
+ * @deprecated Use {@link org.opendaylight.mdsal.binding.api.RpcProviderService} instead
  */
+@Deprecated
 public interface RpcProviderRegistry extends //
         RpcConsumerRegistry, //
         RouteChangePublisher<RpcContextIdentifier, InstanceIdentifier<?>> {
index 9507ac5..2f123cd 100644 (file)
@@ -20,7 +20,10 @@ import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  * <p>
  * This interface is type capture of generic interfaces and returns type captures
  * of results for client-code convenience.
+ *
+ * @deprecated Use {@link org.opendaylight.mdsal.dom.api.DOMDataBroker} instead
  */
+@Deprecated
 public interface DOMDataBroker extends
         AsyncDataBroker<YangInstanceIdentifier, NormalizedNode<?, ?>>,
         TransactionChainFactory<YangInstanceIdentifier, NormalizedNode<?, ?>>,
index 0524481..0c72b86 100644 (file)
@@ -14,6 +14,12 @@ import org.opendaylight.yangtools.concepts.ObjectRegistration;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
 
+/**
+ * Deprecated.
+ *
+ * @deprecated Use {@link org.opendaylight.mdsal.dom.api.DOMMountPointService} instead
+ */
+@Deprecated
 public interface DOMMountPointService extends DOMService {
 
     Optional<DOMMountPoint> getMountPoint(YangInstanceIdentifier path);
index 0233446..852dc56 100644 (file)
@@ -22,7 +22,10 @@ import javax.annotation.Nonnull;
  * - an offer-style method, which attempts to enqueue the notification, but allows
  *   the caller to specify that it should never wait, or put an upper bound on how
  *   long it is going to wait.
+ *
+ * @deprecated Use {@link org.opendaylight.mdsal.dom.api.DOMNotificationPublishService} instead
  */
+@Deprecated
 public interface DOMNotificationPublishService extends DOMService {
     /**
      * Well-known value indicating that the implementation is currently not
index 3edde3c..37d3a01 100644 (file)
@@ -15,7 +15,10 @@ import org.opendaylight.yangtools.yang.model.api.SchemaPath;
 /**
  * A {@link DOMService} which allows its users to subscribe to receive
  * {@link DOMNotification}s.
+ *
+ * @deprecated Use {@link org.opendaylight.mdsal.dom.api.DOMNotificationService} instead
  */
+@Deprecated
 public interface DOMNotificationService extends DOMService {
     /**
      * Register a {@link DOMNotificationListener} to receive a set of notifications. As with
index 82de4b0..9454214 100644 (file)
@@ -28,7 +28,10 @@ import javax.annotation.Nonnull;
  *
  * <p>
  * All implementations are required to perform these steps as specified above.
+ *
+ * @deprecated Use {@link org.opendaylight.mdsal.dom.api.DOMRpcProviderService} instead
  */
+@Deprecated
 public interface DOMRpcProviderService extends DOMService {
     /**
      * Register an {@link DOMRpcImplementation} object with this service.
index c84e2d3..e8826de 100644 (file)
@@ -19,7 +19,10 @@ import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  * service is that of a dynamic router, where the set of available RPC services can change
  * dynamically. The service allows users to add a listener to track the process of
  * RPCs becoming available.
+ *
+ * @deprecated Use {@link org.opendaylight.mdsal.dom.api.DOMRpcService} instead
  */
+@Deprecated
 public interface DOMRpcService extends DOMService {
     /**
      * Initiate invocation of an RPC. This method is guaranteed to not block on any external

©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.