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