HONEYCOMB-381 - Usage of ShutdownHandler for jvpp components

and notification producer

Change-Id: I70e749de5b290c84e86a28625d5ec79c98de80f2
Signed-off-by: Jan Srnicek <jsrnicek@cisco.com>

4 files changed, 73 insertions, 13 deletions

diff --git a/v3po/v3po2vpp/src/main/java/io/fd/hc2vpp/v3po/V3poModule.java b/v3po/v3po2vpp/src/main/java/io/fd/hc2vpp/v3po/V3poModule.java
index 1a0430049..fb8911088 100644
--- a/v3po/v3po2vpp/src/main/java/io/fd/hc2vpp/v3po/V3poModule.java
+++ b/v3po/v3po2vpp/src/main/java/io/fd/hc2vpp/v3po/V3poModule.java
@@ -26,7 +26,7 @@ import io.fd.hc2vpp.v3po.factory.L2HoneycombWriterFactory;
 import io.fd.hc2vpp.v3po.factory.L2StateHoneycombReaderFactory;
 import io.fd.hc2vpp.v3po.factory.SubinterfaceAugmentationWriterFactory;
 import io.fd.hc2vpp.v3po.factory.SubinterfaceStateAugmentationReaderFactory;
-import io.fd.hc2vpp.v3po.notification.InterfaceChangeNotificationProducer;
+import io.fd.hc2vpp.v3po.notification.InterfaceChangeNotificationProducerProvider;
 import io.fd.honeycomb.notification.ManagedNotificationProducer;
 import io.fd.honeycomb.translate.read.ReaderFactory;
 import io.fd.honeycomb.translate.write.WriterFactory;
@@ -71,7 +71,7 @@ public class V3poModule extends AbstractModule {
         // Notifications
         final Multibinder<ManagedNotificationProducer> notifiersBinder =
                 Multibinder.newSetBinder(binder(), ManagedNotificationProducer.class);
-        notifiersBinder.addBinding().to(InterfaceChangeNotificationProducer.class);
+        notifiersBinder.addBinding().toProvider(InterfaceChangeNotificationProducerProvider.class);
 
         LOG.info("Module V3PO successfully configured");
     }
diff --git a/v3po/v3po2vpp/src/main/java/io/fd/hc2vpp/v3po/notification/InterfaceChangeNotificationProducer.java b/v3po/v3po2vpp/src/main/java/io/fd/hc2vpp/v3po/notification/InterfaceChangeNotificationProducer.java
index 8ad7debb5..e971db2ee 100644
--- a/v3po/v3po2vpp/src/main/java/io/fd/hc2vpp/v3po/notification/InterfaceChangeNotificationProducer.java
+++ b/v3po/v3po2vpp/src/main/java/io/fd/hc2vpp/v3po/notification/InterfaceChangeNotificationProducer.java
@@ -19,7 +19,6 @@ package io.fd.hc2vpp.v3po.notification;
 import com.google.common.base.Optional;
 import com.google.common.collect.Lists;
 import com.google.inject.Inject;
-import com.google.inject.name.Named;
 import io.fd.hc2vpp.common.translate.util.JvppReplyConsumer;
 import io.fd.hc2vpp.common.translate.util.NamingContext;
 import io.fd.honeycomb.notification.ManagedNotificationProducer;
@@ -48,11 +47,11 @@ import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 /**
- * Notification producer for interface events. It starts interface notification stream and for every
- * received notification, it transforms it into its BA equivalent and pushes into HC's notification collector.
+ * Notification producer for interface events. It starts interface notification stream and for every received
+ * notification, it transforms it into its BA equivalent and pushes into HC's notification collector.
  */
 @NotThreadSafe
