org.elasticsearch.env

Class Environment

java.lang.Object

org.elasticsearch.env.Environment

public class Environment
extends Object

The environment of where things exists.

Constructor Summary

Constructors

Constructor and Description
Environment(Settings settings)

Method Summary

Methods

Modifier and Type	Method and Description
Path	binFile()
Path	configFile() The config location.
Path[]	dataFiles() The data location.
Path[]	dataWithClusterFiles() The data location with the cluster name as a sub directory.
static FileStore	getFileStore(Path path) Looks up the filestore associated with a Path.
static boolean	isWritable(Path path) Returns true if the path is writable.
Path	libFile()
Path	logsFile()
Path	modulesFile()
Path	pidFile() The PID file location (can be null if no PID file is configured)
Path	pluginsFile()
Path[]	repoFiles() The shared filesystem repo locations.
Path	resolveRepoFile(String location) Resolves the specified location against the list of configured repository roots If the specified location doesn't match any of the roots, returns null.
URL	resolveRepoURL(URL url) Checks if the specified URL is pointing to the local file system and if it does, resolves the specified url against the list of configured repository roots If the specified url doesn't match any of the roots, returns null.
Path	scriptsFile() Location of on-disk scripts
Settings	settings() The settings used to build this environment.
Path	sharedDataFile() The shared data location
Path	tmpFile() Path to the default temp directory used by the JDK

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Environment

public Environment(Settings settings)

Method Detail

settings

public Settings settings()

The settings used to build this environment.

dataFiles

public Path[] dataFiles()

The data location.

sharedDataFile

public Path sharedDataFile()

The shared data location

dataWithClusterFiles

public Path[] dataWithClusterFiles()

The data location with the cluster name as a sub directory.

repoFiles

public Path[] repoFiles()

The shared filesystem repo locations.

resolveRepoFile

public Path resolveRepoFile(String location)

Resolves the specified location against the list of configured repository roots If the specified location doesn't match any of the roots, returns null.

resolveRepoURL

public URL resolveRepoURL(URL url)

Checks if the specified URL is pointing to the local file system and if it does, resolves the specified url against the list of configured repository roots If the specified url doesn't match any of the roots, returns null.

configFile

public Path configFile()

The config location.

scriptsFile

public Path scriptsFile()

Location of on-disk scripts

pluginsFile

public Path pluginsFile()

binFile

public Path binFile()

libFile

public Path libFile()

modulesFile

public Path modulesFile()

logsFile

public Path logsFile()

pidFile

public Path pidFile()

The PID file location (can be null if no PID file is configured)

tmpFile

public Path tmpFile()

Path to the default temp directory used by the JDK

getFileStore

public static FileStore getFileStore(Path path)
                              throws IOException

Looks up the filestore associated with a Path.

This is an enhanced version of Files.getFileStore(Path):

• On *nix systems, the store returned for the root filesystem will contain the actual filesystem type (e.g. ext4) instead of rootfs.
• On some systems, the custom attribute lucene:spins is supported via the FileStore.getAttribute(String) method.
• Only requires the security permissions of Files.getFileStore(Path), no permissions to the actual mount point are required.
• Exception handling has the same semantics as Files.getFileStore(Path).
• Works around https://bugs.openjdk.java.net/browse/JDK-8034057.
• Gives a better exception when filestore cannot be retrieved from inside a FreeBSD jail.

Throws:

IOException

isWritable

public static boolean isWritable(Path path)
                          throws IOException

Returns true if the path is writable. Acts just like Files.isWritable(Path), except won't falsely return false for paths on SUBST'd drive letters See https://bugs.openjdk.java.net/browse/JDK-8034057 Note this will set the file modification time (to its already-set value) to test access.

Throws:

IOException