org.elasticsearch.watcher

Class ResourceWatcherService

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.common.component.AbstractLifecycleComponent<ResourceWatcherService>

org.elasticsearch.watcher.ResourceWatcherService

All Implemented Interfaces:

AutoCloseable, LifecycleComponent<ResourceWatcherService>, Releasable

public class ResourceWatcherService
extends AbstractLifecycleComponent<ResourceWatcherService>

Generic resource watcher service Other elasticsearch services can register their resource watchers with this service using add(ResourceWatcher) method. This service will call ResourceWatcher.checkAndNotify() method of all registered watcher periodically. The frequency of checks can be specified using watcher.interval setting, which defaults to 60s. The service can be disabled by setting watcher.enabled setting to false.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResourceWatcherService.Frequency

Field Summary

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

lifecycle

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

componentSettings, logger, settings

Constructor Summary

Constructors

Constructor and Description
ResourceWatcherService(Settings settings, ThreadPool threadPool)

Method Summary

Modifier and Type	Method and Description
<W extends ResourceWatcher> WatcherHandle<W>	add(W watcher) Register new resource watcher that will be checked in default MEDIUM frequency
<W extends ResourceWatcher> WatcherHandle<W>	add(W watcher, ResourceWatcherService.Frequency frequency) Register new resource watcher that will be checked in the given frequency
protected void	doClose()
protected void	doStart()
protected void	doStop()
void	notifyNow()
void	notifyNow(ResourceWatcherService.Frequency frequency)

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

addLifecycleListener, close, lifecycleState, removeLifecycleListener, start, stop

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

nodeName

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceWatcherService

@Inject
public ResourceWatcherService(Settings settings,
                                      ThreadPool threadPool)

Method Detail

doStart

protected void doStart()
                throws ElasticsearchException

Specified by:

doStart in class AbstractLifecycleComponent<ResourceWatcherService>

Throws:

ElasticsearchException

doStop

protected void doStop()
               throws ElasticsearchException

Specified by:

doStop in class AbstractLifecycleComponent<ResourceWatcherService>

Throws:

ElasticsearchException

doClose

protected void doClose()
                throws ElasticsearchException

Specified by:

doClose in class AbstractLifecycleComponent<ResourceWatcherService>

Throws:

ElasticsearchException

add

public <W extends ResourceWatcher> WatcherHandle<W> add(W watcher)

Register new resource watcher that will be checked in default MEDIUM frequency

add

public <W extends ResourceWatcher> WatcherHandle<W> add(W watcher,
                                                        ResourceWatcherService.Frequency frequency)

Register new resource watcher that will be checked in the given frequency

notifyNow

public void notifyNow()

notifyNow

public void notifyNow(ResourceWatcherService.Frequency frequency)