Package org.openhab.core.automation.module.script.rulesupport.loader

Class AbstractScriptFileWatcher

java.lang.Object

org.openhab.core.service.AbstractWatchService

org.openhab.core.automation.module.script.rulesupport.loader.AbstractScriptFileWatcher

All Implemented Interfaces:

ScriptFileWatcher, ScriptDependencyTracker.Listener, ScriptEngineManager.FactoryChangeListener, ReadyService.ReadyTracker

@NonNullByDefault
public abstract class AbstractScriptFileWatcher
extends AbstractWatchService
implements ReadyService.ReadyTracker, ScriptDependencyTracker.Listener, ScriptEngineManager.FactoryChangeListener, ScriptFileWatcher

The AbstractScriptFileWatcher is default implementation for watching a directory for files. If a new/modified file is detected, the script is read and passed to the ScriptEngineManager. It needs to be sub-classed for actual use.

Author:

Simon Merschjohann - Initial contribution, Kai Kreuzer - improved logging and removed thread pool, Jonathan Gilbert - added dependency tracking & per-script start levels; made reusable, Jan N. Klug - Refactored dependency tracking to script engine factories

Field Summary

Fields

Modifier and Type	Field	Description
protected ScheduledExecutorService	scheduler

Fields inherited from class org.openhab.core.service.AbstractWatchService

pathToWatch, watchQueueReader

Constructor Summary

Constructors

Constructor	Description
AbstractScriptFileWatcher(ScriptEngineManager manager, ReadyService readyService, StartLevelService startLevelService, String fileDirectory)

Method Summary

