How to use

ResponseMessageDeclaration

in

org.restlet.ext.platform.internal.conversion.swagger.v1_2.model

/**
 * Fills Restlet Web API definition's operation Responses from Swagger
 * ResourceOperationDeclaration
 * 
 * @param operation
 *            The Restlet Web API definition's Operation
 * @param swaggerOperation
 *            The Swagger ResourceOperationDeclaration
 */
private static void fillResponseMessages(Operation operation,
    ResourceOperationDeclaration swaggerOperation) {
  // Set error response messages
  if (swaggerOperation.getResponseMessages() != null) {
    for (ResponseMessageDeclaration swagResponse : swaggerOperation
        .getResponseMessages()) {
      Response response = new Response();
      PayLoad outputPayLoad = new PayLoad();
      outputPayLoad.setType(swagResponse.getResponseModel());
      response.setOutputPayLoad(outputPayLoad);
      response.setName("Error " + swagResponse.getCode());
      response.setCode(swagResponse.getCode());
      response.setMessage(swagResponse.getMessage());
      operation.getResponses().add(response);
    }
  }
}

/**
 * Fills Swagger ResourceOperationDeclaration's error responses from Restlet
 * Web API definition's Operation
 * 
 * @param operation
 *            The Restlet Web API definition's Operation
 * @param usedModels
 *            The models specified by this API declaration
 * @param rod
 *            The Swagger Swagger ResourceOperationDeclaration
 */
private static void fillApiDeclarationResponses(Operation operation,
    Collection<String> usedModels, ResourceOperationDeclaration rod) {
  // Get response messages
  for (Response response : operation.getResponses()) {
    if (Status.isSuccess(response.getCode())) {
      continue;
    }
    ResponseMessageDeclaration rmd = new ResponseMessageDeclaration();
    rmd.setCode(response.getCode());
    rmd.setMessage(response.getMessage());
    if (response.getOutputPayLoad() != null
        && response.getOutputPayLoad().getType() != null) {
      rmd.setResponseModel(response.getOutputPayLoad().getType());
      usedModels.add(response.getOutputPayLoad().getType());
    }
    rod.getResponseMessages().add(rmd);
  }
}

/**
 * Fills Swagger ResourceOperationDeclaration's error responses from Restlet
 * Web API definition's Operation
 * 
 * @param operation
 *            The Restlet Web API definition's Operation
 * @param usedModels
 *            The models specified by this API declaration
 * @param rod
 *            The Swagger Swagger ResourceOperationDeclaration
 */
private static void fillApiDeclarationResponses(Operation operation,
    Collection<String> usedModels, ResourceOperationDeclaration rod) {
  // Get response messages
  for (Response response : operation.getResponses()) {
    if (Status.isSuccess(response.getCode())) {
      continue;
    }
    ResponseMessageDeclaration rmd = new ResponseMessageDeclaration();
    rmd.setCode(response.getCode());
    rmd.setMessage(response.getMessage());
    if (response.getOutputPayLoad() != null
        && response.getOutputPayLoad().getType() != null) {
      rmd.setResponseModel(response.getOutputPayLoad().getType());
      usedModels.add(response.getOutputPayLoad().getType());
    }
    rod.getResponseMessages().add(rmd);
  }
}

/**
 * Fills Swagger ResourceOperationDeclaration's error responses from Restlet
 * Web API definition's Operation
 * 
 * @param operation
 *            The Restlet Web API definition's Operation
 * @param usedModels
 *            The models specified by this API declaration
 * @param rod
 *            The Swagger Swagger ResourceOperationDeclaration
 */
private static void fillApiDeclarationResponses(Operation operation,
    Collection<String> usedModels, ResourceOperationDeclaration rod) {
  // Get response messages
  for (Response response : operation.getResponses()) {
    if (Status.isSuccess(response.getCode())) {
      continue;
    }
    ResponseMessageDeclaration rmd = new ResponseMessageDeclaration();
    rmd.setCode(response.getCode());
    rmd.setMessage(response.getMessage());
    if (response.getOutputPayLoad() != null
        && response.getOutputPayLoad().getType() != null) {
      rmd.setResponseModel(response.getOutputPayLoad().getType());
      usedModels.add(response.getOutputPayLoad().getType());
    }
    rod.getResponseMessages().add(rmd);
  }
}

