Package org.opensearch.watcher

Class ResourceWatcherService

java.lang.Object

org.opensearch.watcher.ResourceWatcherService

All Implemented Interfaces:

Closeable, AutoCloseable

@PublicApi(since="1.0.0")
public class ResourceWatcherService
extends Object
implements Closeable

Generic resource watcher service

Other opensearch 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.

Opensearch.api:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ResourceWatcherService.Frequency	Frequency level to watch.

Field Summary

Fields

Modifier and Type	Field	Description
static final Setting<Boolean>	ENABLED
static final Setting<org.opensearch.common.unit.TimeValue>	RELOAD_INTERVAL_HIGH
static final Setting<org.opensearch.common.unit.TimeValue>	RELOAD_INTERVAL_LOW
static final Setting<org.opensearch.common.unit.TimeValue>	RELOAD_INTERVAL_MEDIUM

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
void	close()
void	notifyNow(ResourceWatcherService.Frequency frequency)

Methods inherited from class java.lang.Object

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

Field Details

ENABLED

public static final Setting<Boolean> ENABLED

RELOAD_INTERVAL_HIGH

public static final Setting<org.opensearch.common.unit.TimeValue> RELOAD_INTERVAL_HIGH

RELOAD_INTERVAL_MEDIUM

public static final Setting<org.opensearch.common.unit.TimeValue> RELOAD_INTERVAL_MEDIUM

RELOAD_INTERVAL_LOW

public static final Setting<org.opensearch.common.unit.TimeValue> RELOAD_INTERVAL_LOW

Constructor Details

ResourceWatcherService

public ResourceWatcherService(Settings settings,
 ThreadPool threadPool)

Method Details

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

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(ResourceWatcherService.Frequency frequency)