io.vertx.ext.web.api.contract.impl.BaseRouterFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vertx-web-api-contract Show documentation
There is a newer version: 4.5.11
Show newest version
package io.vertx.ext.web.api.contract.impl;

import io.vertx.codegen.annotations.Fluent;
import io.vertx.core.Handler;
import io.vertx.core.Vertx;
import io.vertx.core.json.JsonObject;
import io.vertx.ext.web.RoutingContext;
import io.vertx.ext.web.api.contract.RouterFactory;
import io.vertx.ext.web.api.contract.RouterFactoryOptions;
import io.vertx.ext.web.api.validation.ValidationException;
import io.vertx.ext.web.handler.BodyHandler;

import java.util.ArrayList;
import java.util.List;
import java.util.function.Function;

/**
 * @author Francesco Guardiani @slinkydeveloper
 */
abstract public class BaseRouterFactory implements RouterFactory {

  /**
   * Default validation failure handler. When ValidationException occurs, It sends a response
   * with status code 400, status message "Bad Request" and error message as body
   */
  public final static Handler DEFAULT_VALIDATION_FAILURE_HANDLER = (routingContext -> {
    if (routingContext.failure() instanceof ValidationException) {
      routingContext
        .response()
        .setStatusCode(400)
        .setStatusMessage("Bad Request")
        .end(routingContext.failure().getMessage());
    } else routingContext.next();
  });

  /**
   * Default not implemented handler. It sends a response with status code 501,
   * status message "Not Implemented" and empty body
   */
  public final static Handler DEFAULT_NOT_IMPLEMENTED_HANDLER = (routingContext) -> routingContext.response().setStatusCode(501).setStatusMessage("Not Implemented").end();

  /** Default extra payload mapper for {@link io.vertx.ext.web.api.OperationRequest}. By default, no mapper is specified
   *
   */
  public final static Function DEFAULT_EXTRA_OPERATION_CONTEXT_PAYLOAD_MAPPER = null;

  protected Vertx vertx;
  protected Specification spec;
  protected RouterFactoryOptions options;

  private Handler validationFailureHandler;
  private Handler notImplementedFailureHandler;
  private BodyHandler bodyHandler;
  private List> globalHandlers;
  private Function extraOperationContextPayloadMapper;

  public BaseRouterFactory(Vertx vertx, Specification spec, RouterFactoryOptions options) {
    this.vertx = vertx;
    this.spec = spec;
    this.options = options;

    this.validationFailureHandler = DEFAULT_VALIDATION_FAILURE_HANDLER;
    this.notImplementedFailureHandler = DEFAULT_NOT_IMPLEMENTED_HANDLER;
    this.bodyHandler = BodyHandler.create();
    this.globalHandlers = new ArrayList<>();
    this.extraOperationContextPayloadMapper = DEFAULT_EXTRA_OPERATION_CONTEXT_PAYLOAD_MAPPER;
  }

  public BaseRouterFactory(Vertx vertx, Specification spec) {
    this(vertx, spec, new RouterFactoryOptions());
  }

  @Override
  public RouterFactory setOptions(RouterFactoryOptions options) {
    this.options = options;
    return this;
  }

  @Override
  public RouterFactoryOptions getOptions() {
    return options;
  }

  @Override
  public Handler getValidationFailureHandler() {
    return validationFailureHandler;
  }

  @Override
  @Fluent
  public RouterFactory setValidationFailureHandler(Handler validationFailureHandler) {
    this.validationFailureHandler = validationFailureHandler;
    return this;
  }

  protected Handler getNotImplementedFailureHandler() {
    return notImplementedFailureHandler;
  }

  @Override
  @Fluent
  public RouterFactory setNotImplementedFailureHandler(Handler notImplementedFailureHandler) {
    this.notImplementedFailureHandler = notImplementedFailureHandler;
    return this;
  }

  protected BodyHandler getBodyHandler() {
    return bodyHandler;
  }

  @Override
  @Fluent
  public RouterFactory setBodyHandler(BodyHandler bodyHandler) {
    this.bodyHandler = bodyHandler;
    return this;
  }

  protected List> getGlobalHandlers() {
    return globalHandlers;
  }

  @Override
  @Fluent
  public RouterFactory addGlobalHandler(Handler globalHandler) {
    this.globalHandlers.add(globalHandler);
    return this;
  }

  protected Function getExtraOperationContextPayloadMapper() {
    return extraOperationContextPayloadMapper;
  }

  @Override
  @Fluent
  public RouterFactory setExtraOperationContextPayloadMapper(Function extraOperationContextPayloadMapper) {
    this.extraOperationContextPayloadMapper = extraOperationContextPayloadMapper;
    return this;
  }
}