Examples with InputWrap org.opentosca.toscana.api.model.InputWrap used on opensource projects

Example 1 with InputWrap

use of org.opentosca.toscana.api.model.InputWrap in project TOSCAna by StuPro-TOSCAna.

the class TransformationController method getInputs.

/**
 *     Returns a list of inputs that might have to be set (if they are required) in order to start
 *     the transformation <p>
 *     Accessed with http call <code>GET /csars/{csar}/transformations/{platform}/inputs</code>
 *     <table summary="">
 *     <tr>
 *     <td>HTTP-Code</td>
 *     <td>Mime-Type</td>
 *     <td>Description (Returned if)</td>
 *     </tr>
 *     <tr>
 *     <td>200</td>
 *     <td>application/hal+json</td>
 *     <td>Returned with content body (See samples.md) if the operation was successful</td>
 *     </tr>
 *     <tr>
 *     <td>404</td>
 *     <td>application/json</td>
 *     <td>Returns a error message if the csar is not found or if the csar does not have a transformation for the given
 *     name (see returned error message for details)</td>
 *     </tr>
 *     </table>
 */
@RequestMapping(path = "/{platform}/inputs", method = RequestMethod.GET, produces = "application/hal+json")
@ApiOperation(value = "Retrieve the inputs of this transformation", tags = { "transformations" }, notes = "This Operation returns a list of inputs, specific to the csar and the platform. " + "If the input is invalid it has to be set in order to proceed with " + "starting the transformation. Setting the inputs is done with a POST or PUT to the same URL " + "(See Set Inputs Operation). If Transformation does not have any inputs, an empty array " + "is returned")
@ApiResponses({ @ApiResponse(code = 200, message = "The operation was executed successfully", response = GetInputsResponse.class), @ApiResponse(code = 404, message = "There is no CSAR for the given identifier or the CSAR does not have " + "a Transformation for the specified platform.", response = RestErrorResponse.class) })
public ResponseEntity<GetInputsResponse> getInputs(@ApiParam(value = "The identifier for the CSAR", required = true, example = "test") @PathVariable(name = "csarId") String csarId, @ApiParam(value = "The identifier for the platform", required = true, example = "kubernetes") @PathVariable(name = "platform") String platformId) {
    Csar csar = findByCsarId(csarId);
    Transformation transformation = findTransformationByPlatform(csar, platformId);
    List<InputWrap> inputWrapList = toPropertyWrapList(transformation.getInputs(), null);
    GetInputsResponse response = new GetInputsResponse(csarId, platformId, inputWrapList);
    return ResponseEntity.ok(response);
}

Example 2 with InputWrap

use of org.opentosca.toscana.api.model.InputWrap in project TOSCAna by StuPro-TOSCAna.

the class TransformationController method setInputs.

/**
 *     This mapping is used to post the inputs to the server.
 *     <p>
 *     Accessed with http call <code>PUT or POST /csars/{csar}/transformations/{platform}/inputs</code>
 *     <table summary="">
 *     <tr>
 *     <td>HTTP-Code</td>
 *     <td>Mime-Type</td>
 *     <td>Description (Returned if)</td>
 *     </tr>
 *     <tr>
 *     <td>200</td>
 *     <td>application/hal+json</td>
 *     <td>Returns a empty body if all required inputs have been set</td>
 *     </tr>
 *     <tr>
 *     <td>400</td>
 *     <td>application/json</td>
 *     <td>Returned if the transformation is not in a valid state (has to be in INPUT_REQUIRED or READY)</td>
 *     </tr>
 *     <tr>
 *     <td>404</td>
 *     <td>application/json</td>
 *     <td>Returns an error message if the csar is not found or if the csar does not have a transformation for the given
 *     platformId (see returned error message for details)</td>
 *     </tr>
 *     </table>
 */
@RequestMapping(path = "/{platform}/inputs", method = { RequestMethod.POST, RequestMethod.PUT }, produces = "application/json")
@ApiOperation(value = "Set the value of inputs", tags = { "transformations" }, notes = "With this method it is possible to set the value of an input or multiple inputs at once. The values " + "of inputs can be set as long as they are in the READY or INPUT_REQUIRED state. The transformation changes its state " + "to ready once all required inputs have a valid value assigned to them.")
@ApiResponses({ @ApiResponse(code = 200, message = "The operation was executed successfully", response = Void.class), @ApiResponse(code = 400, message = "Inputs cannot get set once the transformation has been started.", response = RestErrorResponse.class), @ApiResponse(code = 404, message = "There is no CSAR for the given identifier or the CSAR does not have " + "a transformation for the specified platform.", response = RestErrorResponse.class), @ApiResponse(code = 406, message = "At least one of the inputs could not get set because either the key does not exist or the " + "syntax validation of the value has failed.", response = InputsResponse.class) })
public ResponseEntity<InputsResponse> setInputs(@ApiParam(value = "The unique identifier for the CSAR", required = true, example = "test") @PathVariable(name = "csarId") String csarId, @ApiParam(value = "The identifier for the platform", required = true, example = "kubernetes") @PathVariable(name = "platform") String platformId, @RequestBody InputsResponse propertiesRequest) {
    Csar csar = findByCsarId(csarId);
    Transformation transformation = findTransformationByPlatform(csar, platformId);
    List<TransformationState> validStates = Arrays.asList(INPUT_REQUIRED, READY);
    if (!Arrays.asList(INPUT_REQUIRED, READY).contains(transformation.getState())) {
        throw new IllegalTransformationStateException(String.format("The transformation is not in one of the states '%s'", validStates));
    }
    PropertyInstance inputs = transformation.getInputs();
    Map<String, Boolean> successes = new HashMap<>();
    boolean somethingFailed = false;
    // Set the properties and check their validity
    for (InputWrap entry : propertiesRequest.getInputs()) {
        try {
            boolean success = inputs.set(entry.getKey(), entry.getValue());
            successes.put(entry.getKey(), success);
            if (!success) {
                somethingFailed = true;
            }
        } catch (NoSuchPropertyException e) {
            logger.error("Failed to set inputs for transformation '%s'", transformation, e);
            somethingFailed = true;
            successes.put(entry.getKey(), false);
        }
    }
    if (!somethingFailed) {
        return ResponseEntity.ok().build();
    } else {
        Set<String> requestedKeys = new HashSet<>(successes.keySet());
        List<InputWrap> propWrapList = toPropertyWrapList(inputs, requestedKeys);
        // The request contains invalid values
        if (requestedKeys.size() > propWrapList.size()) {
            Set<String> knownKeys = propWrapList.stream().map(InputWrap::getKey).collect(Collectors.toSet());
            // Remove all known (valid) keys
            requestedKeys.removeAll(knownKeys);
            requestedKeys.forEach(e -> {
                propWrapList.add(new InputWrap(e, PropertyType.INVALID_KEY, "Invalid Key", null, false, null, false));
            });
        }
        InputsResponse response = new InputsResponse(propWrapList);
        return ResponseEntity.status(HttpStatus.NOT_ACCEPTABLE).body(response);
    }
}