Class AbstractFileWatchingService
- All Implemented Interfaces:
Closeable,AutoCloseable,LifecycleComponent,Releasable
- Direct Known Subclasses:
MasterNodeFileWatchingService
A file watching service watches for changes to a particular directory. There are two assumptions about the file structure:
- The directory may or may not exist.
- The directory's parent directory must always exist.
For example, if the watched directory is /usr/elastic/elasticsearch/conf/special,
then /usr/elastic/elasticsearch/conf must exist, but special and any files in that directory
may be created, updated, or deleted during runtime.
What this class does not do is define what should happen after the directory changes.
An implementation class should override processFileChanges(Path) to define
the correct behavior.
-
Field Summary
Fields inherited from class org.elasticsearch.common.component.AbstractLifecycleComponent
lifecycle -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected final voiddoClose()Close this component.protected voiddoStart()Start this component.protected voiddoStop()Stop this component.protected abstract booleanfilesExists(Path path) protected abstract booleanfilesIsDirectory(Path path) protected abstract booleanfilesIsSymbolicLink(Path path) protected abstract InputStreamfilesNewInputStream(Path path) protected abstract <A extends BasicFileAttributes>
AfilesReadAttributes(Path path, Class<A> clazz) protected abstract PathfilesSetLastModifiedTime(Path path, FileTime time) protected voidonProcessFileChangesException(Path file, Exception e) Called for checked exceptions only.protected abstract voidprocessFileChanges(Path file) Any implementation of this class must implement this method in order to define what happens once a file in the watched directory changes.protected voidDefaults to genericprocessFileChanges(Path)behavior.protected abstract voidprotected final voidprotected final voidfinal Pathprotected final voidfinal booleanwatching()Methods inherited from class org.elasticsearch.common.component.AbstractLifecycleComponent
addLifecycleListener, close, lifecycleState, start, stop
-
Constructor Details
-
AbstractFileWatchingService
-
-
Method Details
-
processFileChanges
protected abstract void processFileChanges(Path file) throws InterruptedException, ExecutionException, IOException Any implementation of this class must implement this method in order to define what happens once a file in the watched directory changes.- Parameters:
file- the full path of the file that has changed inside the watched directory- Throws:
IOException- if there is an error reading the file itselfExecutionException- if there is an issue while applying the changes from the fileInterruptedException- if the file processing is interrupted by another thread.
-
processInitialFilesMissing
protected abstract void processInitialFilesMissing() throws InterruptedException, ExecutionException, IOException -
processFileOnServiceStart
protected void processFileOnServiceStart(Path file) throws IOException, ExecutionException, InterruptedException Defaults to genericprocessFileChanges(Path)behavior. An implementation can override this to define different file handling when the directory is processed during initial service start. -
watchedFileDir
-
doStart
protected void doStart()Description copied from class:AbstractLifecycleComponentStart this component. Typically that means doing things like launching background processes and registering listeners on other components. Other components have been initialized by this point, but may not yet be started.If this method throws an exception then the startup process will fail, but this component will not be stopped before it is closed.
This method is called while synchronized on
AbstractLifecycleComponent.lifecycle. It is only called once in the lifetime of a component, although it may not be called at all if the startup process encountered some kind of fatal error, such as the failure of some other component to initialize or start.- Specified by:
doStartin classAbstractLifecycleComponent
-
doStop
protected void doStop()Description copied from class:AbstractLifecycleComponentStop this component. Typically that means doing the reverse of whateverAbstractLifecycleComponent.doStart()does.This method is called while synchronized on
AbstractLifecycleComponent.lifecycle. It is only called once in the lifetime of a component, after callingAbstractLifecycleComponent.doStart(), although it will not be called at all if this component did not successfully start.- Specified by:
doStopin classAbstractLifecycleComponent
-
doClose
protected final void doClose()Description copied from class:AbstractLifecycleComponentClose this component. Typically that means doing the reverse of whatever happened during initialization, such as releasing resources acquired there.This method is called while synchronized on
AbstractLifecycleComponent.lifecycle. It is called once in the lifetime of a component. If the component was started then it will be stopped before it is closed, and once it is closed it will not be started or stopped.- Specified by:
doClosein classAbstractLifecycleComponent
-
watching
public final boolean watching() -
startWatcher
protected final void startWatcher() -
watcherThread
protected final void watcherThread() -
stopWatcher
protected final void stopWatcher() -
onProcessFileChangesException
Called for checked exceptions only. -
filesExists
-
filesIsDirectory
-
filesIsSymbolicLink
-
filesReadAttributes
protected abstract <A extends BasicFileAttributes> A filesReadAttributes(Path path, Class<A> clazz) throws IOException - Throws:
IOException
-
filesList
- Throws:
IOException
-
filesSetLastModifiedTime
- Throws:
IOException
-
filesNewInputStream
- Throws:
IOException
-