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

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