From 0c7dc9f66429d8141392a2c4c726944e41cb4a53 Mon Sep 17 00:00:00 2001
From: Robert Varga <robert.varga@pantheon.tech>
Date: Fri, 19 Feb 2021 07:43:50 +0100
Subject: [PATCH] Deprecate messagebus for removal

This component is going away, deprecate it.

JIRA: CONTROLLER-1973
Change-Id: I993cf6311c30b37bc64c9d7dbd244d54c26c8da5
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>
---
 .../messagebus/app/impl/EventSourceRegistrationImpl.java      | 3 ++-
 .../controller/messagebus/app/impl/EventSourceTopic.java      | 4 +++-
 .../controller/messagebus/app/impl/EventSourceTopology.java   | 3 ++-
 .../messagebus/app/impl/OSGiEventSourceRegistry.java          | 1 +
 .../messagebus/app/impl/EventSourceRegistrationImplTest.java  | 3 ++-
 .../controller/messagebus/app/impl/EventSourceTopicTest.java  | 1 +
 .../messagebus/app/impl/EventSourceTopologyTest.java          | 1 +
 .../opendaylight/controller/messagebus/spi/EventSource.java   | 3 +--
 .../controller/messagebus/spi/EventSourceRegistration.java    | 3 +--
 .../controller/messagebus/spi/EventSourceRegistry.java        | 1 +
 opendaylight/md-sal/messagebus-util/pom.xml                   | 1 -
 .../controller/messagebus/app/util/TopicDOMNotification.java  | 1 +
 .../org/opendaylight/controller/messagebus/app/util/Util.java | 1 +
 .../messagebus/app/util/TopicDOMNotificationTest.java         | 1 +
 .../opendaylight/controller/messagebus/app/util/UtilTest.java | 1 +
 15 files changed, 19 insertions(+), 9 deletions(-)

diff --git a/opendaylight/md-sal/messagebus-impl/src/main/java/org/opendaylight/controller/messagebus/app/impl/EventSourceRegistrationImpl.java b/opendaylight/md-sal/messagebus-impl/src/main/java/org/opendaylight/controller/messagebus/app/impl/EventSourceRegistrationImpl.java
index 89b8a9c313..1779ad85f8 100644
--- a/opendaylight/md-sal/messagebus-impl/src/main/java/org/opendaylight/controller/messagebus/app/impl/EventSourceRegistrationImpl.java
+++ b/opendaylight/md-sal/messagebus-impl/src/main/java/org/opendaylight/controller/messagebus/app/impl/EventSourceRegistrationImpl.java
@@ -13,6 +13,7 @@ import org.opendaylight.controller.messagebus.spi.EventSource;
 import org.opendaylight.controller.messagebus.spi.EventSourceRegistration;
 import org.opendaylight.yangtools.concepts.AbstractObjectRegistration;
 
