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

Class AbstractScriptDependencyTracker

java.lang.Object

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

All Implemented Interfaces:

ScriptDependencyTracker, WatchService.WatchEventListener

@NonNullByDefault
public abstract class AbstractScriptDependencyTracker
extends Object
implements ScriptDependencyTracker, WatchService.WatchEventListener

The AbstractScriptDependencyTracker tracks dependencies between scripts and reloads dependees It needs to be sub-classed for each ScriptEngineFactory that wants to support dependency tracking

Author:

Jonathan Gilbert - Initial contribution, Jan N. Klug - Refactored to OSGi service

Nested Class Summary

Nested classes/interfaces inherited from interface org.openhab.core.automation.module.script.ScriptDependencyTracker

ScriptDependencyTracker.Listener

Field Summary

Fields

Modifier and Type	Field	Description
protected final Path	libraryPath

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractScriptDependencyTracker(WatchService watchService, String fileDirectory)

Method Summary

Modifier and Type	Method	Description
void	addChangeTracker(ScriptDependencyTracker.Listener listener)	Add a dependency change listener Since this is done via service injection and OSGi annotations are not inherited it is required that subclasses expose this method with proper annotation
void	deactivate()
protected void	dependencyChanged(String dependency)
Path	getLibraryPath()
Consumer<String>	getTracker(String scriptId)	Get the tracker for a given script identifier
void	processWatchEvent(WatchService.Kind kind, Path fullPath)	Notify Listener about watch event
void	removeChangeTracker(ScriptDependencyTracker.Listener listener)
void	removeTracking(String scriptId)	Remove all tracking data for a given scipt identifier
protected void	startTracking(String scriptId, String libPath)

Methods inherited from class java.lang.Object

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

Field Details

libraryPath

protected final Path libraryPath

Constructor Details

AbstractScriptDependencyTracker

protected AbstractScriptDependencyTracker(WatchService watchService,
 String fileDirectory)

Method Details

deactivate

public void deactivate()

getLibraryPath

public Path getLibraryPath()

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

dependencyChanged

protected void dependencyChanged(String dependency)

getTracker

public Consumer<String> getTracker(String scriptId)

Description copied from interface: ScriptDependencyTracker

Get the tracker for a given script identifier

Specified by:

getTracker in interface ScriptDependencyTracker

Parameters:

scriptId - the unique id of the script

Returns:

a Consumer<String> that accepts a the path to a dependency

removeTracking

public void removeTracking(String scriptId)

Description copied from interface: ScriptDependencyTracker

Remove all tracking data for a given scipt identifier

Specified by:

removeTracking in interface ScriptDependencyTracker

Parameters:

scriptId - the uniwue id of the script

startTracking

protected void startTracking(String scriptId,
 String libPath)

addChangeTracker

public void addChangeTracker(ScriptDependencyTracker.Listener listener)

Add a dependency change listener Since this is done via service injection and OSGi annotations are not inherited it is required that subclasses expose this method with proper annotation

Parameters:

listener - the dependency change listener

removeChangeTracker

public void removeChangeTracker(ScriptDependencyTracker.Listener listener)