org.rhq.scripting

Interface ScriptEngineProvider

public interface ScriptEngineProvider

This is the service interface for scripting language implementations for RHQ (loaded using the META-INF/services mechanism).

Note that the API module provides no factory class that would load the ScriptEngineProvider implementations present on the classpath. That is because for the script engine to be usable by RHQ, it needs to be initialized with a couple of dependencies that are not appropriate for the API module.

The factory is located in the rhq-script-bindings module as org.rhq.bindings.ScriptEngineFactory.

Author:

Lukas Krejci

Method Summary

Methods

Modifier and Type	Method and Description
CodeCompletion	getCodeCompletion()
ScriptEngineInitializer	getInitializer()
String	getScriptFileExtension()
String	getSupportedLanguage()

Method Detail

getSupportedLanguage

@NotNull
String getSupportedLanguage()

Returns:

the scripting language understood by this provider. This must return the same string as ScriptEngine.getFactory().getParameter(ScriptEngine.NAME) of the script engine that this provider provides (through the initializer).

getScriptFileExtension

String getScriptFileExtension()

Returns:

the file extension of files written in the language supported by this provider. The returned string is the extension without the leading dot.

getInitializer

@NotNull
ScriptEngineInitializer getInitializer()

Returns:

an implementation of ScriptEngineInitializer that can instantiate and initialize a script engine for the supported language for use with RHQ.

getCodeCompletion

@Nullable
CodeCompletion getCodeCompletion()

Returns:

a CodeCompletion implementation for the supported language or null if this provider doesn't provide one.