2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2018 Samsung Electronics Co., Ltd. All rights reserved.
6 * Modifications Copyright (C) 2019, 2021 AT&T Intellectual Property. All rights reserved.
7 * Modifications Copyright (C) 2019 Nordix Foundation.
8 * Modifications Copyright (C) 2022 Bell Canada. All rights reserved.
9 * ================================================================================
10 * Licensed under the Apache License, Version 2.0 (the "License");
11 * you may not use this file except in compliance with the License.
12 * You may obtain a copy of the License at
14 * http://www.apache.org/licenses/LICENSE-2.0
16 * Unless required by applicable law or agreed to in writing, software
17 * distributed under the License is distributed on an "AS IS" BASIS,
18 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19 * See the License for the specific language governing permissions and
20 * limitations under the License.
22 * SPDX-License-Identifier: Apache-2.0
23 * ============LICENSE_END=========================================================
26 package org.onap.policy.api.main.rest.provider.healthcheck;
28 import lombok.RequiredArgsConstructor;
29 import org.onap.policy.api.main.service.ToscaServiceTemplateService;
30 import org.onap.policy.common.endpoints.report.HealthCheckReport;
31 import org.onap.policy.common.utils.network.NetworkUtil;
32 import org.onap.policy.models.base.PfModelRuntimeException;
33 import org.slf4j.Logger;
34 import org.slf4j.LoggerFactory;
35 import org.springframework.stereotype.Service;
38 * Class to fetch health check of api service.
42 @RequiredArgsConstructor
43 public class HealthCheckProvider {
45 private static final Logger LOGGER = LoggerFactory.getLogger(HealthCheckProvider.class);
46 private static final String ALIVE = "alive";
47 private static final String URL = NetworkUtil.getHostname();
48 private static final String NAME = "Policy API";
49 private static final String DB_CONN_FAILURE = "unable to connect with database";
51 private final ToscaServiceTemplateService toscaServiceTemplateService;
54 * Performs the health check of api service.
56 * @return Report containing health check status
58 public HealthCheckReport performHealthCheck() {
59 final var report = new HealthCheckReport();
60 final var dbConnectionStatus = verifyApiDatabase();
63 report.setHealthy(dbConnectionStatus);
64 report.setCode(dbConnectionStatus ? 200 : 503);
65 report.setMessage(dbConnectionStatus ? ALIVE : DB_CONN_FAILURE);
70 * Verifies the connectivity between api component & policy database.
72 * @return boolean signaling the verification result
74 private boolean verifyApiDatabase() {
76 toscaServiceTemplateService.getDefaultJpaToscaServiceTemplate();
78 } catch (PfModelRuntimeException pfme) {
79 LOGGER.warn("Api to database connection check failed. Details - ", pfme);