org.apache.nifi.rules.engine

Interface RulesEngineService

All Superinterfaces:

ConfigurableComponent, ControllerService

@Tags(value={"rules","rules-engine","facts","actions"})
 @CapabilityDescription(value="Specifies a Controller Service which hosts a rules engine, that can be used to determine actions that should be performed given provided facts.")
public interface RulesEngineService
extends ControllerService

A Controller Service that is responsible for executing rules engine against provided facts. The subsequent actions can be executed either by the rules engine or a list of Action can be returned and interrogated/executed by the caller.

Method Summary

Modifier and Type	Method and Description
List<Action>	fireRules(Map<String,Object> facts) Returns the list of Actions that should be triggered as determined by the rules engine for the the given facts.

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

initialize

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

getIdentifier, getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Method Detail

fireRules

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

Returns the list of Actions that should be triggered as determined by the rules engine for the the given facts. Action in this case have not been executed by the engine.

Parameters:

facts - a Map of key and facts values, as objects, that should be evaluated by the rules engine

Returns:

a List of Actions that should be triggered