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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2019 Nordix Foundation.
   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.pap.main.rest;
  22
  23 import io.swagger.annotations.ApiOperation;
  24 import io.swagger.annotations.ApiParam;
  25 import io.swagger.annotations.ApiResponse;
  26 import io.swagger.annotations.ApiResponses;
  27 import io.swagger.annotations.Authorization;
  28 import io.swagger.annotations.Extension;
  29 import io.swagger.annotations.ExtensionProperty;
  30 import io.swagger.annotations.ResponseHeader;
  31
  32 import java.util.UUID;
  33
  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
  40 import org.apache.commons.lang3.tuple.Pair;
  41 import org.onap.policy.models.pdp.concepts.PdpGroups;
  42
  43 /**
  44  * Class to provide REST end points for PAP component to query details of all PDP groups.
  45  *
  46  * @author Ram Krishna Verma (ram.krishna.verma@est.tech)
  47  */
  48 public class PdpGroupQueryControllerV1 extends PapRestControllerV1 {
  49
  50     private final PdpGroupQueryProvider provider = new PdpGroupQueryProvider();
  51
  52     /**
  53      * Queries details of all PDP groups.
  54      *
  55      * @param requestId request ID used in ONAP logging
  56      * @return a response
  57      */
  58     // @formatter:off
  59     @GET
  60     @Path("pdps")
  61     @ApiOperation(value = "Query details of all PDP groups",
  62         notes = "Queries details of all PDP groups, returning all group details",
  63         response = PdpGroups.class,
  64         tags = {"Policy Administration (PAP) API"},
  65         authorizations = @Authorization(value = AUTHORIZATION_TYPE),
  66         responseHeaders = {
  67             @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
  68                             response = String.class),
  69             @ResponseHeader(name = VERSION_PATCH_NAME, description = VERSION_PATCH_DESCRIPTION,
  70                             response = String.class),
  71             @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
  72                             response = String.class),
  73             @ResponseHeader(name = REQUEST_ID_NAME, description = REQUEST_ID_HDR_DESCRIPTION,
  74                             response = UUID.class)},
  75         extensions = {@Extension(name = EXTENSION_NAME,
  76             properties = {@ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
  77                 @ExtensionProperty(name = LAST_MOD_NAME, value = LAST_MOD_RELEASE)})})
  78     @ApiResponses(value = {@ApiResponse(code = AUTHENTICATION_ERROR_CODE, message = AUTHENTICATION_ERROR_MESSAGE),
  79                     @ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE),
  80                     @ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE)})
  81     // @formatter:on
  82
  83     public Response queryGroupDetails(
  84             @HeaderParam(REQUEST_ID_NAME) @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) final UUID requestId) {
  85
  86         final Pair<Status, PdpGroups> pair = provider.fetchPdpGroupDetails();
  87
  88         return addLoggingHeaders(addVersionControlHeaders(Response.status(pair.getLeft())), requestId)
  89                 .entity(pair.getRight()).build();
  90     }
  91 }