org.opentripplanner.standalone.config.OtpConfigLoader Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of application Show documentation
The newest version!
package org.opentripplanner.standalone.config;

import static org.opentripplanner.framework.application.OtpFileNames.BUILD_CONFIG_FILENAME;
import static org.opentripplanner.framework.application.OtpFileNames.DEBUG_UI_CONFIG_FILENAME;
import static org.opentripplanner.framework.application.OtpFileNames.OTP_CONFIG_FILENAME;
import static org.opentripplanner.framework.application.OtpFileNames.ROUTER_CONFIG_FILENAME;

import com.fasterxml.jackson.databind.JsonNode;
import java.io.File;
import javax.annotation.Nullable;
import org.opentripplanner.standalone.config.framework.file.ConfigFileLoader;
import org.opentripplanner.standalone.config.framework.json.NodeAdapter;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Generic config file loader. This is used to load all configuration files.
 * 
 * This class also provides logging when a config file is loaded. We load and parse config files
 * early to reveal syntax errors without waiting for graph build.
 */
public class OtpConfigLoader {

  private static final Logger LOG = LoggerFactory.getLogger(OtpConfigLoader.class);

  @Nullable
  private final File configDir;

  @Nullable
  private final String jsonFallback;

  private OtpConfigLoader(File configDir, String jsonFallback) {
    this.configDir = configDir;
    this.jsonFallback = jsonFallback;
  }

  /**
   * Create a config loader that load config from the given directory.
   */
  public OtpConfigLoader(File configDir) {
    this(configDir, null);
  }

  /**
   * Create a config loader that load config from the given input json document. Use it with {@link
   * #loadBuildConfig()} or one of the other load methods to return a configuration for the given
   * input json string.
   */
  public static OtpConfigLoader fromString(String json) {
    return new OtpConfigLoader(null, json);
  }

  /**
   * Log the config-version for each configuration file. The logging is only performed if the
   * config-version is set.
   */
  public static void logConfigVersion(
    String otpConfigVersion,
    String buildConfigVersion,
    String routerConfigVersion
  ) {
    logConfigVersion(otpConfigVersion, OTP_CONFIG_FILENAME);
    logConfigVersion(buildConfigVersion, BUILD_CONFIG_FILENAME);
    logConfigVersion(routerConfigVersion, ROUTER_CONFIG_FILENAME);
  }

  /**
   * Load the graph build configuration file as a JsonNode three. An empty node is returned if the
   * given {@code configDir}  is {@code null} or config file is NOT found.
   * 

   * This method also log all loaded parameters to the console.
   * 

   */
  public OtpConfig loadOtpConfig() {
    return new OtpConfig(
      new NodeAdapter(loadFromFile(OTP_CONFIG_FILENAME), OTP_CONFIG_FILENAME),
      true
    );
  }

  /**
   * Load the graph build configuration file as a JsonNode three. An empty node is returned if the
   * given {@code configDir}  is {@code null} or config file is NOT found.
   * 

   * This method also log all loaded parameters to the console.
   * 

   */
  public BuildConfig loadBuildConfig() {
    JsonNode node = loadFromFile(BUILD_CONFIG_FILENAME);
    if (node.isMissingNode()) {
      return BuildConfig.DEFAULT;
    }
    return new BuildConfig(node, BUILD_CONFIG_FILENAME, true);
  }

  /**
   * Load the router configuration file as a JsonNode three. An empty node is returned if the given
   * {@code configDir}  is {@code null} or config file is NOT found.
   * 
   */
  public RouterConfig loadRouterConfig() {
    JsonNode node = loadFromFile(ROUTER_CONFIG_FILENAME);
    if (node.isMissingNode()) {
      return RouterConfig.DEFAULT;
    }
    return new RouterConfig(node, ROUTER_CONFIG_FILENAME, true);
  }

  public DebugUiConfig loadDebugUiConfig() {
    JsonNode node = loadFromFile(DEBUG_UI_CONFIG_FILENAME);
    if (node.isMissingNode()) {
      return DebugUiConfig.DEFAULT;
    }
    return new DebugUiConfig(node, DEBUG_UI_CONFIG_FILENAME, true);
  }

  private static void logConfigVersion(String configVersion, String filename) {
    if (configVersion != null) {
      LOG.info("{} config-version is {}.", filename, configVersion);
    }
  }

  private JsonNode loadFromFile(String filename) {
    return ConfigFileLoader.of()
      .withConfigDir(configDir)
      .withJsonFallback(jsonFallback)
      .loadFromFile(filename);
  }
}