diff options
author | Jan Srnicek <jsrnicek@cisco.com> | 2017-08-11 14:05:30 +0200 |
---|---|---|
committer | Marek Gradzki <mgradzki@cisco.com> | 2017-08-14 08:20:18 +0000 |
commit | 2a39a0f17d82ecf7c75840d53960c42c6ea2c6ac (patch) | |
tree | be89dcd0d219dc2ff9c928c77a4fc218458e071f | |
parent | 72493bf45a8823dbb2bc8e0745ebb7106a7ae01f (diff) |
HONEYCOMB-381 - Usage of ShutdownHandler for jvpp components
and notification producer
Change-Id: I70e749de5b290c84e86a28625d5ec79c98de80f2
Signed-off-by: Jan Srnicek <jsrnicek@cisco.com>
16 files changed, 155 insertions, 104 deletions
diff --git a/acl/acl-impl/pom.xml b/acl/acl-impl/pom.xml index e7fad9e0a..638ea54c2 100644 --- a/acl/acl-impl/pom.xml +++ b/acl/acl-impl/pom.xml @@ -35,6 +35,12 @@ <dependencies> <dependency> + <groupId>io.fd.honeycomb</groupId> + <artifactId>cfg-init</artifactId> + <version>${project.version}</version> + </dependency> + + <dependency> <groupId>io.fd.hc2vpp.acl</groupId> <artifactId>acl-api</artifactId> <version>${project.version}</version> diff --git a/acl/acl-impl/src/main/java/io/fd/hc2vpp/acl/JVppAclProvider.java b/acl/acl-impl/src/main/java/io/fd/hc2vpp/acl/JVppAclProvider.java index be8c48894..96e26a4e3 100644 --- a/acl/acl-impl/src/main/java/io/fd/hc2vpp/acl/JVppAclProvider.java +++ b/acl/acl-impl/src/main/java/io/fd/hc2vpp/acl/JVppAclProvider.java @@ -19,6 +19,7 @@ package io.fd.hc2vpp.acl; import com.google.inject.Inject; import io.fd.hc2vpp.common.translate.util.JvppReplyConsumer; import io.fd.honeycomb.binding.init.ProviderTrait; +import io.fd.honeycomb.data.init.ShutdownHandler; import io.fd.vpp.jvpp.JVppRegistry; import io.fd.vpp.jvpp.VppBaseCallException; import io.fd.vpp.jvpp.acl.JVppAclImpl; @@ -37,24 +38,20 @@ class JVppAclProvider extends ProviderTrait<FutureJVppAclFacade> implements Jvpp @Inject private JVppRegistry registry; - private static JVppAclImpl initAclApi() { + @Inject + private ShutdownHandler shutdownHandler; + + private static JVppAclImpl initAclApi(final ShutdownHandler shutdownHandler) { final JVppAclImpl jvppAcl = new JVppAclImpl(); // Free jvpp-acl plugin's resources on shutdown - Runtime.getRuntime().addShutdownHook(new Thread() { - @Override - public void run() { - LOG.info("Unloading jvpp-acl plugin"); - jvppAcl.close(); - LOG.info("Successfully unloaded jvpp-acl plugin"); - } - }); + shutdownHandler.register("jvpp-acl", jvppAcl); return jvppAcl; } @Override protected FutureJVppAclFacade create() { try { - return reportVersionAndGet(initAclApi()); + return reportVersionAndGet(initAclApi(shutdownHandler)); } catch (IOException e) { throw new IllegalStateException("Unable to open VPP management connection", e); } catch (TimeoutException | VppBaseCallException e) { diff --git a/ioam/impl/src/main/java/io/fd/hc2vpp/vppioam/impl/util/JVppIoamExportProvider.java b/ioam/impl/src/main/java/io/fd/hc2vpp/vppioam/impl/util/JVppIoamExportProvider.java index 0ffc8dd94..a90bafee2 100644 --- a/ioam/impl/src/main/java/io/fd/hc2vpp/vppioam/impl/util/JVppIoamExportProvider.java +++ b/ioam/impl/src/main/java/io/fd/hc2vpp/vppioam/impl/util/JVppIoamExportProvider.java @@ -18,6 +18,7 @@ package io.fd.hc2vpp.vppioam.impl.util; import com.google.inject.Inject; import io.fd.honeycomb.binding.init.ProviderTrait; +import io.fd.honeycomb.data.init.ShutdownHandler; import io.fd.vpp.jvpp.JVppRegistry; import io.fd.vpp.jvpp.ioamexport.JVppIoamexportImpl; import io.fd.vpp.jvpp.ioamexport.future.FutureJVppIoamexportFacade; @@ -32,19 +33,15 @@ public class JVppIoamExportProvider extends ProviderTrait<FutureJVppIoamexportFa @Inject private JVppRegistry registry; + @Inject + private ShutdownHandler shutdownHandler; + @Override protected FutureJVppIoamexportFacade create() { try { final JVppIoamexportImpl jVppIoamexport = new JVppIoamexportImpl(); // Free jvpp-ioam-export plugin's resources on shutdown - Runtime.getRuntime().addShutdownHook(new Thread() { - @Override - public void run() { - LOG.info("Unloading jvpp-ioam-export plugin"); - jVppIoamexport.close(); - LOG.info("Successfully unloaded jvpp-ioam-export plugin"); - } - }); + shutdownHandler.register("jvpp-ioamexport", jVppIoamexport); LOG.info("Successfully loaded jvpp-ioam-export plugin"); return new FutureJVppIoamexportFacade(registry, jVppIoamexport); diff --git a/ioam/impl/src/main/java/io/fd/hc2vpp/vppioam/impl/util/JVppIoamPotProvider.java b/ioam/impl/src/main/java/io/fd/hc2vpp/vppioam/impl/util/JVppIoamPotProvider.java index a8ae2dc70..03db9f01a 100644 --- a/ioam/impl/src/main/java/io/fd/hc2vpp/vppioam/impl/util/JVppIoamPotProvider.java +++ b/ioam/impl/src/main/java/io/fd/hc2vpp/vppioam/impl/util/JVppIoamPotProvider.java @@ -18,17 +18,17 @@ package io.fd.hc2vpp.vppioam.impl.util; import com.google.inject.Inject; import io.fd.honeycomb.binding.init.ProviderTrait; +import io.fd.honeycomb.data.init.ShutdownHandler; import io.fd.vpp.jvpp.JVppRegistry; import io.fd.vpp.jvpp.ioampot.JVppIoampotImpl; import io.fd.vpp.jvpp.ioampot.future.FutureJVppIoampotFacade; +import java.io.IOException; import org.slf4j.Logger; import org.slf4j.LoggerFactory; -import java.io.IOException; - /** - * Provides future API for jvpp-ioam plugin. Must be a singleton due to shutdown hook usage. - * Registers shutdown hook to free plugin's resources on shutdown. + * Provides future API for jvpp-ioam plugin. Must be a singleton due to shutdown hook usage. Registers shutdown hook to + * free plugin's resources on shutdown. */ public final class JVppIoamPotProvider extends ProviderTrait<FutureJVppIoampotFacade> { @@ -37,19 +37,15 @@ public final class JVppIoamPotProvider extends ProviderTrait<FutureJVppIoampotFa @Inject private JVppRegistry registry; + @Inject + private ShutdownHandler shutdownHandler; + @Override protected FutureJVppIoampotFacade create() { try { final JVppIoampotImpl jVppIoamPot = new JVppIoampotImpl(); // Free jvpp-ioam plugin's resources on shutdown - Runtime.getRuntime().addShutdownHook(new Thread() { - @Override - public void run() { - LOG.info("Unloading jvpp-ioam-pot plugin"); - jVppIoamPot.close(); - LOG.info("Successfully unloaded jvpp-ioam-pot plugin"); - } - }); + shutdownHandler.register("jvpp-ioampot", jVppIoamPot); LOG.info("Successfully loaded jvpp-ioam-pot plugin"); return new FutureJVppIoampotFacade(registry, jVppIoamPot); diff --git a/ioam/impl/src/main/java/io/fd/hc2vpp/vppioam/impl/util/JVppIoamTraceProvider.java b/ioam/impl/src/main/java/io/fd/hc2vpp/vppioam/impl/util/JVppIoamTraceProvider.java index caf098e2d..f7e15fb68 100755 --- a/ioam/impl/src/main/java/io/fd/hc2vpp/vppioam/impl/util/JVppIoamTraceProvider.java +++ b/ioam/impl/src/main/java/io/fd/hc2vpp/vppioam/impl/util/JVppIoamTraceProvider.java @@ -18,17 +18,17 @@ package io.fd.hc2vpp.vppioam.impl.util; import com.google.inject.Inject; import io.fd.honeycomb.binding.init.ProviderTrait; +import io.fd.honeycomb.data.init.ShutdownHandler; import io.fd.vpp.jvpp.JVppRegistry; import io.fd.vpp.jvpp.ioamtrace.JVppIoamtraceImpl; import io.fd.vpp.jvpp.ioamtrace.future.FutureJVppIoamtraceFacade; +import java.io.IOException; import org.slf4j.Logger; import org.slf4j.LoggerFactory; -import java.io.IOException; - /** - * Provides future API for jvpp-ioam plugin. Must be a singleton due to shutdown hook usage. - * Registers shutdown hook to free plugin's resources on shutdown. + * Provides future API for jvpp-ioam plugin. Must be a singleton due to shutdown hook usage. Registers shutdown hook to + * free plugin's resources on shutdown. */ public final class JVppIoamTraceProvider extends ProviderTrait<FutureJVppIoamtraceFacade> { @@ -37,19 +37,15 @@ public final class JVppIoamTraceProvider extends ProviderTrait<FutureJVppIoamtra @Inject private JVppRegistry registry; + @Inject + private ShutdownHandler shutdownHandler; + @Override protected FutureJVppIoamtraceFacade create() { try { final JVppIoamtraceImpl jVppIoamTr = new JVppIoamtraceImpl(); // Free jvpp-ioam plugin's resources on shutdown - Runtime.getRuntime().addShutdownHook(new Thread() { - @Override - public void run() { - LOG.info("Unloading jvpp-ioam-trace plugin"); - jVppIoamTr.close(); - LOG.info("Successfully unloaded jvpp-ioam-trace plugin"); - } - }); + shutdownHandler.register("jvpp-ioamtrace", jVppIoamTr); LOG.info("Successfully loaded jvpp-ioam-trace plugin"); return new FutureJVppIoamtraceFacade(registry, jVppIoamTr); diff --git a/nat/nat2vpp/src/main/java/io/fd/hc2vpp/nat/jvpp/JVppSnatProvider.java b/nat/nat2vpp/src/main/java/io/fd/hc2vpp/nat/jvpp/JVppSnatProvider.java index e5a1b3f4d..d1a1b766c 100755 --- a/nat/nat2vpp/src/main/java/io/fd/hc2vpp/nat/jvpp/JVppSnatProvider.java +++ b/nat/nat2vpp/src/main/java/io/fd/hc2vpp/nat/jvpp/JVppSnatProvider.java @@ -18,6 +18,7 @@ package io.fd.hc2vpp.nat.jvpp; import com.google.inject.Inject; import io.fd.honeycomb.binding.init.ProviderTrait; +import io.fd.honeycomb.data.init.ShutdownHandler; import io.fd.vpp.jvpp.JVppRegistry; import io.fd.vpp.jvpp.snat.JVppSnatImpl; import io.fd.vpp.jvpp.snat.future.FutureJVppSnatFacade; @@ -26,8 +27,8 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * Provides future API for jvpp-nsh plugin. Must be a singleton due to shutdown hook usage. - * Registers shutdown hook to free plugin's resources on shutdown. + * Provides future API for jvpp-nsh plugin. Must be a singleton due to shutdown hook usage. Registers shutdown hook to + * free plugin's resources on shutdown. */ public final class JVppSnatProvider extends ProviderTrait<FutureJVppSnatFacade> { @@ -36,19 +37,15 @@ public final class JVppSnatProvider extends ProviderTrait<FutureJVppSnatFacade> @Inject private JVppRegistry registry; + @Inject + private ShutdownHandler shutdownHandler; + @Override protected FutureJVppSnatFacade create() { try { final JVppSnatImpl jvppSnat = new JVppSnatImpl(); // Free jvpp-nsh plugin's resources on shutdown - Runtime.getRuntime().addShutdownHook(new Thread() { - @Override - public void run() { - LOG.info("Unloading jvpp-snat plugin"); - jvppSnat.close(); - LOG.info("Successfully unloaded jvpp-snat plugin"); - } - }); + shutdownHandler.register("jvpp-snat", jvppSnat); LOG.info("Successfully loaded jvpp-snat plugin"); return new FutureJVppSnatFacade(registry, jvppSnat); diff --git a/nsh/impl/src/main/java/io/fd/hc2vpp/vppnsh/impl/util/JVppNshProvider.java b/nsh/impl/src/main/java/io/fd/hc2vpp/vppnsh/impl/util/JVppNshProvider.java index c520b2d97..8f25a44e9 100755 --- a/nsh/impl/src/main/java/io/fd/hc2vpp/vppnsh/impl/util/JVppNshProvider.java +++ b/nsh/impl/src/main/java/io/fd/hc2vpp/vppnsh/impl/util/JVppNshProvider.java @@ -18,6 +18,7 @@ package io.fd.hc2vpp.vppnsh.impl.util; import com.google.inject.Inject; import io.fd.honeycomb.binding.init.ProviderTrait; +import io.fd.honeycomb.data.init.ShutdownHandler; import io.fd.vpp.jvpp.JVppRegistry; import io.fd.vpp.jvpp.nsh.JVppNshImpl; import io.fd.vpp.jvpp.nsh.future.FutureJVppNshFacade; @@ -26,8 +27,8 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * Provides future API for jvpp-nsh plugin. Must be a singleton due to shutdown hook usage. - * Registers shutdown hook to free plugin's resources on shutdown. + * Provides future API for jvpp-nsh plugin. Must be a singleton due to shutdown hook usage. Registers shutdown hook to + * free plugin's resources on shutdown. */ public final class JVppNshProvider extends ProviderTrait<FutureJVppNshFacade> { @@ -36,19 +37,15 @@ public final class JVppNshProvider extends ProviderTrait<FutureJVppNshFacade> { @Inject private JVppRegistry registry; + @Inject + private ShutdownHandler shutdownHandler; + @Override protected FutureJVppNshFacade create() { try { final JVppNshImpl jVppNsh = new JVppNshImpl(); // Free jvpp-nsh plugin's resources on shutdown - Runtime.getRuntime().addShutdownHook(new Thread() { - @Override - public void run() { - LOG.info("Unloading jvpp-nsh plugin"); - jVppNsh.close(); - LOG.info("Successfully unloaded jvpp-nsh plugin"); - } - }); + shutdownHandler.register("jvpp-nsh", jVppNsh); LOG.info("Successfully loaded jvpp-nsh plugin"); return new FutureJVppNshFacade(registry, jVppNsh); 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<>(); diff --git a/vpp-common/vpp-common-integration/pom.xml b/vpp-common/vpp-common-integration/pom.xml index 11b1ae1f1..6bdbe2d6a 100644 --- a/vpp-common/vpp-common-integration/pom.xml +++ b/vpp-common/vpp-common-integration/pom.xml @@ -64,6 +64,11 @@ <version>${honeycomb.min.distro.version}</version> </dependency> <dependency> + <groupId>io.fd.honeycomb</groupId> + <artifactId>cfg-init</artifactId> + <version>${project.version}</version> + </dependency> + <dependency> <groupId>${project.groupId}</groupId> <artifactId>naming-context-api</artifactId> <version>${project.version}</version> diff --git a/vpp-common/vpp-common-integration/src/main/java/io/fd/hc2vpp/common/integration/JVppCoreProvider.java b/vpp-common/vpp-common-integration/src/main/java/io/fd/hc2vpp/common/integration/JVppCoreProvider.java index 4945bb98e..609611252 100644 --- a/vpp-common/vpp-common-integration/src/main/java/io/fd/hc2vpp/common/integration/JVppCoreProvider.java +++ b/vpp-common/vpp-common-integration/src/main/java/io/fd/hc2vpp/common/integration/JVppCoreProvider.java @@ -18,11 +18,12 @@ package io.fd.hc2vpp.common.integration; import com.google.inject.Inject; import io.fd.honeycomb.binding.init.ProviderTrait; -import java.io.IOException; +import io.fd.honeycomb.data.init.ShutdownHandler; import io.fd.vpp.jvpp.JVppRegistry; import io.fd.vpp.jvpp.core.JVppCoreImpl; import io.fd.vpp.jvpp.core.future.FutureJVppCore; import io.fd.vpp.jvpp.core.future.FutureJVppCoreFacade; +import java.io.IOException; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -37,21 +38,15 @@ public final class JVppCoreProvider extends ProviderTrait<FutureJVppCore> { @Inject private JVppRegistry registry; + @Inject + private ShutdownHandler shutdownHandler; + @Override protected FutureJVppCoreFacade create() { try { final JVppCoreImpl jVpp = new JVppCoreImpl(); // Free jvpp-core plugin's resources on shutdown - Runtime.getRuntime().addShutdownHook(new Thread() { - - @Override - public void run() { - LOG.info("Unloading jvpp-core plugin"); - jVpp.close(); - LOG.info("Successfully unloaded jvpp-core plugin"); - } - }); - + shutdownHandler.register("jvpp-core", jVpp); LOG.info("Successfully loaded jvpp-core plugin"); return new FutureJVppCoreFacade(registry, jVpp); } catch (IOException e) { diff --git a/vpp-common/vpp-common-integration/src/main/java/io/fd/hc2vpp/common/integration/JVppRegistryProvider.java b/vpp-common/vpp-common-integration/src/main/java/io/fd/hc2vpp/common/integration/JVppRegistryProvider.java index 8837b7fe8..47c512898 100644 --- a/vpp-common/vpp-common-integration/src/main/java/io/fd/hc2vpp/common/integration/JVppRegistryProvider.java +++ b/vpp-common/vpp-common-integration/src/main/java/io/fd/hc2vpp/common/integration/JVppRegistryProvider.java @@ -17,11 +17,12 @@ package io.fd.hc2vpp.common.integration; import com.google.inject.Inject; -import io.fd.honeycomb.binding.init.ProviderTrait; import io.fd.hc2vpp.common.translate.util.VppStatusListener; -import java.io.IOException; +import io.fd.honeycomb.binding.init.ProviderTrait; +import io.fd.honeycomb.data.init.ShutdownHandler; import io.fd.vpp.jvpp.JVppRegistry; import io.fd.vpp.jvpp.JVppRegistryImpl; +import java.io.IOException; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -37,6 +38,8 @@ public final class JVppRegistryProvider extends ProviderTrait<JVppRegistry> { private VppConfigAttributes config; @Inject private VppStatusListener vppStatus; + @Inject + private ShutdownHandler shutdownHandler; @Override protected JVppRegistryImpl create() { @@ -46,23 +49,19 @@ public final class JVppRegistryProvider extends ProviderTrait<JVppRegistry> { // Closing JVpp connection with shutdown hook to erase the connection from VPP so HC will be able // to connect next time. If JVM is force closed, this will not be executed and VPP connection // with name from config will stay open and prevent next startup of HC to success - Runtime.getRuntime().addShutdownHook(new Thread() { - @Override - public void run() { - LOG.info("Disconnecting from VPP"); - if (vppStatus.isDown()) { - LOG.info("VPP is down. JVppRegistry cleanup is not needed. Exiting"); - return; - } - try { - registry.close(); - LOG.info("Successfully disconnected from VPP as {}", config.jvppConnectionName); - } catch (Exception e) { - LOG.warn("Unable to properly close jvpp registry", e); - } + shutdownHandler.register("jvpp-registry", () -> { + LOG.info("Disconnecting from VPP"); + if (vppStatus.isDown()) { + LOG.info("VPP is down. JVppRegistry cleanup is not needed. Exiting"); + return; + } + try { + registry.close(); + LOG.info("Successfully disconnected from VPP as {}", config.jvppConnectionName); + } catch (Exception e) { + LOG.warn("Unable to properly close jvpp registry", e); } }); - LOG.info("JVpp connection opened successfully as: {}", config.jvppConnectionName); return registry; } catch (IOException e) { diff --git a/vpp-common/vpp-common-integration/src/test/java/io/fd/hc2vpp/common/integration/VppCommonModuleTest.java b/vpp-common/vpp-common-integration/src/test/java/io/fd/hc2vpp/common/integration/VppCommonModuleTest.java index 540145beb..b1aab05ce 100644 --- a/vpp-common/vpp-common-integration/src/test/java/io/fd/hc2vpp/common/integration/VppCommonModuleTest.java +++ b/vpp-common/vpp-common-integration/src/test/java/io/fd/hc2vpp/common/integration/VppCommonModuleTest.java @@ -29,10 +29,10 @@ import com.google.inject.name.Named; import com.google.inject.testing.fieldbinder.Bind; import com.google.inject.testing.fieldbinder.BoundFieldModule; import io.fd.hc2vpp.common.translate.util.JvppReplyConsumer; +import io.fd.honeycomb.data.init.ShutdownHandler; import io.fd.honeycomb.translate.read.ReaderFactory; import java.util.HashSet; import java.util.Set; -import org.junit.Before; import org.junit.Test; import org.mockito.Mock; import org.opendaylight.controller.md.sal.binding.api.DataBroker; @@ -44,6 +44,10 @@ public class VppCommonModuleTest { @Mock private DataBroker honeycombContext; + @Mock + @Bind + private ShutdownHandler shutdownHandler; + @Inject private Set<ReaderFactory> readerFactories = new HashSet<>(); diff --git a/vpp-integration/api-docs/scripts/src/main/java/io/fd/hc2vpp/docs/core/mock/binding/MockBindingModule.java b/vpp-integration/api-docs/scripts/src/main/java/io/fd/hc2vpp/docs/core/mock/binding/MockBindingModule.java index e6500ea4c..9e49879b7 100644 --- a/vpp-integration/api-docs/scripts/src/main/java/io/fd/hc2vpp/docs/core/mock/binding/MockBindingModule.java +++ b/vpp-integration/api-docs/scripts/src/main/java/io/fd/hc2vpp/docs/core/mock/binding/MockBindingModule.java @@ -19,6 +19,7 @@ package io.fd.hc2vpp.docs.core.mock.binding; import static com.google.inject.name.Names.named; import com.google.inject.AbstractModule; +import io.fd.honeycomb.data.init.ShutdownHandler; import io.fd.honeycomb.translate.MappingContext; import io.fd.vpp.jvpp.JVppRegistry; import io.fd.vpp.jvpp.core.future.FutureJVppCore; @@ -40,6 +41,7 @@ public class MockBindingModule extends AbstractModule { .toInstance(noOpProxy(MappingContext.class)); bind(DataBroker.class).annotatedWith(named("honeycomb-context")).toInstance(noOpProxy(DataBroker.class)); bind(JVppRegistry.class).toInstance(noOpProxy(JVppRegistry.class)); + bind(ShutdownHandler.class).toInstance(noOpProxy(ShutdownHandler.class)); } static <T> T noOpProxy(Class<T> clazz) { |