summaryrefslogtreecommitdiffstats
path: root/vpp-common/minimal-distribution/src/main/java/io/fd/honeycomb/vpp/distro/JVppRegistryProvider.java
blob: 33756f27306ff63483d2ec18240428900072ef3d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
/*
 * Copyright (c) 2016 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.vpp.distro;

import com.google.inject.Inject;
import io.fd.honeycomb.infra.distro.ProviderTrait;
import io.fd.honeycomb.translate.v3po.util.VppStatusListener;
import java.io.IOException;
import org.openvpp.jvpp.JVppRegistry;
import org.openvpp.jvpp.JVppRegistryImpl;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Provides JVppRegistry. Must be a singleton due to shutdown hook usage. Registers shutdown hook to disconnect from
 * VPP.
 */
public final class JVppRegistryProvider extends ProviderTrait<JVppRegistry> {

    private static final Logger LOG = LoggerFactory.getLogger(JVppRegistryProvider.class);

    @Inject
    private VppConfigAttributes config;
    @Inject
    private VppStatusListener vppStatus;

    @Override
    protected JVppRegistryImpl create() {
        try {
            final JVppRegistryImpl registry = new JVppRegistryImpl(config.jvppConnectionName);

            // 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);
                    }
                }
            });

            LOG.info("JVpp connection opened successfully as: {}", config.jvppConnectionName);
            return registry;
        } catch (IOException e) {
            throw new IllegalStateException("Unable to open VPP management connection", e);
        }
    }
}