Package org.openhab.core.automation.module.script.providersupport

Class ProviderScriptExtension

java.lang.Object

org.openhab.core.automation.module.script.providersupport.ProviderScriptExtension

All Implemented Interfaces:

ScriptExtensionProvider

@NonNullByDefault
public class ProviderScriptExtension
extends Object
implements ScriptExtensionProvider

The ProviderScriptExtension extends scripts to provide openHAB entities like items. It handles the lifecycle of these entities, ensuring that they are removed when the script is unloaded.

Author:

Florian Hotze - Initial contribution

Constructor Summary

Constructors

Constructor	Description
ProviderScriptExtension(ItemChannelLinkRegistry itemChannelLinkRegistry, ScriptedItemChannelLinkProvider itemChannelLinkProvider, ItemRegistry itemRegistry, ScriptedItemProvider itemProvider, MetadataRegistry metadataRegistry, ScriptedMetadataProvider metadataProvider, ThingRegistry thingRegistry, ScriptedThingProvider thingProvider)

Method Summary

Modifier and Type	Method	Description
@Nullable Object	get(String scriptIdentifier, String type)	This method should return an Object of the given type.
Collection<String>	getDefaultPresets()	These presets will always get injected into the ScriptEngine on instance creation.
Collection<String>	getPresets()	Returns the provided Presets which are supported by this ScriptExtensionProvider.
Collection<String>	getTypes()	Returns the supported types which can be received by the given ScriptExtensionProvider
Map<String,Object>	importPreset(String scriptIdentifier, String preset)	This method should return variables and types of the concrete type which will be injected into the ScriptEngines scope.
void	unload(String scriptIdentifier)	This will be called when the ScriptEngine will be unloaded (e.g. if the Script is deleted or updated).

Methods inherited from class java.lang.Object

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

Constructor Details

ProviderScriptExtension

public ProviderScriptExtension(ItemChannelLinkRegistry itemChannelLinkRegistry,
 ScriptedItemChannelLinkProvider itemChannelLinkProvider,
 ItemRegistry itemRegistry,
 ScriptedItemProvider itemProvider,
 MetadataRegistry metadataRegistry,
 ScriptedMetadataProvider metadataProvider,
 ThingRegistry thingRegistry,
 ScriptedThingProvider thingProvider)

Method Details

getDefaultPresets

public Collection<String> getDefaultPresets()

Description copied from interface: ScriptExtensionProvider

These presets will always get injected into the ScriptEngine on instance creation.

Specified by:

getDefaultPresets in interface ScriptExtensionProvider

Returns:

collection of presets

getPresets

public Collection<String> getPresets()

Description copied from interface: ScriptExtensionProvider

Returns the provided Presets which are supported by this ScriptExtensionProvider. Presets define imports which will be injected into the ScriptEngine if called by "importPreset".

Specified by:

getPresets in interface ScriptExtensionProvider

Returns:

provided presets

getTypes

public Collection<String> getTypes()

Description copied from interface: ScriptExtensionProvider

Returns the supported types which can be received by the given ScriptExtensionProvider

Specified by:

getTypes in interface ScriptExtensionProvider

Returns:

provided types

get

public @Nullable Object get(String scriptIdentifier,
 String type)
                     throws IllegalArgumentException

Description copied from interface: ScriptExtensionProvider

This method should return an Object of the given type. Note: get can be called multiple times in the scripts use caching where appropriate.

Specified by:

get in interface ScriptExtensionProvider

Parameters:

scriptIdentifier - the identifier of the script that requests the given type

type - the type that is requested (must be part of the collection returned by the #getTypes() method

Returns:

the requested type or null

Throws:

IllegalArgumentException - if the given type does not match to one returned by the #getTypes() method

importPreset

public Map<String,Object> importPreset(String scriptIdentifier,
 String preset)

Description copied from interface: ScriptExtensionProvider

This method should return variables and types of the concrete type which will be injected into the ScriptEngines scope.

Specified by:

importPreset in interface ScriptExtensionProvider

Parameters:

scriptIdentifier - the identifier of the script that receives the preset

Returns:

the presets, must be non-null (use an empty map instead)

unload

public void unload(String scriptIdentifier)

Description copied from interface: ScriptExtensionProvider

This will be called when the ScriptEngine will be unloaded (e.g. if the Script is deleted or updated). Every Context information stored in the ScriptExtensionProvider should be removed.

Specified by:

unload in interface ScriptExtensionProvider

Parameters:

scriptIdentifier - the identifier of the script that is unloaded