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

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