2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2019 Nordix Foundation.
4 * Modifications Copyright (C) 2020 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
10 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 * SPDX-License-Identifier: Apache-2.0
19 * ============LICENSE_END=========================================================
22 package org.onap.policy.pap.main.rest;
24 import io.swagger.annotations.ApiOperation;
25 import io.swagger.annotations.ApiParam;
26 import io.swagger.annotations.ApiResponse;
27 import io.swagger.annotations.ApiResponses;
28 import io.swagger.annotations.Authorization;
29 import io.swagger.annotations.Extension;
30 import io.swagger.annotations.ExtensionProperty;
31 import io.swagger.annotations.ResponseHeader;
33 import java.util.UUID;
34 import javax.ws.rs.GET;
35 import javax.ws.rs.HeaderParam;
36 import javax.ws.rs.Path;
37 import javax.ws.rs.core.Response;
38 import javax.ws.rs.core.Response.Status;
39 import org.apache.commons.lang3.tuple.Pair;
42 * Class to provide REST end point for PAP component to fetch all policy components, including PAP,
43 * API, Distribution, and PDPs.
45 * @author Yehui Wang (yehui.wang@est.tech)
47 public class PolicyComponentsHealthCheckControllerV1 extends PapRestControllerV1 {
50 * Returns health status of all Policy components, including PAP, API, Distribution, and PDPs.
51 * Note: a new provider {@link PolicyComponentsHealthCheckProvider} must be created for each
54 * @param requestId request ID used in ONAP logging
59 @Path("components/healthcheck")
60 @ApiOperation(value = "Returns health status of all policy components, including PAP, API, Distribution, and PDPs",
61 notes = "Queries health status of all policy components, returning all policy components health status",
63 tags = {"Policy Administration (PAP) API"},
64 authorizations = @Authorization(value = AUTHORIZATION_TYPE),
66 @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
67 response = String.class),
68 @ResponseHeader(name = VERSION_PATCH_NAME, description = VERSION_PATCH_DESCRIPTION,
69 response = String.class),
70 @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
71 response = String.class),
72 @ResponseHeader(name = REQUEST_ID_NAME, description = REQUEST_ID_HDR_DESCRIPTION,
73 response = UUID.class)},
74 extensions = {@Extension(name = EXTENSION_NAME,
75 properties = {@ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
76 @ExtensionProperty(name = LAST_MOD_NAME, value = LAST_MOD_RELEASE)})})
77 @ApiResponses(value = {@ApiResponse(code = AUTHENTICATION_ERROR_CODE, message = AUTHENTICATION_ERROR_MESSAGE),
78 @ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE),
79 @ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE)})
82 public Response policyComponentsHealthCheck(
83 @HeaderParam(REQUEST_ID_NAME) @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) final UUID requestId) {
84 final Pair<Status, Map<String, Object>> pair =
85 new PolicyComponentsHealthCheckProvider().fetchPolicyComponentsHealthStatus();
86 return addLoggingHeaders(addVersionControlHeaders(Response.status(pair.getLeft())), requestId)
87 .entity(pair.getRight()).build();