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

  • 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