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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2019-2021 Nordix Foundation.
   4  *  Modifications Copyright (C) 2019, 2021 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
   9  *
  10  *      http://www.apache.org/licenses/LICENSE-2.0
  11  *
  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.
  17  *
  18  * SPDX-License-Identifier: Apache-2.0
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.policy.pap.main.rest;
  23
  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;
  32 import java.util.UUID;
  33 import javax.ws.rs.HeaderParam;
  34 import javax.ws.rs.PUT;
  35 import javax.ws.rs.Path;
  36 import javax.ws.rs.PathParam;
  37 import javax.ws.rs.QueryParam;
  38 import javax.ws.rs.core.Response;
  39 import javax.ws.rs.core.Response.Status;
  40 import org.apache.commons.lang3.tuple.Pair;
  41 import org.onap.policy.models.base.PfModelException;
  42 import org.onap.policy.models.base.PfModelRuntimeException;
  43 import org.onap.policy.models.pap.concepts.PdpGroupStateChangeResponse;
  44 import org.onap.policy.models.pdp.enums.PdpState;
  45 import org.slf4j.Logger;
  46 import org.slf4j.LoggerFactory;
  47
  48 /**
  49  * Class to provide REST end points for PAP component to change state of a PDP group.
  50  *
  51  * @author Ram Krishna Verma (ram.krishna.verma@est.tech)
  52  */
  53 public class PdpGroupStateChangeControllerV1 extends PapRestControllerV1 {
  54
  55     private static final Logger LOGGER = LoggerFactory.getLogger(PdpGroupStateChangeControllerV1.class);
  56
  57     private final PdpGroupStateChangeProvider provider = new PdpGroupStateChangeProvider();
  58
  59     /**
  60      * Changes state of a PDP group.
  61      *
  62      * @param requestId request ID used in ONAP logging
  63      * @param groupName name of the PDP group to be deleted
  64      * @param state state of the PDP group
  65      * @return a response
  66      */
  67     // @formatter:off
  68     @PUT
  69     @Path("pdps/groups/{name}")
  70     @ApiOperation(value = "Change state of a PDP Group",
  71         notes = "Changes state of PDP Group, returning optional error details",
  72         response = PdpGroupStateChangeResponse.class,
  73         tags = {"PdpGroup State Change"},
  74         authorizations = @Authorization(value = AUTHORIZATION_TYPE),
  75         responseHeaders = {
  76             @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
  77                             response = String.class),
  78             @ResponseHeader(name = VERSION_PATCH_NAME, description = VERSION_PATCH_DESCRIPTION,
  79                             response = String.class),
  80             @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
  81                             response = String.class),
  82             @ResponseHeader(name = REQUEST_ID_NAME, description = REQUEST_ID_HDR_DESCRIPTION,
  83                             response = UUID.class)},
  84         extensions = {@Extension(name = EXTENSION_NAME,
  85                 properties = {
  86                     @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
  87                     @ExtensionProperty(name = LAST_MOD_NAME, value = LAST_MOD_RELEASE)
  88                 })
  89             })
  90     @ApiResponses(value = {
  91         @ApiResponse(code = AUTHENTICATION_ERROR_CODE, message = AUTHENTICATION_ERROR_MESSAGE),
  92         @ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE),
  93         @ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE)
  94     })
  95     // @formatter:on
  96
  97     public Response changeGroupState(
  98             @HeaderParam(REQUEST_ID_NAME) @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) final UUID requestId,
  99             @ApiParam(value = "PDP Group Name", required = true) @PathParam("name") final String groupName,
 100             @ApiParam(value = "PDP Group State", required = true) @QueryParam("state") final PdpState state) {
 101
 102         try {
 103             final Pair<Status, PdpGroupStateChangeResponse> pair = provider.changeGroupState(groupName, state);
 104             return addLoggingHeaders(addVersionControlHeaders(Response.status(pair.getLeft())), requestId)
 105                     .entity(pair.getRight()).build();
 106         } catch (final PfModelException | PfModelRuntimeException exp) {
 107             LOGGER.info("group state-change failed", exp);
 108             return addLoggingHeaders(
 109                     addVersionControlHeaders(Response.status(exp.getErrorResponse().getResponseCode())), requestId)
 110                             .entity(exp.getErrorResponse()).build();
 111         }
 112     }
 113 }