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

Class ScriptFileWatcher

java.lang.Object

org.openhab.core.service.AbstractWatchService

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

All Implemented Interfaces:

DependencyTracker.DependencyChangeListener, ScriptEngineManager.FactoryChangeListener, ReadyService.ReadyTracker

@NonNullByDefault
public class ScriptFileWatcher
extends AbstractWatchService
implements ReadyService.ReadyTracker, DependencyTracker.DependencyChangeListener, ScriptEngineManager.FactoryChangeListener

The ScriptFileWatcher watches a directory for files. If a new/modified file is detected, the script is read and passed to the ScriptEngineManager.

Author:

Simon Merschjohann - Initial contribution, Kai Kreuzer - improved logging and removed thread pool, Jonathan Gilbert - added dependency tracking & per-script start levels; made reusable

Field Summary

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

pathToWatch, watchQueueReader

Constructor Summary

Constructors

Constructor	Description
ScriptFileWatcher(ScriptEngineManager manager, @Nullable DependencyTracker dependencyTracker, ReadyService readyService, String fileDirectory)

Method Summary

Modifier and Type	Method	Description
void	activate()	Method to call on service activation
protected boolean	createAndLoad(ScriptFileReference ref)
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 WatchEvent.Kind<?> @Nullable []	getWatchEventKinds(@Nullable Path subDir)	Provides the WatchKeys for the registration of the directory, which will be registered in the watch service.
protected void	importFile(ScriptFileReference ref)
void	onDependencyChange(@Nullable String scriptPath)
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

Constructor Detail

ScriptFileWatcher

public ScriptFileWatcher(ScriptEngineManager manager,
                         @Nullable DependencyTracker dependencyTracker,
                         ReadyService readyService,
                         String fileDirectory)

Method Detail

deactivate

public void deactivate()

Description copied from class: AbstractWatchService

Method to call on service deactivation

Overrides:

deactivate in class AbstractWatchService

activate

public void activate()

Description copied from class: AbstractWatchService

Method to call on service activation

Overrides:

activate in class AbstractWatchService

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)

importFile

protected void importFile(ScriptFileReference ref)

createAndLoad

protected boolean createAndLoad(ScriptFileReference ref)

onDependencyChange

public void onDependencyChange(@Nullable String scriptPath)

Specified by:

onDependencyChange in interface DependencyTracker.DependencyChangeListener

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