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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2019-2023 Nordix Foundation.
   4  *  Modifications Copyright (C) 2021 AT&T Intellectual Property. All rights reserved.
   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.UUID;
  26 import lombok.RequiredArgsConstructor;
  27 import org.apache.commons.lang3.tuple.Pair;
  28 import org.onap.policy.models.base.PfModelException;
  29 import org.onap.policy.models.pdp.concepts.Pdps;
  30 import org.slf4j.Logger;
  31 import org.slf4j.LoggerFactory;
  32 import org.springframework.context.annotation.Profile;
  33 import org.springframework.http.HttpStatus;
  34 import org.springframework.http.ResponseEntity;
  35 import org.springframework.web.bind.annotation.RestController;
  36
  37 /**
  38  * Class to provide REST end point for PAP component to fetch health status of all PDPs registered with PAP.
  39  *
  40  * @author Ram Krishna Verma (ram.krishna.verma@est.tech)
  41  */
  42
  43 @RestController
  44 @RequiredArgsConstructor
  45 @Profile("default")
  46 public class PdpGroupHealthCheckControllerV1 extends PapRestControllerV1
  47     implements PdpGroupHealthCheckControllerV1Api {
  48
  49     private static final Logger logger = LoggerFactory.getLogger(PdpGroupHealthCheckControllerV1.class);
  50     private final PdpGroupHealthCheckProvider provider;
  51
  52     /**
  53      * Returns health status of all PDPs registered with PAP.
  54      *
  55      * @param requestId request ID used in ONAP logging
  56      * @return a response
  57      * @throws PfModelException Exception thrown by fetchPdpGroupHealthStatus
  58      */
  59     @Override
  60     public ResponseEntity<Pdps> pdpGroupHealthCheck(UUID requestId) {
  61         try {
  62             Pair<HttpStatus, Pdps> pair = provider.fetchPdpGroupHealthStatus();
  63             return addLoggingHeaders(addVersionControlHeaders(ResponseEntity.status(pair.getLeft())), requestId)
  64                 .body(pair.getRight());
  65         } catch (PfModelException e) {
  66             logger.warn("fetch Pdp Group Health Status failed", e);
  67             return new ResponseEntity<>(HttpStatus.INTERNAL_SERVER_ERROR);
  68         }
  69
  70     }
  71 }