/**
 * Fills Restlet Web API definition's operation Responses from Swagger
 * ResourceOperationDeclaration
 * 
 * @param operation
 *            The Restlet Web API definition's Operation
 * @param swaggerOperation
 *            The Swagger ResourceOperationDeclaration
 */
private static void fillResponseMessages(Operation operation,
    ResourceOperationDeclaration swaggerOperation) {
  // Set error response messages
  if (swaggerOperation.getResponseMessages() != null) {
    for (ResponseMessageDeclaration swagResponse : swaggerOperation
        .getResponseMessages()) {
      Response response = new Response();
      PayLoad outputPayLoad = new PayLoad();
      outputPayLoad.setType(swagResponse.getResponseModel());
      response.setOutputPayLoad(outputPayLoad);
      response.setName("Error " + swagResponse.getCode());
      response.setCode(swagResponse.getCode());
      response.setMessage(swagResponse.getMessage());
      operation.getResponses().add(response);
    }
  }
}

/**
 * Fills Swagger ResourceOperationDeclaration's error responses from Restlet
 * Web API definition's Operation
 * 
 * @param operation
 *            The Restlet Web API definition's Operation
 * @param usedModels
 *            The models specified by this API declaration
 * @param rod
 *            The Swagger Swagger ResourceOperationDeclaration
 */
private static void fillApiDeclarationResponses(Operation operation,
    Collection<String> usedModels, ResourceOperationDeclaration rod) {
  // Get response messages
  for (Response response : operation.getResponses()) {
    if (Status.isSuccess(response.getCode())) {
      continue;
    }
    ResponseMessageDeclaration rmd = new ResponseMessageDeclaration();
    rmd.setCode(response.getCode());
    rmd.setMessage(response.getMessage());
    if (response.getOutputPayLoad() != null
        && response.getOutputPayLoad().getType() != null) {
      rmd.setResponseModel(response.getOutputPayLoad().getType());
      usedModels.add(response.getOutputPayLoad().getType());
    }
    rod.getResponseMessages().add(rmd);
  }
}

/**
 * Fills Restlet Web API definition's operation Responses from Swagger
 * ResourceOperationDeclaration
 * 
 * @param operation
 *            The Restlet Web API definition's Operation
 * @param swaggerOperation
 *            The Swagger ResourceOperationDeclaration
 */
private static void fillResponseMessages(Operation operation,
    ResourceOperationDeclaration swaggerOperation) {
  // Set error response messages
  if (swaggerOperation.getResponseMessages() != null) {
    for (ResponseMessageDeclaration swagResponse : swaggerOperation
        .getResponseMessages()) {
      Response response = new Response();
      PayLoad outputPayLoad = new PayLoad();
      outputPayLoad.setType(swagResponse.getResponseModel());
      response.setOutputPayLoad(outputPayLoad);
      response.setName("Error " + swagResponse.getCode());
      response.setCode(swagResponse.getCode());
      response.setMessage(swagResponse.getMessage());
      operation.getResponses().add(response);
    }
  }
}

/**
 * Fills Restlet Web API definition's operation Responses from Swagger
 * ResourceOperationDeclaration
 * 
 * @param operation
 *            The Restlet Web API definition's Operation
 * @param swaggerOperation
 *            The Swagger ResourceOperationDeclaration
 */
private static void fillResponseMessages(Operation operation,
    ResourceOperationDeclaration swaggerOperation) {
  // Set error response messages
  if (swaggerOperation.getResponseMessages() != null) {
    for (ResponseMessageDeclaration swagResponse : swaggerOperation
        .getResponseMessages()) {
      Response response = new Response();
      PayLoad outputPayLoad = new PayLoad();
      outputPayLoad.setType(swagResponse.getResponseModel());
      response.setOutputPayLoad(outputPayLoad);
      response.setName("Error " + swagResponse.getCode());
      response.setCode(swagResponse.getCode());
      response.setMessage(swagResponse.getMessage());
      operation.getResponses().add(response);
    }
  }
}