blob: 139e52820dbd1e938c6e9bcde7971afdfbe949fb (
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
|
/*-
* ============LICENSE_START=======================================================
* ONAP Policy API
* ================================================================================
* Copyright (C) 2018 Samsung Electronics Co., Ltd. All rights reserved.
* Modifications Copyright (C) 2019, 2021 AT&T Intellectual Property. All rights reserved.
* Modifications Copyright (C) 2019 Nordix Foundation.
* Modifications Copyright (C) 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.api.main.rest.provider;
import lombok.RequiredArgsConstructor;
import org.onap.policy.api.main.rest.PolicyFetchMode;
import org.onap.policy.api.main.service.ToscaServiceTemplateService;
import org.onap.policy.common.endpoints.report.HealthCheckReport;
import org.onap.policy.common.utils.network.NetworkUtil;
import org.onap.policy.models.base.PfModelException;
import org.onap.policy.models.base.PfModelRuntimeException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Service;
/**
* Class to fetch health check of api service.
*
*/
@Service
@RequiredArgsConstructor
public class HealthCheckProvider {
private static final Logger LOGGER = LoggerFactory.getLogger(HealthCheckProvider.class);
private static final String ALIVE = "alive";
private static final String URL = NetworkUtil.getHostname();
private static final String NAME = "Policy API";
private static final String DB_CONN_FAILURE = "unable to connect with database";
private final ToscaServiceTemplateService toscaServiceTemplateService;
/**
* Performs the health check of api service.
*
* @return Report containing health check status
*/
public HealthCheckReport performHealthCheck() {
final var report = new HealthCheckReport();
final var dbConnectionStatus = verifyApiDatabase();
report.setName(NAME);
report.setUrl(URL);
report.setHealthy(dbConnectionStatus);
report.setCode(dbConnectionStatus ? 200 : 503);
report.setMessage(dbConnectionStatus ? ALIVE : DB_CONN_FAILURE);
return report;
}
/**
* Verifies the connectivity between api component & policy database.
*
* @return boolean signaling the verification result
*/
private boolean verifyApiDatabase() {
try {
toscaServiceTemplateService.getDefaultJpaToscaServiceTemplate();
return true;
} catch (PfModelRuntimeException pfme) {
LOGGER.warn("Api to database connection check failed. Details - ", pfme);
return false;
}
}
}
|
