main/src/main/java/org/onap/policy/pap/main/rest/HealthCheckProvider.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2019 Nordix Foundation.
   4  *  Modifications Copyright (C) 2019, 2021 AT&T Intellectual Property.
   5  * ================================================================================
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  *      http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *
  18  * SPDX-License-Identifier: Apache-2.0
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.policy.pap.main.rest;
  23
  24 import org.onap.policy.common.endpoints.report.HealthCheckReport;
  25 import org.onap.policy.common.utils.network.NetworkUtil;
  26 import org.onap.policy.common.utils.services.Registry;
  27 import org.onap.policy.pap.main.PapConstants;
  28 import org.onap.policy.pap.main.startstop.PapActivator;
  29
  30 /**
  31  * Class to fetch health check of PAP service.
  32  *
  33  * @author Ram Krishna Verma (ram.krishna.verma@est.tech)
  34  */
  35 public class HealthCheckProvider {
  36
  37     private static final String NOT_ALIVE = "not alive";
  38     private static final String ALIVE = "alive";
  39     private static final String URL = NetworkUtil.getHostname();
  40     private static final String NAME = "Policy PAP";
  41
  42     /**
  43      * Performs the health check of PAP service.
  44      *
  45      * @return Report containing health check status
  46      */
  47     public HealthCheckReport performHealthCheck() {
  48         final var report = new HealthCheckReport();
  49         report.setName(NAME);
  50         report.setUrl(URL);
  51
  52         boolean alive = Registry.get(PapConstants.REG_PAP_ACTIVATOR, PapActivator.class).isAlive();
  53
  54         report.setHealthy(alive);
  55         report.setCode(alive ? 200 : 500);
  56         report.setMessage(alive ? ALIVE : NOT_ALIVE);
  57         return report;
  58     }
  59 }