vpp-common/vpp-common-integration/src/main/java/io/fd/honeycomb/vpp/common/integration/JVppRegistryProvider.java

   1 /*
   2  * Copyright (c) 2016 Cisco and/or its affiliates.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 package io.fd.honeycomb.vpp.common.integration;
  18
  19 import com.google.inject.Inject;
  20 import io.fd.honeycomb.infra.distro.ProviderTrait;
  21 import io.fd.honeycomb.translate.vpp.util.VppStatusListener;
  22 import java.io.IOException;
  23 import io.fd.vpp.jvpp.JVppRegistry;
  24 import io.fd.vpp.jvpp.JVppRegistryImpl;
  25 import org.slf4j.Logger;
  26 import org.slf4j.LoggerFactory;
  27
  28 /**
  29  * Provides JVppRegistry. Must be a singleton due to shutdown hook usage. Registers shutdown hook to disconnect from
  30  * VPP.
  31  */
  32 public final class JVppRegistryProvider extends ProviderTrait<JVppRegistry> {
  33
  34     private static final Logger LOG = LoggerFactory.getLogger(JVppRegistryProvider.class);
  35
  36     @Inject
  37     private VppConfigAttributes config;
  38     @Inject
  39     private VppStatusListener vppStatus;
  40
  41     @Override
  42     protected JVppRegistryImpl create() {
  43         try {
  44             final JVppRegistryImpl registry = new JVppRegistryImpl(config.jvppConnectionName);
  45
  46             // Closing JVpp connection with shutdown hook to erase the connection from VPP so HC will be able
  47             // to connect next time. If JVM is force closed, this will not be executed and VPP connection
  48             // with name from config will stay open and prevent next startup of HC to success
  49             Runtime.getRuntime().addShutdownHook(new Thread() {
  50                 @Override
  51                 public void run() {
  52                     LOG.info("Disconnecting from VPP");
  53                     if (vppStatus.isDown()) {
  54                         LOG.info("VPP is down. JVppRegistry cleanup is not needed. Exiting");
  55                         return;
  56                     }
  57                     try {
  58                         registry.close();
  59                         LOG.info("Successfully disconnected from VPP as {}", config.jvppConnectionName);
  60                     } catch (Exception e) {
  61                         LOG.warn("Unable to properly close jvpp registry", e);
  62                     }
  63                 }
  64             });
  65
  66             LOG.info("JVpp connection opened successfully as: {}", config.jvppConnectionName);
  67             return registry;
  68         } catch (IOException e) {
  69             throw new IllegalStateException("Unable to open VPP management connection", e);
  70         }
  71     }
  72 }