+@Deprecated(forRemoval = true)
 class EventSourceRegistrationImpl<T extends EventSource> extends AbstractObjectRegistration<T>
         implements EventSourceRegistration<T> {
 
@@ -24,7 +25,7 @@ class EventSourceRegistrationImpl<T extends EventSource> extends AbstractObjectR
      * @param instance of EventSource that has been registered by
      *     {@link EventSourceRegistryImpl#registerEventSource(Node, EventSource)}
      */
-    EventSourceRegistrationImpl(T instance, EventSourceTopology eventSourceTopology) {
+    EventSourceRegistrationImpl(final T instance, final EventSourceTopology eventSourceTopology) {
         super(instance);
         this.eventSourceTopology = requireNonNull(eventSourceTopology);
     }
diff --git a/opendaylight/md-sal/messagebus-impl/src/main/java/org/opendaylight/controller/messagebus/app/impl/EventSourceTopic.java b/opendaylight/md-sal/messagebus-impl/src/main/java/org/opendaylight/controller/messagebus/app/impl/EventSourceTopic.java
index 2deb3570f6..af2099c08d 100644
--- a/opendaylight/md-sal/messagebus-impl/src/main/java/org/opendaylight/controller/messagebus/app/impl/EventSourceTopic.java
+++ b/opendaylight/md-sal/messagebus-impl/src/main/java/org/opendaylight/controller/messagebus/app/impl/EventSourceTopic.java
@@ -42,14 +42,16 @@ import org.opendaylight.yangtools.yang.common.RpcError;
 import org.opendaylight.yangtools.yang.common.RpcResult;
 import org.slf4j.LoggerFactory;
 
+@Deprecated(forRemoval = true)
 public final class EventSourceTopic implements DataTreeChangeListener<Node>, AutoCloseable {
     private static final org.slf4j.Logger LOG = LoggerFactory.getLogger(EventSourceTopic.class);
+
+    private final CopyOnWriteArraySet<InstanceIdentifier<?>> joinedEventSources = new CopyOnWriteArraySet<>();
     private final NotificationPattern notificationPattern;
     private final EventSourceService sourceService;
     private final Pattern nodeIdPattern;
     private final TopicId topicId;
     private ListenerRegistration<?> listenerRegistration;
-    private final CopyOnWriteArraySet<InstanceIdentifier<?>> joinedEventSources = new CopyOnWriteArraySet<>();
 
     public static EventSourceTopic create(final NotificationPattern notificationPattern,
             final String nodeIdRegexPattern, final EventSourceTopology eventSourceTopology) {
diff --git a/opendaylight/md-sal/messagebus-impl/src/main/java/org/opendaylight/controller/messagebus/app/impl/EventSourceTopology.java b/opendaylight/md-sal/messagebus-impl/src/main/java/org/opendaylight/controller/messagebus/app/impl/EventSourceTopology.java
index 7f53a53ac6..b22eee233e 100644
--- a/opendaylight/md-sal/messagebus-impl/src/main/java/org/opendaylight/controller/messagebus/app/impl/EventSourceTopology.java
+++ b/opendaylight/md-sal/messagebus-impl/src/main/java/org/opendaylight/controller/messagebus/app/impl/EventSourceTopology.java
@@ -57,6 +57,7 @@ import org.opendaylight.yangtools.yang.common.RpcResult;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+@Deprecated(forRemoval = true)
 public class EventSourceTopology implements EventAggregatorService, EventSourceRegistry {
     private static final Logger LOG = LoggerFactory.getLogger(EventSourceTopology.class);
 
@@ -79,7 +80,7 @@ public class EventSourceTopology implements EventAggregatorService, EventSourceR
     private final RpcProviderService rpcRegistry;
 
     public EventSourceTopology(final DataBroker dataBroker, final RpcProviderService providerService,
-            RpcConsumerRegistry rpcService) {
+            final RpcConsumerRegistry rpcService) {
 
         this.dataBroker = dataBroker;
         this.rpcRegistry = providerService;
diff --git a/opendaylight/md-sal/messagebus-impl/src/main/java/org/opendaylight/controller/messagebus/app/impl/OSGiEventSourceRegistry.java b/opendaylight/md-sal/messagebus-impl/src/main/java/org/opendaylight/controller/messagebus/app/impl/OSGiEventSourceRegistry.java
index 29389ab9ac..07e66d247e 100644
--- a/opendaylight/md-sal/messagebus-impl/src/main/java/org/opendaylight/controller/messagebus/app/impl/OSGiEventSourceRegistry.java
+++ b/opendaylight/md-sal/messagebus-impl/src/main/java/org/opendaylight/controller/messagebus/app/impl/OSGiEventSourceRegistry.java
@@ -23,6 +23,7 @@ import org.slf4j.LoggerFactory;
 
 @Beta
 @Component(immediate = true)
+@Deprecated(forRemoval = true)
 public final class OSGiEventSourceRegistry implements EventSourceRegistry {
     private static final Logger LOG = LoggerFactory.getLogger(OSGiEventSourceRegistry.class);
 
diff --git a/opendaylight/md-sal/messagebus-impl/src/test/java/org/opendaylight/controller/messagebus/app/impl/EventSourceRegistrationImplTest.java b/opendaylight/md-sal/messagebus-impl/src/test/java/org/opendaylight/controller/messagebus/app/impl/EventSourceRegistrationImplTest.java
index 838d1746ee..82ef60db69 100644
--- a/opendaylight/md-sal/messagebus-impl/src/test/java/org/opendaylight/controller/messagebus/app/impl/EventSourceRegistrationImplTest.java
+++ b/opendaylight/md-sal/messagebus-impl/src/test/java/org/opendaylight/controller/messagebus/app/impl/EventSourceRegistrationImplTest.java
@@ -17,6 +17,7 @@ import org.junit.BeforeClass;
 import org.junit.Test;
 import org.opendaylight.controller.messagebus.spi.EventSource;
 
+@Deprecated(forRemoval = true)
 public class EventSourceRegistrationImplTest {
 
     EventSourceRegistrationImplLocal eventSourceRegistrationImplLocal;
@@ -42,7 +43,7 @@ public class EventSourceRegistrationImplTest {
 
 
     private class EventSourceRegistrationImplLocal extends EventSourceRegistrationImpl<EventSource> {
-        EventSourceRegistrationImplLocal(EventSource instance, EventSourceTopology eventSourceTopology) {
+        EventSourceRegistrationImplLocal(final EventSource instance, final EventSourceTopology eventSourceTopology) {
             super(instance, eventSourceTopology);
         }
     }
diff --git a/opendaylight/md-sal/messagebus-impl/src/test/java/org/opendaylight/controller/messagebus/app/impl/EventSourceTopicTest.java b/opendaylight/md-sal/messagebus-impl/src/test/java/org/opendaylight/controller/messagebus/app/impl/EventSourceTopicTest.java
index d785287f57..6059d9ab4f 100644
--- a/opendaylight/md-sal/messagebus-impl/src/test/java/org/opendaylight/controller/messagebus/app/impl/EventSourceTopicTest.java
+++ b/opendaylight/md-sal/messagebus-impl/src/test/java/org/opendaylight/controller/messagebus/app/impl/EventSourceTopicTest.java
@@ -39,6 +39,7 @@ import org.opendaylight.yangtools.yang.binding.DataObject;
 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
 
+@Deprecated(forRemoval = true)
 public class EventSourceTopicTest {
 
     EventSourceTopic eventSourceTopic;
diff --git a/opendaylight/md-sal/messagebus-impl/src/test/java/org/opendaylight/controller/messagebus/app/impl/EventSourceTopologyTest.java b/opendaylight/md-sal/messagebus-impl/src/test/java/org/opendaylight/controller/messagebus/app/impl/EventSourceTopologyTest.java
index 868dd9d740..2022869ad9 100644
--- a/opendaylight/md-sal/messagebus-impl/src/test/java/org/opendaylight/controller/messagebus/app/impl/EventSourceTopologyTest.java
+++ b/opendaylight/md-sal/messagebus-impl/src/test/java/org/opendaylight/controller/messagebus/app/impl/EventSourceTopologyTest.java
@@ -49,6 +49,7 @@ import org.opendaylight.yangtools.concepts.Registration;
 import org.opendaylight.yangtools.yang.binding.DataObject;
 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 
+@Deprecated(forRemoval = true)
 public class EventSourceTopologyTest {
 
     EventSourceTopology eventSourceTopology;
diff --git a/opendaylight/md-sal/messagebus-spi/src/main/java/org/opendaylight/controller/messagebus/spi/EventSource.java b/opendaylight/md-sal/messagebus-spi/src/main/java/org/opendaylight/controller/messagebus/spi/EventSource.java
index 3221e1338d..6d57b4d95a 100644
--- a/opendaylight/md-sal/messagebus-spi/src/main/java/org/opendaylight/controller/messagebus/spi/EventSource.java
+++ b/opendaylight/md-sal/messagebus-spi/src/main/java/org/opendaylight/controller/messagebus/spi/EventSource.java
@@ -20,9 +20,8 @@ import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  * EventSourceRegistry will call method JoinTopic to request EventSource to publish notification.
  * Event source must implement method JoinTopic (from superinterface {@link EventSourceService}).
  */
-
+@Deprecated(forRemoval = true)
 public interface EventSource extends EventSourceService, AutoCloseable {
-
     /**
      * Identifier of node associated with event source.
      *
diff --git a/opendaylight/md-sal/messagebus-spi/src/main/java/org/opendaylight/controller/messagebus/spi/EventSourceRegistration.java b/opendaylight/md-sal/messagebus-spi/src/main/java/org/opendaylight/controller/messagebus/spi/EventSourceRegistration.java
index dd6cc1a166..d885461b48 100644
--- a/opendaylight/md-sal/messagebus-spi/src/main/java/org/opendaylight/controller/messagebus/spi/EventSourceRegistration.java
+++ b/opendaylight/md-sal/messagebus-spi/src/main/java/org/opendaylight/controller/messagebus/spi/EventSourceRegistration.java
@@ -12,10 +12,9 @@ import org.opendaylight.yangtools.concepts.ObjectRegistration;
 /**
  * Instance of EventSourceRegistration is returned by {@link EventSourceRegistry#registerEventSource(EventSource)}
  * and it is used to unregister EventSource.
- *
  */
+@Deprecated(forRemoval = true)
 public interface EventSourceRegistration<T extends EventSource> extends ObjectRegistration<T> {
-
     @Override
     void close();
 }
diff --git a/opendaylight/md-sal/messagebus-spi/src/main/java/org/opendaylight/controller/messagebus/spi/EventSourceRegistry.java b/opendaylight/md-sal/messagebus-spi/src/main/java/org/opendaylight/controller/messagebus/spi/EventSourceRegistry.java
index bb9761d1ae..1d1980fc36 100644
--- a/opendaylight/md-sal/messagebus-spi/src/main/java/org/opendaylight/controller/messagebus/spi/EventSourceRegistry.java
+++ b/opendaylight/md-sal/messagebus-spi/src/main/java/org/opendaylight/controller/messagebus/spi/EventSourceRegistry.java
@@ -10,6 +10,7 @@ package org.opendaylight.controller.messagebus.spi;
 /**
  * EventSourceRegistry is used to register {@link EventSource}.
  */
+@Deprecated(forRemoval = true)
 public interface EventSourceRegistry extends AutoCloseable {
 
     /**
diff --git a/opendaylight/md-sal/messagebus-util/pom.xml b/opendaylight/md-sal/messagebus-util/pom.xml
index e5d617fd43..75ba7d0e5d 100644
--- a/opendaylight/md-sal/messagebus-util/pom.xml
+++ b/opendaylight/md-sal/messagebus-util/pom.xml
@@ -39,7 +39,6 @@ and is available at http://www.eclipse.org/legal/epl-v10.html
         <dependency>
               <groupId>org.glassfish.jersey.test-framework.providers</groupId>
               <artifactId>jersey-test-framework-provider-grizzly2</artifactId>
-              <version>2.4</version>
               <scope>test</scope>
         </dependency>
     </dependencies>
diff --git a/opendaylight/md-sal/messagebus-util/src/main/java/org/opendaylight/controller/messagebus/app/util/TopicDOMNotification.java b/opendaylight/md-sal/messagebus-util/src/main/java/org/opendaylight/controller/messagebus/app/util/TopicDOMNotification.java
index 348abad35f..7afb381eca 100644
--- a/opendaylight/md-sal/messagebus-util/src/main/java/org/opendaylight/controller/messagebus/app/util/TopicDOMNotification.java
+++ b/opendaylight/md-sal/messagebus-util/src/main/java/org/opendaylight/controller/messagebus/app/util/TopicDOMNotification.java
@@ -13,6 +13,7 @@ import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.messagebus.even
 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
 
+@Deprecated(forRemoval = true)
 public class TopicDOMNotification implements DOMNotification {
     private static final @NonNull Absolute TOPIC_NOTIFICATION_ID = Absolute.of(TopicNotification.QNAME);
 
diff --git a/opendaylight/md-sal/messagebus-util/src/main/java/org/opendaylight/controller/messagebus/app/util/Util.java b/opendaylight/md-sal/messagebus-util/src/main/java/org/opendaylight/controller/messagebus/app/util/Util.java
index 0b28e55886..8546f9a929 100644
--- a/opendaylight/md-sal/messagebus-util/src/main/java/org/opendaylight/controller/messagebus/app/util/Util.java
+++ b/opendaylight/md-sal/messagebus-util/src/main/java/org/opendaylight/controller/messagebus/app/util/Util.java
@@ -17,6 +17,7 @@ import org.opendaylight.yangtools.yang.common.RpcResult;
 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
 
+@Deprecated(forRemoval = true)
 public final class Util {
     private Util() {
     }
diff --git a/opendaylight/md-sal/messagebus-util/src/test/java/org/opendaylight/controller/messagebus/app/util/TopicDOMNotificationTest.java b/opendaylight/md-sal/messagebus-util/src/test/java/org/opendaylight/controller/messagebus/app/util/TopicDOMNotificationTest.java
index be11b1014a..fec1f5eb1d 100644
--- a/opendaylight/md-sal/messagebus-util/src/test/java/org/opendaylight/controller/messagebus/app/util/TopicDOMNotificationTest.java
+++ b/opendaylight/md-sal/messagebus-util/src/test/java/org/opendaylight/controller/messagebus/app/util/TopicDOMNotificationTest.java
@@ -19,6 +19,7 @@ import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.messagebus.even
 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
 
+@Deprecated(forRemoval = true)
 public class TopicDOMNotificationTest {
 
     private static final String CONTAINER_NODE_BODY_MOCK_TO_STRING = "containerNodeBodyMock";
diff --git a/opendaylight/md-sal/messagebus-util/src/test/java/org/opendaylight/controller/messagebus/app/util/UtilTest.java b/opendaylight/md-sal/messagebus-util/src/test/java/org/opendaylight/controller/messagebus/app/util/UtilTest.java
index 1a2d66c7c8..49a994c431 100644
--- a/opendaylight/md-sal/messagebus-util/src/test/java/org/opendaylight/controller/messagebus/app/util/UtilTest.java
+++ b/opendaylight/md-sal/messagebus-util/src/test/java/org/opendaylight/controller/messagebus/app/util/UtilTest.java
@@ -24,6 +24,7 @@ import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  *
  * @author ppalmar
  */
+@Deprecated(forRemoval = true)
 public class UtilTest {
 
     @Test
-- 
2.36.6