org.opentripplanner.standalone.config.StorageConfig Maven / Gradle / Ivy
Show all versions of otp Show documentation
package org.opentripplanner.standalone.config;
import javax.validation.constraints.NotNull;
import java.net.URI;
import java.util.ArrayList;
import java.util.List;
import java.util.regex.Pattern;
import static org.opentripplanner.datastore.OtpDataStoreConfig.DEFAULT_DEM_PATTERN;
import static org.opentripplanner.datastore.OtpDataStoreConfig.DEFAULT_GTFS_PATTERN;
import static org.opentripplanner.datastore.OtpDataStoreConfig.DEFAULT_NETEX_PATTERN;
import static org.opentripplanner.datastore.OtpDataStoreConfig.DEFAULT_OSM_PATTERN;
/**
* Configure paths to each individual file resource. Use URIs to specify paths. If a parameter is
* specified, it override any local files, and the local file is NOT loaded.
*
* Local file access is supported. Use the following URI format:
*
* file:/a/b/c/filename.ext
*
* Google Cloud Storage(GCS) access is supported. Use the following URI format:
*
* gs://bucket-name/a/b/c/blobname.ext
*
*
* Example {@code build-config.json}:
*
* {
* osmWayPropertySet: "norway",
* storage: {
* gsCredentials: "${OTP_GOOGLE_SERVICE_ACCOUNT}",
* osm: [ "gs://otp-test-bucket/a/b/osm-oslo-mini.pbf" ],
* dem: [ "file:/public/dem/norway.dem.tif" ],
* gtfs: ["gs://otp-bucket/rut-gtfs.zip", "gs://otp-bucket/vy-gtfs.zip"],
* buildReportDir: "gs://otp-bucket/build-report"
* }
* }
*
* In the example above, the Google cloud service credentials file resolved using an environment
* variable. The OSM and GTFS data is streamed from Google Cloud Storage, the elevation data is
* fetched from the local file system and the build report is stored in the cloud. All other
* artifacts like the loaded graph, saved graph and NeTEx files are loaded and written from/to the local
* base directory - it they exist.
*/
public class StorageConfig {
/**
* Local file system path to Google Cloud Platform service accounts credentials file. The
* credentials is used to access GCS urls. When using GCS from outside of the bucket cluster you
* need to provide a path the the service credentials. Environment variables in the path is
* resolved.
*
* Example: {@code "credentialsFile" : "${MY_GOC_SERVICE}"} or {@code "app-1-3983f9f66728.json"
* : "~/"}
*
* This is a path to a file on the local file system, not an URI.
*
* This parameter is optional. Default is {@code null}.
*/
public final String gsCredentials;
/**
* URI to the street graph object file for reading and writing. The file is created or
* overwritten if OTP saves the graph to the file.
*
* Example: {@code "streetGraph" : "file:///Users/kelvin/otp/streetGraph.obj" }
*
* This parameter is optional. Default is {@code null}.
*/
public final URI streetGraph;
/**
* URI to the graph object file for reading and writing. The file is created or overwritten if
* OTP saves the graph to the file.
*
* Example: {@code "graph" : "gs://my-bucket/otp/graph.obj" }
*
* This parameter is optional. Default is {@code null}.
*/
public final URI graph;
/**
* Array of URIs to the open street map pbf files (the pbf format is the only one supported).
*
* Example: {@code "osm" : [ "file:///Users/kelvin/otp/norway-osm.pbf" ] }
*
* This parameter is optional.
*/
public final List osm = new ArrayList<>();
/**
* Array of URIs to elevation data files.
*
* Example: {@code "osm" : [ "file:///Users/kelvin/otp/norway-dem.tif" ] }
*
* This parameter is optional.
*/
public final List dem = new ArrayList<>();
/**
* Array of URIs to GTFS data files .
*
* Example: {@code "transit" : [ "file:///Users/kelvin/otp/gtfs.zip", "gs://my-bucket/gtfs.zip" ]" }
*
* This parameter is optional.
*/
@NotNull
public final List gtfs = new ArrayList<>();
/**
* Array of URIs to Netex data files.
*
* Example: {@code "transit" : [ "file:///Users/kelvin/otp/netex.zip", "gs://my-bucket/netex.zip" ]" }
*
* This parameter is optional.
*/
@NotNull
public final List netex = new ArrayList<>();
/**
* URI to the directory where the graph build report should be written to. The html report is
* written into this directory. If the directory exist, any existing files are deleted.
* If it does not exist, it is created.
*
* Example: {@code "osm" : "file:///Users/kelvin/otp/buildReport" }
*
* This parameter is optional. Default is {@code null} in witch case the report is skipped.
*/
public final URI buildReportDir;
/**
* Configure patterns for auto-detection of input files in the local base directory. Resolving
* input files is only provided for files in the base directory not for any external
* resources.
*/
public final LocalFilenamePatterns localFileNamePatterns;
StorageConfig(NodeAdapter config) {
this.gsCredentials = config.asText("gsCredentials",null);
this.graph = config.asUri("graph", null);
this.streetGraph = config.asUri("streetGraph", null);
this.osm.addAll(config.asUris("osm"));
this.dem.addAll(config.asUris("dem"));
this.gtfs.addAll(config.asUris("gtfs"));
this.netex.addAll(config.asUris("netex"));
this.buildReportDir = config.asUri("buildReportDir", null);
this.localFileNamePatterns = new LocalFilenamePatterns(config.path("localFileNamePatterns"));
}
/**
* Configure patterns for auto-detection of input files in the local base directory. Resolving
* input files is only provided for files in the base directory not for any external
* resources.
*/
public static class LocalFilenamePatterns {
/**
* Patterns for matching GTFS zip-files or directories. If the filename contains the
* given pattern it is considered a match. Any legal Java Regular expression is allowed.
*
* This parameter is optional.
*
* Default: {@code (?i)gtfs} - Match all filenames that contain "gtfs". The default pattern
* is NOT case sensitive.
*/
public final Pattern gtfs;
/**
* Patterns for matching NeTEx zip files or directories. If the filename contains the
* given pattern it is considered a match. Any legal Java Regular expression is allowed.
*
* This parameter is optional.
*
* Default: {@code (?i)netex} - Match all filenames that contain "netex". The default
* pattern is NOT case sensitive.
*/
public final Pattern netex;
/**
* Pattern for matching Open Street Map input files. If the filename contains the
* given pattern it is considered a match. Any legal Java Regular expression is allowed.
*
* This parameter is optional.
*
* Default: {@code (?i)(.pbf|.osm|.osm.xml)$} - Match all filenames that ends with suffix
* {@code .pbf}, {@code .osm} or {@code .osm.xml}. The default pattern is NOT case
* sensitive.
*/
public final Pattern osm;
/**
* Pattern for matching elevation DEM files. If the filename contains the
* given pattern it is considered a match. Any legal Java Regular expression is allowed.
*
* This parameter is optional.
*
* Default: {@code (?i).tiff?$} - Match all filenames that ends with suffix
* {@code .tif} or {@code .tiff}. The default pattern is NOT case sensitive.
*/
public final Pattern dem;
public LocalFilenamePatterns(NodeAdapter c) {
this.gtfs = c.asPattern("gtfs", DEFAULT_GTFS_PATTERN);
this.netex = c.asPattern("netex", DEFAULT_NETEX_PATTERN);
this.osm = c.asPattern("osm", DEFAULT_OSM_PATTERN);
this.dem = c.asPattern("dem", DEFAULT_DEM_PATTERN);
}
}
}