aboutsummaryrefslogtreecommitdiffstats
path: root/main/src/main/java/org/onap/policy/pap/main/rest/HealthCheckProvider.java
blob: f7cfb363d5999909e43494ecb3d0d13e6550a6c2 (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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2019 Nordix Foundation.
 *  Modifications Copyright (C) 2019, 2021 AT&T Intellectual Property.
 *  Modifications Copyright (C) 2021-2022 Bell Canada. All rights reserved.
 * ================================================================================
 * 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.
 *
 * SPDX-License-Identifier: Apache-2.0
 * ============LICENSE_END=========================================================
 */

package org.onap.policy.pap.main.rest;

import org.onap.policy.common.endpoints.report.HealthCheckReport;
import org.onap.policy.common.utils.network.NetworkUtil;
import org.onap.policy.common.utils.services.Registry;
import org.onap.policy.models.base.PfModelRuntimeException;
import org.onap.policy.pap.main.PapConstants;
import org.onap.policy.pap.main.startstop.PapActivator;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

/**
 * Class to fetch health check of PAP service.
 *
 * @author Ram Krishna Verma (ram.krishna.verma@est.tech)
 */
@Service
public class HealthCheckProvider {

    private static final String NOT_ALIVE = "not alive";
    private static final String ALIVE = "alive";
    private static final String URL = NetworkUtil.getHostname();
    private static final String NAME = "Policy PAP";

    @Autowired
    private PolicyStatusProvider policyStatusProvider;
    private static final Logger LOGGER = LoggerFactory.getLogger(HealthCheckProvider.class);

    /**
     * Performs the health check of PAP service.
     *
     * @param checkDbConnectivity flag to enable pap to db connectivity verification
     * @return Report containing health check status
     */
    public HealthCheckReport performHealthCheck(boolean checkDbConnectivity) {
        final var report = new HealthCheckReport();
        report.setName(NAME);
        report.setUrl(URL);

        boolean alive = Registry.get(PapConstants.REG_PAP_ACTIVATOR, PapActivator.class).isAlive();

        if (alive && checkDbConnectivity) {
            alive = verifyPapDbConnectivity();
        }

        report.setHealthy(alive);
        report.setCode(alive ? 200 : 503);
        report.setMessage(alive ? ALIVE : NOT_ALIVE);
        return report;
    }

    /**
     * Verifies the connectivity between pap component & policy database.
     *
     * @return boolean signaling the verification result
     */
    private boolean verifyPapDbConnectivity() {
        try {
            policyStatusProvider.getPolicyStatus();
            return true;
        } catch (PfModelRuntimeException pfModelRuntimeException) {
            LOGGER.warn("Policy pap to database connection check failed. Details - ", pfModelRuntimeException);
            return false;
        }
    }
}