summaryrefslogtreecommitdiffstats
path: root/infra
diff options
context:
space:
mode:
authorMarek Gradzki <mgradzki@cisco.com>2018-03-07 14:51:18 +0100
committerMarek Gradzki <mgradzki@cisco.com>2018-03-07 14:53:33 +0100
commit9659d28f1083f8ce9c67db3fb708f5b96740fba4 (patch)
treec27be4f85bdd4cd626abcfc5ed7b0228cfc78e97 /infra
parenta604b493ab32467635ec1767b2747bcf8f22cae9 (diff)
Move shutdown hook registration to dedicated provider
This change would allow using ShutdownHandlerImpl in integration tests. Change-Id: I854f65d03b9e1a495fda7211fd1b7fd51b4e5ba3 Signed-off-by: Marek Gradzki <mgradzki@cisco.com>
Diffstat (limited to 'infra')
-rw-r--r--infra/cfg-init/src/main/java/io/fd/honeycomb/data/init/ShutdownHandler.java9
-rw-r--r--infra/impl/src/main/java/io/fd/honeycomb/impl/ShutdownHandlerImpl.java6
-rw-r--r--infra/minimal-distribution-core/src/main/java/io/fd/honeycomb/infra/distro/data/ConfigAndOperationalPipelineModule.java2
-rw-r--r--infra/minimal-distribution-core/src/main/java/io/fd/honeycomb/infra/distro/data/ShutdownHandlerProvider.java31
4 files changed, 41 insertions, 7 deletions
diff --git a/infra/cfg-init/src/main/java/io/fd/honeycomb/data/init/ShutdownHandler.java b/infra/cfg-init/src/main/java/io/fd/honeycomb/data/init/ShutdownHandler.java
index fc350da..6a0096e 100644
--- a/infra/cfg-init/src/main/java/io/fd/honeycomb/data/init/ShutdownHandler.java
+++ b/infra/cfg-init/src/main/java/io/fd/honeycomb/data/init/ShutdownHandler.java
@@ -19,15 +19,20 @@ package io.fd.honeycomb.data.init;
import javax.annotation.Nonnull;
/**
- * Handles closing of closeable components
+ * Handles closing of closeable components.
*/
public interface ShutdownHandler {
/**
- * Register component to be properly closed on shutdown
+ * Registers component to be properly closed on shutdown.
*
* @param name component name
* @param component closeable component
*/
void register(@Nonnull final String name, @Nonnull final AutoCloseable component);
+
+ /**
+ * Performs shutdown for all registered components.
+ */
+ void performShutdown();
}
diff --git a/infra/impl/src/main/java/io/fd/honeycomb/impl/ShutdownHandlerImpl.java b/infra/impl/src/main/java/io/fd/honeycomb/impl/ShutdownHandlerImpl.java
index 7114581..f622a60 100644
--- a/infra/impl/src/main/java/io/fd/honeycomb/impl/ShutdownHandlerImpl.java
+++ b/infra/impl/src/main/java/io/fd/honeycomb/impl/ShutdownHandlerImpl.java
@@ -16,7 +16,6 @@
package io.fd.honeycomb.impl;
-import com.google.common.annotations.VisibleForTesting;
import io.fd.honeycomb.data.init.ShutdownHandler;
import java.util.Deque;
import java.util.LinkedList;
@@ -32,7 +31,6 @@ public final class ShutdownHandlerImpl implements ShutdownHandler {
public ShutdownHandlerImpl() {
components = new LinkedList<>();
- Runtime.getRuntime().addShutdownHook(new Thread((this::performShutdown)));
}
@Override
@@ -60,8 +58,8 @@ public final class ShutdownHandlerImpl implements ShutdownHandler {
}
}
- @VisibleForTesting
- void performShutdown() {
+ @Override
+ public void performShutdown() {
// close components in reverse order that they were registered
components.descendingIterator().forEachRemaining(closeable -> {
LOG.info("Closing component {}", closeable.getName());
diff --git a/infra/minimal-distribution-core/src/main/java/io/fd/honeycomb/infra/distro/data/ConfigAndOperationalPipelineModule.java b/infra/minimal-distribution-core/src/main/java/io/fd/honeycomb/infra/distro/data/ConfigAndOperationalPipelineModule.java
index 080caaf..d0cbdc1 100644
--- a/infra/minimal-distribution-core/src/main/java/io/fd/honeycomb/infra/distro/data/ConfigAndOperationalPipelineModule.java
+++ b/infra/minimal-distribution-core/src/main/java/io/fd/honeycomb/infra/distro/data/ConfigAndOperationalPipelineModule.java
@@ -47,7 +47,7 @@ public class ConfigAndOperationalPipelineModule extends PrivateModule {
@Override
protected void configure() {
- bind(ShutdownHandler.class).to(ShutdownHandlerImpl.class).in(Singleton.class);
+ bind(ShutdownHandler.class).toProvider(ShutdownHandlerProvider.class).in(Singleton.class);
expose(ShutdownHandler.class);
// Mount point service is required by notification service and restconf
diff --git a/infra/minimal-distribution-core/src/main/java/io/fd/honeycomb/infra/distro/data/ShutdownHandlerProvider.java b/infra/minimal-distribution-core/src/main/java/io/fd/honeycomb/infra/distro/data/ShutdownHandlerProvider.java
new file mode 100644
index 0000000..0c649b0
--- /dev/null
+++ b/infra/minimal-distribution-core/src/main/java/io/fd/honeycomb/infra/distro/data/ShutdownHandlerProvider.java
@@ -0,0 +1,31 @@
+/*
+ * Copyright (c) 2018 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.honeycomb.infra.distro.data;
+
+import io.fd.honeycomb.binding.init.ProviderTrait;
+import io.fd.honeycomb.data.init.ShutdownHandler;
+import io.fd.honeycomb.impl.ShutdownHandlerImpl;
+
+public class ShutdownHandlerProvider extends ProviderTrait<ShutdownHandler> {
+ @Override
+ protected ShutdownHandler create() {
+ final ShutdownHandler handler = new ShutdownHandlerImpl();
+ // Make sure ShutdownHandler is run on JVM shutdown
+ Runtime.getRuntime().addShutdownHook(new Thread((handler::performShutdown)));
+ return handler;
+ }
+}