Package org.elasticsearch.watcher

Class ResourceWatcherService

java.lang.Object

org.elasticsearch.common.component.AbstractLifecycleComponent

org.elasticsearch.watcher.ResourceWatcherService

All Implemented Interfaces:

Closeable, AutoCloseable, LifecycleComponent, Releasable

public class ResourceWatcherService
extends AbstractLifecycleComponent

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 resource.reload.interval setting, which defaults to 60s. The service can be disabled by setting resource.reload.enabled setting to false.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ResourceWatcherService.Frequency

Field Summary

Fields

Modifier and Type	Field	Description
static Setting<Boolean>	ENABLED
static Setting<TimeValue>	RELOAD_INTERVAL_HIGH
static Setting<TimeValue>	RELOAD_INTERVAL_LOW
static Setting<TimeValue>	RELOAD_INTERVAL_MEDIUM

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

lifecycle

Constructor Summary

Constructors

Constructor	Description
ResourceWatcherService(Settings settings, ThreadPool threadPool)

Method Summary

Modifier and Type	Method	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 java.lang.Object

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

Field Detail

ENABLED

public static final Setting<Boolean> ENABLED

RELOAD_INTERVAL_HIGH

public static final Setting<TimeValue> RELOAD_INTERVAL_HIGH

RELOAD_INTERVAL_MEDIUM

public static final Setting<TimeValue> RELOAD_INTERVAL_MEDIUM

RELOAD_INTERVAL_LOW

public static final Setting<TimeValue> RELOAD_INTERVAL_LOW

Constructor Detail

ResourceWatcherService

@Inject
public ResourceWatcherService(Settings settings,
                              ThreadPool threadPool)

Method Detail

doStart

protected void doStart()

Specified by:

doStart in class AbstractLifecycleComponent

doStop

protected void doStop()

Specified by:

doStop in class AbstractLifecycleComponent

doClose

protected void doClose()

Specified by:

doClose in class AbstractLifecycleComponent

add

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

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

Throws:

IOException

add

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

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

Throws:

IOException

notifyNow

public void notifyNow()

notifyNow

public void notifyNow(ResourceWatcherService.Frequency frequency)