Module org.elasticsearch.server

Package org.elasticsearch.common.file

Class MasterNodeFileWatchingService

java.lang.Object

org.elasticsearch.common.component.AbstractLifecycleComponent

org.elasticsearch.common.file.AbstractFileWatchingService

org.elasticsearch.common.file.MasterNodeFileWatchingService

All Implemented Interfaces:

Closeable, AutoCloseable, ClusterStateListener, LifecycleComponent, Releasable

Direct Known Subclasses:

FileSettingsService

public abstract class MasterNodeFileWatchingService
extends AbstractFileWatchingService
implements ClusterStateListener

Field Summary

Fields inherited from class org.elasticsearch.common.component.AbstractLifecycleComponent

lifecycle

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MasterNodeFileWatchingService(ClusterService clusterService, Path watchedFile)

Method Summary

Modifier and Type	Method	Description
final void	clusterChanged(ClusterChangedEvent event)	Called when cluster state changes.
protected void	doStart()	Start this component.
protected void	doStop()	Stop this component.
protected boolean	filesExists(Path path)
protected boolean	filesIsDirectory(Path path)
protected Stream<Path>	filesList(Path dir)
protected InputStream	filesNewInputStream(Path path)
protected <A extends BasicFileAttributes> A	filesReadAttributes(Path path, Class<A> clazz)
protected Path	filesSetLastModifiedTime(Path path, FileTime time)
protected boolean	shouldRefreshFileState(ClusterState clusterState)	There may be an indication in cluster state that the file we are watching should be re-processed: for example, after cluster state has been restored from a snapshot.

Methods inherited from class org.elasticsearch.common.file.AbstractFileWatchingService

addFileChangedListener, doClose, processFileChanges, processFileOnServiceStart, processInitialFileMissing, startWatcher, stopWatcher, watchedFile, watchedFileDir, watcherThread, watching

Methods inherited from class org.elasticsearch.common.component.AbstractLifecycleComponent

addLifecycleListener, close, lifecycleState, start, stop

Methods inherited from class java.lang.Object

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

Constructor Details

MasterNodeFileWatchingService

protected MasterNodeFileWatchingService(ClusterService clusterService,
 Path watchedFile)

Method Details

doStart

protected void doStart()

Description copied from class: AbstractLifecycleComponent

Start 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.

Overrides:

doStart in class AbstractFileWatchingService

doStop

protected void doStop()

Description copied from class: AbstractLifecycleComponent

Stop this component. Typically that means doing the reverse of whatever AbstractLifecycleComponent.doStart() does.

This method is called while synchronized on AbstractLifecycleComponent.lifecycle. It is only called once in the lifetime of a component, after calling AbstractLifecycleComponent.doStart(), although it will not be called at all if this component did not successfully start.

Overrides:

doStop in class AbstractFileWatchingService

clusterChanged

public final void clusterChanged(ClusterChangedEvent event)

Description copied from interface: ClusterStateListener

Called when cluster state changes.

Cluster states are applied one-by-one which means they can be a performance bottleneck. Implementations of this method should therefore be fast, so please consider forking work into the background rather than doing everything inline.

Specified by:

clusterChanged in interface ClusterStateListener

shouldRefreshFileState

protected boolean shouldRefreshFileState(ClusterState clusterState)

There may be an indication in cluster state that the file we are watching should be re-processed: for example, after cluster state has been restored from a snapshot. By default, we do nothing, but this method should be overridden if different behavior is desired.

Parameters:

clusterState - State of the cluster

Returns:

false, by default

filesExists

protected boolean filesExists(Path path)

Specified by:

filesExists in class AbstractFileWatchingService

filesIsDirectory

protected boolean filesIsDirectory(Path path)

Specified by:

filesIsDirectory in class AbstractFileWatchingService

filesReadAttributes

protected <A extends BasicFileAttributes> A filesReadAttributes(Path path,
 Class<A> clazz)
                                                         throws IOException

Specified by:

filesReadAttributes in class AbstractFileWatchingService

Throws:

IOException

filesList

protected Stream<Path> filesList(Path dir)
                          throws IOException

Specified by:

filesList in class AbstractFileWatchingService

Throws:

IOException

filesSetLastModifiedTime

protected Path filesSetLastModifiedTime(Path path,
 FileTime time)
                                 throws IOException

Specified by:

filesSetLastModifiedTime in class AbstractFileWatchingService

Throws:

IOException

filesNewInputStream

protected InputStream filesNewInputStream(Path path)
                                   throws IOException

Specified by:

filesNewInputStream in class AbstractFileWatchingService

Throws:

IOException