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

Class AbstractScriptFileWatcher

java.lang.Object

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

All Implemented Interfaces:

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

@NonNullByDefault
public abstract class AbstractScriptFileWatcher
extends Object
implements WatchService.WatchEventListener, 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 and 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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractScriptFileWatcher(WatchService watchService, ScriptEngineManager manager, ReadyService readyService, StartLevelService startLevelService, String fileDirectory, boolean watchSubDirectories)

Method Summary

Modifier and Type	Method	Description
void	activate()
void	deactivate()
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. for testing)
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 Path	getWatchPath()	Get the base path that is used by this ScriptFileWatcher
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.
void	processWatchEvent(WatchService.Kind kind, Path fullPath)	Notify Listener about watch event

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

protected AbstractScriptFileWatcher(WatchService watchService,
 ScriptEngineManager manager,
 ReadyService readyService,
 StartLevelService startLevelService,
 String fileDirectory,
 boolean watchSubDirectories)

Method Details

getWatchPath

protected Path getWatchPath()

Get the base path that is used by this ScriptFileWatcher

Returns:

the Path used

getScheduler

protected ScheduledExecutorService getScheduler()

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

Returns:

a ScheduledExecutorService

activate

public void activate()

deactivate

public void deactivate()

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

processWatchEvent

public void processWatchEvent(WatchService.Kind kind,
 Path fullPath)

Description copied from interface: WatchService.WatchEventListener

Notify Listener about watch event

Specified by:

processWatchEvent in interface WatchService.WatchEventListener

Parameters:

kind - the WatchService.Kind of this event

fullPath - the absolute path of the file associated with this event

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

Parameters:

readyMarker -

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

Parameters:

readyMarker -

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