Module org.elasticsearch.security

Package org.elasticsearch.xpack.security

Class EntitledFileWatcher

java.lang.Object

org.elasticsearch.watcher.AbstractResourceWatcher<FileChangesListener>

org.elasticsearch.watcher.FileWatcher

org.elasticsearch.xpack.security.EntitledFileWatcher

All Implemented Interfaces:

ResourceWatcher

public class EntitledFileWatcher
extends FileWatcher

A subclass of FileWatcher that lives in the security module.

The Elasticsearch entitlement system uses a StackWalker to determine which module is making a file-system call. FileWatcher lives in the server module and therefore cannot access paths that are marked exclusive: true for the security module (e.g. users and x-pack/users).

By overriding every protected file-I/O method here, the actual Files calls are issued from inside org.elasticsearch.security, so the entitlement check correctly attributes them to this module.

Constructor Summary

Constructors

Constructor	Description
EntitledFileWatcher(Path path)
EntitledFileWatcher(Path path, boolean checkFileContents)

Method Summary

Modifier and Type	Method	Description
protected boolean	fileExists(Path path)
protected DirectoryStream<Path>	listFiles(Path path)
protected InputStream	newInputStream(Path path)
protected BasicFileAttributes	readAttributes(Path path)

Methods inherited from class org.elasticsearch.watcher.FileWatcher

clearState, doCheckAndNotify, doInit, getPath

Methods inherited from class org.elasticsearch.watcher.AbstractResourceWatcher

addListener, checkAndNotify, init, listeners, remove

Methods inherited from class java.lang.Object

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

Constructor Details

EntitledFileWatcher

public EntitledFileWatcher(Path path)

EntitledFileWatcher

public EntitledFileWatcher(Path path,
 boolean checkFileContents)

Method Details

newInputStream

protected InputStream newInputStream(Path path)
                              throws IOException

Overrides:

newInputStream in class FileWatcher

Throws:

IOException

fileExists

protected boolean fileExists(Path path)

Overrides:

fileExists in class FileWatcher

readAttributes

protected BasicFileAttributes readAttributes(Path path)
                                      throws IOException

Overrides:

readAttributes in class FileWatcher

Throws:

IOException

listFiles

protected DirectoryStream<Path> listFiles(Path path)
                                   throws IOException

Overrides:

listFiles in class FileWatcher

Throws:

IOException