Modifier and Type	Method	Description
void	activate()	Method to call on service activation
void	deactivate()	Method to call on service deactivation
void	factoryAdded(@Nullable String scriptType)	Called by the ScriptEngineManager when a ScriptEngineFactory is added
void	factoryRemoved(@Nullable String scriptType)	Called by the ScriptEngineManager when a ScriptEngineFactory is removed
protected ScheduledExecutorService	getScheduler()	Can be overridden by subclasses (e.g.
protected Optional<String>	getScriptType(Path scriptFilePath)	Get the scriptType (file-extension or MIME-type) for a given file
protected int	getStartLevel(Path scriptFilePath)	Gets the individual start level for a given file
protected WatchEvent.Kind<?> @Nullable []	getWatchEventKinds(@Nullable Path subDir)	Provides the WatchKeys for the registration of the directory, which will be registered in the watch service.
CompletableFuture<@Nullable Void>	ifInitialized()	Returns a CompletableFuture<Void> that completes when the ScriptFileWatcher has completed it's initial loading of files.
void	onDependencyChange(String scriptIdentifier)	Called by the dependency tracker when a registered dependency changes
void	onReadyMarkerAdded(ReadyMarker readyMarker)	Gets called when a new ReadyMarker was registered as being "ready".
void	onReadyMarkerRemoved(ReadyMarker readyMarker)	Gets called when a ReadyMarker was unregistered.
protected void	processWatchEvent(@Nullable WatchEvent<?> event, @Nullable WatchEvent.Kind<?> kind, @Nullable Path path)	Processes the given watch event.
protected boolean	watchSubDirectories()	Determines whether the subdirectories of the source path (determined by the AbstractWatchService.getSourcePath()) will be watched or not.

Methods inherited from class org.openhab.core.service.AbstractWatchService

changeWatchDirectory, getSourcePath

Methods inherited from class java.lang.Object

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

Field Details

scheduler

protected ScheduledExecutorService scheduler

Constructor Details

AbstractScriptFileWatcher

public AbstractScriptFileWatcher(ScriptEngineManager manager,
 ReadyService readyService,
 StartLevelService startLevelService,
 String fileDirectory)

Method Details

activate

public void activate()

Description copied from class: AbstractWatchService

Method to call on service activation

Overrides:

activate in class AbstractWatchService

getScheduler

protected ScheduledExecutorService getScheduler()

Can be overridden by subclasses (e.g. for testing)

Returns:

a ScheduledExecutorService

deactivate

public void deactivate()

Description copied from class: AbstractWatchService

Method to call on service deactivation

Overrides:

deactivate in class AbstractWatchService

ifInitialized

public CompletableFuture<@Nullable Void> ifInitialized()

Description copied from interface: ScriptFileWatcher

Returns a CompletableFuture<Void> that completes when the ScriptFileWatcher has completed it's initial loading of files.

Specified by:

ifInitialized in interface ScriptFileWatcher

Returns:

the CompletableFuture

getScriptType

protected Optional<String> getScriptType(Path scriptFilePath)

Get the scriptType (file-extension or MIME-type) for a given file

The scriptType is determined by the file extension. The extensions in EXCLUDED_FILE_EXTENSIONS are ignored. Implementations should override this method if they provide a MIME-type instead of the file extension.

Parameters:

scriptFilePath - the Path to the script

Returns:

an Optional<String> containing the script type

getStartLevel

protected int getStartLevel(Path scriptFilePath)

Gets the individual start level for a given file

The start level is derived from the name and location of the file by START_LEVEL_PATTERNS. If no match is found, StartLevelService.STARTLEVEL_RULEENGINE is used.

Parameters:

scriptFilePath - the Path to the script

Returns:

the start level for this script

watchSubDirectories

protected boolean watchSubDirectories()

Description copied from class: AbstractWatchService

Determines whether the subdirectories of the source path (determined by the AbstractWatchService.getSourcePath()) will be watched or not.

Specified by:

watchSubDirectories in class AbstractWatchService

Returns:

true if the subdirectories will be watched and false if only the source path (determined by the AbstractWatchService.getSourcePath()) will be watched

getWatchEventKinds

protected WatchEvent.Kind<?> @Nullable [] getWatchEventKinds(@Nullable Path subDir)

Description copied from class: AbstractWatchService

Provides the WatchKeys for the registration of the directory, which will be registered in the watch service.

Specified by:

getWatchEventKinds in class AbstractWatchService

Parameters:

subDir - the directory, which will be registered in the watch service

Returns:

The array of WatchKeys for the registration or null if no registration has been done.

processWatchEvent

protected void processWatchEvent(@Nullable WatchEvent<?> event,
 @Nullable WatchEvent.Kind<?> kind,
 @Nullable Path path)

Description copied from class: AbstractWatchService

Processes the given watch event. Note that the kind and the number of the events for the watched directory is a platform dependent (see the "Platform dependencies" sections of WatchService).

Specified by:

processWatchEvent in class AbstractWatchService

Parameters:

event - the watch event to be handled

kind - the event's kind

path - the path of the event (resolved to the AbstractWatchService.pathToWatch)

onDependencyChange

public void onDependencyChange(String scriptIdentifier)

Description copied from interface: ScriptDependencyTracker.Listener

Called by the dependency tracker when a registered dependency changes

Specified by:

onDependencyChange in interface ScriptDependencyTracker.Listener

Parameters:

scriptIdentifier - the identifier of the script whose dependency changed

onReadyMarkerAdded

public void onReadyMarkerAdded(ReadyMarker readyMarker)

Description copied from interface: ReadyService.ReadyTracker

Gets called when a new ReadyMarker was registered as being "ready".

Specified by:

onReadyMarkerAdded in interface ReadyService.ReadyTracker

onReadyMarkerRemoved

public void onReadyMarkerRemoved(ReadyMarker readyMarker)

Description copied from interface: ReadyService.ReadyTracker

Gets called when a ReadyMarker was unregistered.

Specified by:

onReadyMarkerRemoved in interface ReadyService.ReadyTracker

factoryAdded

public void factoryAdded(@Nullable String scriptType)

Description copied from interface: ScriptEngineManager.FactoryChangeListener

Called by the ScriptEngineManager when a ScriptEngineFactory is added

Specified by:

factoryAdded in interface ScriptEngineManager.FactoryChangeListener

Parameters:

scriptType - the script type supported by the newly added factory

factoryRemoved

public void factoryRemoved(@Nullable String scriptType)

Description copied from interface: ScriptEngineManager.FactoryChangeListener

Called by the ScriptEngineManager when a ScriptEngineFactory is removed

Specified by:

factoryRemoved in interface ScriptEngineManager.FactoryChangeListener

Parameters:

scriptType - the script type supported by the removed factory