com.arangodb.shaded.vertx.core.file.FileSystemOptions Maven / Gradle / Ivy
/*
* Copyright (c) 2011-2019 Contributors to the Eclipse Foundation
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
* which is available at https://www.apache.org/licenses/LICENSE-2.0.
*
* SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
*/
package com.arangodb.shaded.vertx.core.file;
import com.arangodb.shaded.vertx.codegen.annotations.DataObject;
import com.arangodb.shaded.vertx.core.file.impl.FileResolverImpl;
import com.arangodb.shaded.vertx.core.json.JsonObject;
import java.io.File;
/**
* Vert.x file system base configuration, this class can be extended by provider implementations to configure
* those specific implementations.
*/
@DataObject(generateConverter = true, publicConverter = false)
public class FileSystemOptions {
/**
* The default behavior for caching files for class path resolution = {@code false} if and only if the system property {@code "vertx.disableFileCaching"} exists and is set to the string {@code "false"}
*/
public static final boolean DEFAULT_FILE_CACHING_ENABLED = !Boolean.getBoolean(FileResolverImpl.DISABLE_FILE_CACHING_PROP_NAME);
/**
* The default behavior to cache or not class path resolution = {@code false} if and only if the system property {@code "vertx.disableFileCPResolving"} exists and is set to the string {@code "false"}
*/
public static final boolean DEFAULT_CLASS_PATH_RESOLVING_ENABLED = !Boolean.getBoolean(FileResolverImpl.DISABLE_CP_RESOLVING_PROP_NAME);
// get the system default temp dir location (can be overriden by using the standard java system property)
// if not present default to the process start CWD
private static final String TMPDIR = System.getProperty("java.io.tmpdir", ".");
private static final String DEFAULT_CACHE_DIR_BASE = "vertx-cache";
/**
* The default file caching dir. If the system property {@code "vertx.cacheDirBase"} is set, then this is the value
* If not, then the system property {@code java.io.tmpdir} is taken or {code .} if not set. suffixed with {@code vertx-cache}.
*/
public static final String DEFAULT_FILE_CACHING_DIR = System.getProperty(FileResolverImpl.CACHE_DIR_BASE_PROP_NAME, TMPDIR + File.separator + DEFAULT_CACHE_DIR_BASE);
private boolean classPathResolvingEnabled = DEFAULT_CLASS_PATH_RESOLVING_ENABLED;
private boolean fileCachingEnabled = DEFAULT_FILE_CACHING_ENABLED;
private String fileCacheDir = DEFAULT_FILE_CACHING_DIR;
/**
* Default constructor
*/
public FileSystemOptions() {
}
/**
* Copy constructor
*
* @param other The other {@link FileSystemOptions} to copy when creating this
*/
public FileSystemOptions(FileSystemOptions other) {
this.classPathResolvingEnabled = other.isClassPathResolvingEnabled();
this.fileCachingEnabled = other.isFileCachingEnabled();
this.fileCacheDir = other.getFileCacheDir();
}
/**
* Creates a new instance of {@link FileSystemOptions} from the JSON object. This JSOn object has (generally)
* been generated using {@link #toJson()}.
*
* @param json the json object
*/
public FileSystemOptions(JsonObject json) {
this();
FileSystemOptionsConverter.fromJson(json, this);
}
/**
* Builds a JSON object representing the current {@link FileSystemOptions}.
*
* @return the JSON representation
*/
public JsonObject toJson() {
JsonObject json = new JsonObject();
FileSystemOptionsConverter.toJson(this, json);
return json;
}
/**
* @return whether classpath resolving is enabled
*/
public boolean isClassPathResolvingEnabled() {
return this.classPathResolvingEnabled;
}
/**
* When vert.x cannot find the file on the filesystem it tries to resolve the
* file from the class path when this is set to {@code true}.
*
* @param classPathResolvingEnabled the value
* @return a reference to this, so the API can be used fluently
*/
public FileSystemOptions setClassPathResolvingEnabled(boolean classPathResolvingEnabled) {
this.classPathResolvingEnabled = classPathResolvingEnabled;
return this;
}
/**
* @return whether file caching is enabled for class path resolving
*/
public boolean isFileCachingEnabled() {
return this.fileCachingEnabled;
}
/**
* Set to {@code true} to cache files on the real file system
* when the filesystem performs class path resolving.
*
* @param fileCachingEnabled the value
* @return a reference to this, so the API can be used fluently
*/
public FileSystemOptions setFileCachingEnabled(boolean fileCachingEnabled) {
this.fileCachingEnabled = fileCachingEnabled;
return this;
}
/**
* @return the configured file cache dir
*/
public String getFileCacheDir() {
return this.fileCacheDir;
}
/**
* When vert.x reads a file that is packaged with the application it gets
* extracted to this directory first and subsequent reads will use the extracted
* file to get better IO performance.
*
* @param fileCacheDir the value
* @return a reference to this, so the API can be used fluently
*/
public FileSystemOptions setFileCacheDir(String fileCacheDir) {
this.fileCacheDir = fileCacheDir;
return this;
}
@Override
public String toString() {
return "FileSystemOptions{" +
"classPathResolvingEnabled=" + classPathResolvingEnabled +
", fileCachingEnabled=" + fileCachingEnabled +
", fileCacheDir=" + fileCacheDir +
'}';
}
}