-public final class InterfaceChangeNotificationProducer implements ManagedNotificationProducer, JvppReplyConsumer {
+final class InterfaceChangeNotificationProducer implements ManagedNotificationProducer, JvppReplyConsumer {
 
     private static final Logger LOG = LoggerFactory.getLogger(InterfaceChangeNotificationProducer.class);
 
@@ -63,16 +62,16 @@ public final class InterfaceChangeNotificationProducer implements ManagedNotific
     private AutoCloseable notificationListenerReg;
 
     @Inject
-    public InterfaceChangeNotificationProducer(@Nonnull final FutureJVppCore jvpp,
-                                               @Named("interface-context") @Nonnull final NamingContext interfaceContext,
-                                               @Named("honeycomb-context") @Nonnull final MappingContext mappingContext) {
+    InterfaceChangeNotificationProducer(@Nonnull final FutureJVppCore jvpp,
+                                        @Nonnull final NamingContext interfaceContext,
+                                        @Nonnull final MappingContext mappingContext) {
         this.jvpp = jvpp;
         this.interfaceContext = interfaceContext;
         this.mappingContext = mappingContext;
     }
 
     @Override
-    public void start(final NotificationCollector collector) {
+    public void start(@Nonnull final NotificationCollector collector) {
         LOG.trace("Starting interface notifications");
         enableDisableIfcNotifications(1);
         LOG.debug("Interface notifications started successfully");
@@ -102,9 +101,9 @@ public final class InterfaceChangeNotificationProducer implements ManagedNotific
     }
 
     /**
-     * Get mapped name for the interface. Best effort only! The mapping might not yet be stored in context
-     * data tree (write transaction is still in progress and context changes have not been committed yet, or
-     * VPP sends the notification before it returns create request(that would store mapping)).
+     * Get mapped name for the interface. Best effort only! The mapping might not yet be stored in context data tree
+     * (write transaction is still in progress and context changes have not been committed yet, or VPP sends the
+     * notification before it returns create request(that would store mapping)).
      * <p/>
      * In case mapping is not available, index is used as name.
      */
diff --git a/v3po/v3po2vpp/src/main/java/io/fd/hc2vpp/v3po/notification/InterfaceChangeNotificationProducerProvider.java b/v3po/v3po2vpp/src/main/java/io/fd/hc2vpp/v3po/notification/InterfaceChangeNotificationProducerProvider.java
new file mode 100644
index 000000000..9f3988cbf
--- /dev/null
+++ b/v3po/v3po2vpp/src/main/java/io/fd/hc2vpp/v3po/notification/InterfaceChangeNotificationProducerProvider.java
@@ -0,0 +1,56 @@
+/*
+ * Copyright (c) 2017 Cisco and/or its affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.fd.hc2vpp.v3po.notification;
+
+import com.google.inject.Inject;
+import com.google.inject.Provider;
+import com.google.inject.name.Named;
+import io.fd.hc2vpp.common.translate.util.NamingContext;
+import io.fd.honeycomb.data.init.ShutdownHandler;
+import io.fd.honeycomb.translate.MappingContext;
+import io.fd.vpp.jvpp.core.future.FutureJVppCore;
+import javax.annotation.Nonnull;
+
+public class InterfaceChangeNotificationProducerProvider implements Provider<InterfaceChangeNotificationProducer> {
+
+    @Inject
+    @Nonnull
+    private FutureJVppCore jvpp;
+
+    @Inject
+    @Named("interface-context")
+    @Nonnull
+    private NamingContext interfaceContext;
+
+    @Inject
+    @Named("honeycomb-context")
+    @Nonnull
+    private MappingContext mappingContext;
+
+    @Inject
+    @Nonnull
+    private ShutdownHandler shutdownHandler;
+
+    @Override
+    public InterfaceChangeNotificationProducer get() {
+        final InterfaceChangeNotificationProducer notificationProducer =
+                new InterfaceChangeNotificationProducer(jvpp, interfaceContext, mappingContext);
+        shutdownHandler.register("interface-change-notification-producer-" + notificationProducer.hashCode(),
+                notificationProducer);
+        return notificationProducer;
+    }
+}
diff --git a/v3po/v3po2vpp/src/test/java/io/fd/hc2vpp/v3po/V3poModuleTest.java b/v3po/v3po2vpp/src/test/java/io/fd/hc2vpp/v3po/V3poModuleTest.java
index b7f19867e..414658ec6 100644
--- a/v3po/v3po2vpp/src/test/java/io/fd/hc2vpp/v3po/V3poModuleTest.java
+++ b/v3po/v3po2vpp/src/test/java/io/fd/hc2vpp/v3po/V3poModuleTest.java
@@ -28,6 +28,7 @@ import com.google.inject.Inject;
 import com.google.inject.name.Named;
 import com.google.inject.testing.fieldbinder.Bind;
 import com.google.inject.testing.fieldbinder.BoundFieldModule;
+import io.fd.honeycomb.data.init.ShutdownHandler;
 import io.fd.honeycomb.translate.MappingContext;
 import io.fd.honeycomb.translate.impl.read.registry.CompositeReaderRegistryBuilder;
 import io.fd.honeycomb.translate.impl.write.registry.FlatWriterRegistryBuilder;
@@ -63,6 +64,10 @@ public class V3poModuleTest {
     @Mock
     private FutureJVppCore futureJVppCore;
 
+    @Mock
+    @Bind
+    private ShutdownHandler shutdownHandler;
+
     @Inject
     private Set<ReaderFactory> readerFactories = new HashSet<>();