com.prosyst.mprm.backend.rules.spi

Interface ScriptService

All Known Subinterfaces:

StateVariableHistoryManager

public interface ScriptService

Could be inherited by interfaces wishing to provide functionality dedicated to be used via mPRM Scripts. In order to provide scripting functionality, modules should register their original interface in the OSGi Service registry of mPRM backend, using the SCRIPT_ALIAS as property name and value pointing to the script 'alias' under which their service is wished to be bound.
Example: interface MyScriptService extends ScriptService { public void String hello(); } interface MyScriptServiceImpl implements MyScriptService { public void String hello() { return "Hello from MyScriptService!"; } } (registering as service): BundleContex bc; Dictionary props = new Hashtable(1); props.put(ScriptService.SCRIPT_ALIAS, "myService"); bc.registerService(MyScriptService.class.getName(), new MyScriptServiceImpl(), props); (Usage in groovy scripts): myService.hello() Once registered, the service is granted so called call back to the system init(ScriptEngineCallback), through which the Script Service can get addition context information of each method executions as well as to push back to the system results to asynchronous methods.

Asynchronous methods can be defined using a AsyncResult as last method argument. Asynchronous methods may return/exit without completing fully their intended job and apply their completion result at a later moment via this AsyncResult argument. Note, that AsyncResult objects are not necessarily needed to be kept in memory by the Script Service implementations:, they can be restored by id via the ScriptEngineCallback (granted through the init(ScriptEngineCallback) method) at any time. See: AsyncResult.getId() and ScriptEngineCallback.getAsyncResult(String).

By default asynchronous methods are reported to the user as a partial sub-result of the whole script execution status, while synchronous methods are not reported as partial result. To override this behavior, the Script Service implementation may use the ReportToUser annotation placed:

before the service class declaration to override the behavior for all service methods, before concrete method declaration to override the behavior for this exact method.