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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2018 Samsung Electronics Co., Ltd. All rights reserved.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.api.main.rest;
  22
  23 import io.swagger.annotations.Api;
  24 import io.swagger.annotations.ApiOperation;
  25 import io.swagger.annotations.Info;
  26 import io.swagger.annotations.SwaggerDefinition;
  27 import io.swagger.annotations.Tag;
  28 import org.onap.policy.common.endpoints.report.HealthCheckReport;
  29
  30 import javax.ws.rs.GET;
  31 import javax.ws.rs.Path;
  32 import javax.ws.rs.Produces;
  33 import javax.ws.rs.core.MediaType;
  34 import javax.ws.rs.core.Response;
  35
  36 /**
  37  * Class to provide api REST services.
  38  *
  39  */
  40 @Path("/")
  41 @Api
  42 @Produces(MediaType.APPLICATION_JSON)
  43 @SwaggerDefinition(
  44         info = @Info(description = "Policy Api Service", version = "v1.0", title = "Policy Api"),
  45         consumes = { MediaType.APPLICATION_JSON }, produces = { MediaType.APPLICATION_JSON },
  46         schemes = { SwaggerDefinition.Scheme.HTTP },
  47         tags = { @Tag(name = "policy-api", description = "Policy Api Service Operations") })
  48 public class ApiRestController {
  49
  50     @GET
  51     @Path("healthcheck")
  52     @Produces(MediaType.APPLICATION_JSON)
  53     @ApiOperation(value = "Perform a system healthcheck",
  54             notes = "Provides healthy status of the Policy Api component", response = HealthCheckReport.class)
  55     public Response healthcheck() {
  56         return Response.status(Response.Status.OK).entity(new HealthCheckProvider().performHealthCheck()).build();
  57     }
  58 }