com.github.valdr.Options Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of valdr-bean-validation Show documentation
There is a newer version: 2.0.0
Show newest version
package com.github.valdr;

import com.google.common.collect.Lists;
import lombok.Getter;
import lombok.Setter;
import org.apache.commons.lang3.StringUtils;

import java.util.List;

/**
 * All supported options.
 */
@Getter
@Setter
public final class Options {
  /**
   * Name of the config file this class' values are mapped from.
   */
  public static final String CONFIG_FILE_NAME = "valdr-bean-validation.json";

  /**
   * Collection of fully qualified package names (e.g. com.company.abc.model) in which you keep Bean Validation
   * annotated model classes.
   *
   * Mandatory: yes
   * Use: CLI/Servlet
   */
  private List modelPackages = Lists.newArrayList();

  /**
   * Collection of fully qualified class names (e.g. com.company.abc.model.Token) to exclude from parsing. Naturally
   * this only makes sense for classes contained in packages included in {@code modelPackages}.
   *
   * Mandatory: no
   * Use: CLI/Servlet
   */
  private List excludedClasses = Lists.newArrayList();

  /**
   * Collection of fully qualified field names (e.g. com.company.abc.model.Person#shoeSize). Fields contained in this
   * list will not be included in the constraints JSON document. Naturally this only makes sense for fields of classes
   * contained in packages included in {@code modelPackages}.
   *
   * Mandatory: no
   * Use: CLI/Servlet
   */
  private List excludedFields = Lists.newArrayList();

  /**
   * Collection of custom validator annotation class names. By default only the ones defined in {@link
   * BuiltInConstraint} are processed.
   *
   * Mandatory: no
   * Use: CLI/Servlet
   */
  private List customAnnotationClasses = Lists.newArrayList();

  /**
   * Whether the output type name should be the simple name of a type (default) or the full type name (i.e., including
   * the package name).
   *
   * Mandatory: no
   * Use: CLI/Servlet
   */
  private Boolean outputFullTypeName = Boolean.FALSE;

  /**
   * In case the Servlet is deployed under a different domain than the valdr client you can use CORS to access that resource. If omitted no
   * CORS-related HTTP headers are set.
   *
   * Mandatory: no
   * Use: Servlet
   */
  private String corsAllowOriginPattern = StringUtils.EMPTY;

  /**
   * File to which the validation meta-model (JSON) is written. Missing folders are created automatically. If omitted
   * the output is sent to system out.
   *
   * Mandatory: no
   * Use: CLI
   */
  private String outputFile = StringUtils.EMPTY;

  /**
   * Validates the consistency and integrity of the configured options.
   *
   * @throws InvalidConfigurationException if problems are detected
   */
  public void validate() {
    if (this.getModelPackages().isEmpty()) {
      throw new InvalidConfigurationException("Model package names must not be empty.");
    }
  }

  /**
   * Thrown if configuration is invalid.
   */
  public static class InvalidConfigurationException extends RuntimeException {
    /**
     * C'tor.
     *
     * @param msg message describing what the problem with the configuration is i.e. why it's invalid
     */
    public InvalidConfigurationException(String msg) {
      super(msg);
    }
  }
}