gerrit.onap Code Review - policy/clamp.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2021 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.clamp.controlloop.participant.simulator.simulation.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 import java.util.List;
  32 import java.util.UUID;
  33 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.Participant;
  34 import org.onap.policy.clamp.controlloop.models.messages.rest.TypedSimpleResponse;
  35 import org.onap.policy.clamp.controlloop.participant.simulator.main.rest.AbstractRestController;
  36 import org.onap.policy.clamp.controlloop.participant.simulator.simulation.SimulationProvider;
  37 import org.springframework.http.ResponseEntity;
  38 import org.springframework.web.bind.annotation.GetMapping;
  39 import org.springframework.web.bind.annotation.PathVariable;
  40 import org.springframework.web.bind.annotation.PutMapping;
  41 import org.springframework.web.bind.annotation.RequestBody;
  42 import org.springframework.web.bind.annotation.RequestHeader;
  43 import org.springframework.web.bind.annotation.RestController;
  44
  45 /**
  46  * Class to provide REST end points for participant simulator to query/update details of all participants.
  47  */
  48 @RestController
  49 public class SimulationParticipantController extends AbstractRestController {
  50
  51     /**
  52      * Constructor.
  53      *
  54      * @param simulationProvider the Simulation Provider
  55      */
  56     public SimulationParticipantController(SimulationProvider simulationProvider) {
  57         super(simulationProvider);
  58     }
  59
  60     /**
  61      * Queries details of all participants within the simulator.
  62      *
  63      * @param requestId request ID used in ONAP logging
  64      * @param name the name of the participant to get, null to get all
  65      * @param version the version of the participant to get, null to get all
  66      * @return the participants
  67      */
  68     // @formatter:off
  69     @GetMapping("/participants/{name}/{version}")
  70     @ApiOperation(value = "Query details of the requested simulated participants",
  71             notes = "Queries details of the requested simulated participants, "
  72                     + "returning all participant details",
  73             response = List.class,
  74             tags = {
  75                 "Clamp Control Loop Participant Simulator API"
  76             },
  77             authorizations = @Authorization(value = AUTHORIZATION_TYPE),
  78             responseHeaders = {
  79                     @ResponseHeader(
  80                             name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
  81                             response = String.class),
  82                     @ResponseHeader(name = VERSION_PATCH_NAME, description = VERSION_PATCH_DESCRIPTION,
  83                             response = String.class),
  84                     @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
  85                             response = String.class),
  86                     @ResponseHeader(name = REQUEST_ID_NAME, description = REQUEST_ID_HDR_DESCRIPTION,
  87                             response = UUID.class)},
  88             extensions = {
  89                     @Extension(
  90                             name = EXTENSION_NAME,
  91                             properties = {
  92                                     @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
  93                                     @ExtensionProperty(name = LAST_MOD_NAME, value = LAST_MOD_RELEASE)
  94                             }
  95                     )
  96             }
  97     )
  98     @ApiResponses(
  99             value = {
 100                     @ApiResponse(code = AUTHENTICATION_ERROR_CODE, message = AUTHENTICATION_ERROR_MESSAGE),
 101                     @ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE),
 102                     @ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE)
 103             }
 104     )
 105     // @formatter:on
 106     public ResponseEntity<List<Participant>> participants(
 107             @RequestHeader(
 108                     name = REQUEST_ID_NAME,
 109                     required = false) @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId,
 110             @ApiParam(value = "Participant name", required = true) @PathVariable("name") String name,
 111             @ApiParam(value = "Participant version", required = true) @PathVariable("version") String version) {
 112
 113         return ResponseEntity.ok().body(getSimulationProvider().getParticipants(name, version));
 114     }
 115
 116     /**
 117      * Updates a participant in the simulator.
 118      *
 119      * @param requestId request ID used in ONAP logging
 120      * @param body the body of a participant
 121      * @return a response
 122      */
 123     // @formatter:off
 124     @PutMapping("/participants")
 125     @ApiOperation(
 126             value = "Updates simulated participants",
 127             notes = "Updates simulated participants, returning the updated control loop definition IDs",
 128             response = TypedSimpleResponse.class,
 129             tags = {
 130                 "Clamp Control Loop Participant Simulator API"
 131                 },
 132             authorizations = @Authorization(value = AUTHORIZATION_TYPE),
 133             responseHeaders = {
 134                     @ResponseHeader(
 135                             name = VERSION_MINOR_NAME,
 136                             description = VERSION_MINOR_DESCRIPTION,
 137                             response = String.class),
 138                     @ResponseHeader(
 139                             name = VERSION_PATCH_NAME,
 140                             description = VERSION_PATCH_DESCRIPTION,
 141                             response = String.class),
 142                     @ResponseHeader(
 143                             name = VERSION_LATEST_NAME,
 144                             description = VERSION_LATEST_DESCRIPTION,
 145                             response = String.class),
 146                     @ResponseHeader(
 147                             name = REQUEST_ID_NAME,
 148                             description = REQUEST_ID_HDR_DESCRIPTION,
 149                             response = UUID.class)
 150                 },
 151             extensions = {
 152                 @Extension(
 153                     name = EXTENSION_NAME,
 154                     properties = {
 155                             @ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
 156                             @ExtensionProperty(name = LAST_MOD_NAME, value = LAST_MOD_RELEASE)
 157                     }
 158                 )
 159             }
 160         )
 161     @ApiResponses(
 162             value = {
 163                 @ApiResponse(code = AUTHENTICATION_ERROR_CODE, message = AUTHENTICATION_ERROR_MESSAGE),
 164                 @ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE),
 165                 @ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE)
 166             }
 167         )
 168     // @formatter:on
 169     public ResponseEntity<TypedSimpleResponse<Participant>> update(
 170             @RequestHeader(
 171                     name = REQUEST_ID_NAME,
 172                     required = false) @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId,
 173             @ApiParam(value = "Body of a participant", required = true) @RequestBody Participant body) {
 174
 175         return ResponseEntity.ok().body(getSimulationProvider().updateParticipant(body));
 176     }
 177 }