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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2019,2021 Nordix Foundation.
   4  *  Modifications Copyright (C) 2020 AT&T Intellectual Property.
   5  *  Modifications Copyright (C) 2021 Bell Canada. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  * SPDX-License-Identifier: Apache-2.0
  20  * ============LICENSE_END=========================================================
  21  */
  22
  23 package org.onap.policy.pap.main.rest;
  24
  25 import java.util.Map;
  26 import java.util.UUID;
  27 import lombok.RequiredArgsConstructor;
  28 import org.apache.commons.lang3.tuple.Pair;
  29 import org.springframework.http.HttpStatus;
  30 import org.springframework.http.ResponseEntity;
  31 import org.springframework.web.bind.annotation.RestController;
  32
  33 /**
  34  * Class to provide REST end point for PAP component to fetch all policy components, including PAP,
  35  * API, Distribution, and PDPs.
  36  *
  37  * @author Yehui Wang (yehui.wang@est.tech)
  38  */
  39 @RestController
  40 @RequiredArgsConstructor
  41 public class PolicyComponentsHealthCheckControllerV1 extends PapRestControllerV1
  42     implements PolicyComponentsHealthCheckControllerV1Api {
  43
  44     private final PolicyComponentsHealthCheckProvider provider;
  45
  46
  47     /**
  48      * Returns health status of all Policy components, including PAP, API, Distribution, and PDPs.
  49      *
  50      * @param requestId request ID used in ONAP logging
  51      * @return a response
  52      */
  53     @Override
  54     public ResponseEntity<Map<String, Object>> policyComponentsHealthCheck(UUID requestId) {
  55         final Pair<HttpStatus, Map<String, Object>> pair = provider.fetchPolicyComponentsHealthStatus();
  56         return addLoggingHeaders(addVersionControlHeaders(ResponseEntity.status(pair.getLeft())), requestId)
  57             .body(pair.getRight());
  58     }
  59 }