org.apache.nifi.rules.engine.script

Class ScriptedRulesEngine

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.controller.AbstractControllerService

org.apache.nifi.script.AbstractScriptedControllerService

org.apache.nifi.rules.engine.script.ScriptedRulesEngine

All Implemented Interfaces:

ConfigurableComponent, ControllerService, RulesEngineService

@Tags(value={"rules","rules engine","script","invoke","groovy","python","jython","jruby","ruby","javascript","js","lua","luaj"})
 @CapabilityDescription(value="Allows the user to provide a scripted RulesEngineService for custom firing of rules depending on the supplied facts. The script must set a variable \'rulesEngine\' to an implementation of RulesEngineService.")
 @Restricted(restrictions=@Restriction(requiredPermission=EXECUTE_CODE,explanation="Provides operator the ability to execute arbitrary code assuming all permissions that NiFi has."))
public class ScriptedRulesEngine
extends AbstractScriptedControllerService
implements RulesEngineService

Field Summary

Fields

Modifier and Type	Field and Description
protected AtomicReference<RulesEngineService>	rulesEngine

Fields inherited from class org.apache.nifi.script.AbstractScriptedControllerService

configurationContext, scriptEngine, scriptingComponentHelper, scriptNeedsReload, validationResults

Constructor Summary

Constructors

Constructor and Description
ScriptedRulesEngine()

Method Summary

Modifier and Type	Method and Description
List<Action>	fireRules(Map<String,Object> facts)
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors() Returns a list of property descriptors supported by this processor.
void	onEnabled(ConfigurationContext context)
protected boolean	reloadScript(String scriptBody) Reloads the script RulesEngineService.
void	setup()

Methods inherited from class org.apache.nifi.script.AbstractScriptedControllerService

customValidate, getSupportedDynamicPropertyDescriptor, onPropertyModified, reloadScriptBody, reloadScriptFile

Methods inherited from class org.apache.nifi.controller.AbstractControllerService

abstractClearConfigContext, abstractStoreConfigContext, disabled, enabled, getConfigurationContext, getControllerServiceLookup, getIdentifier, getLogger, getNodeTypeProvider, getProperty, getStateManager, init, initialize, isEnabled

Methods inherited from class org.apache.nifi.components.AbstractConfigurableComponent

equals, getPropertyDescriptor, getPropertyDescriptors, hashCode, toString, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.nifi.controller.ControllerService

initialize

Methods inherited from interface org.apache.nifi.components.ConfigurableComponent

getIdentifier, getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

rulesEngine

protected final AtomicReference<RulesEngineService> rulesEngine

Constructor Detail

ScriptedRulesEngine

public ScriptedRulesEngine()

Method Detail

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Returns a list of property descriptors supported by this processor. The list always includes properties such as script engine name, script file name, script body name, script arguments, and an external module path. If the scripted processor also defines supported properties, those are added to the list as well.

Overrides:

getSupportedPropertyDescriptors in class AbstractScriptedControllerService

Returns:

a List of PropertyDescriptor objects supported by this processor

setup

public void setup()

Specified by:

setup in class AbstractScriptedControllerService

reloadScript

protected boolean reloadScript(String scriptBody)

Reloads the script RulesEngineService. This must be called within the lock.

Specified by:

reloadScript in class AbstractScriptedControllerService

Parameters:

scriptBody - An input stream associated with the script content

Returns:

Whether the script was successfully reloaded

onEnabled

@OnEnabled
public void onEnabled(ConfigurationContext context)

Overrides:

onEnabled in class AbstractScriptedControllerService

fireRules

public List<Action> fireRules(Map<String,Object> facts)

Specified by:

fireRules in interface RulesEngineService