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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of otp Show documentation

The OpenTripPlanner multimodal journey planning system

There is a newer version: 2.6.0

package org.opentripplanner.standalone.config;

import static org.opentripplanner.standalone.config.framework.json.OtpVersion.NA;
import static org.opentripplanner.standalone.config.framework.json.OtpVersion.V2_1;

import com.fasterxml.jackson.databind.JsonNode;
import java.util.Map;
import org.opentripplanner.standalone.config.framework.json.NodeAdapter;
import org.opentripplanner.util.OTPFeature;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * This class is an object representation of the 'otp-config.json'.
 */
public class OtpConfig {

  /**
   * This description is shared for otp-config, build-config and router-config.
   */
  public static final String CONFIG_VERSION_DESCRIPTION =
    """
    The config-version is a parameter which each OTP deployment may set to be able to query the
    OTP server and verify that it uses the correct version of the config. The version should be
    injected into the config in the (continuous) deployment pipeline. How this is done, is up to
    the deployment.

    The config-version has no effect on OTP, and is provided as is on the API. There is no syntax
    or format check on the version and it can be any string.

    Be aware that OTP uses the config embedded in the loaded graph if no new config is provided.
    """;

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

  public final NodeAdapter root;

  public final Map otpFeatures;

  /**
   * The config-version is a parameter which each OTP deployment may set to be able to query the OTP
   * server and verify that it uses the correct version of the config. The version must be injected
   * into the config in the operation deployment pipeline. How this is done is up to the
   * deployment.
   * 
   * The config-version have no effect on OTP, and is provided as is on the API. There is not syntax
   * or format check on the version and it can be any string.
   * 
   * This parameter is optional, and the default is {@code null}.
   */
  public final String configVersion;

  public OtpConfig(JsonNode otpConfig, String source, boolean logUnusedParams) {
    this.root = new NodeAdapter(otpConfig, source);

    this.configVersion =
      root
        .of("configVersion")
        .since(V2_1)
        .summary("Deployment version of the *otp-config.json*.")
        .description(CONFIG_VERSION_DESCRIPTION)
        .asString(null);
    this.otpFeatures =
      root.of("otpFeatures").since(NA).summary("TODO").asEnumMap(OTPFeature.class, Boolean.class);

    if (logUnusedParams && LOG.isWarnEnabled()) {
      root.logAllUnusedParameters(LOG::warn);
    }
  }
}