All Classes and Interfaces

Class
Description
 
An interface for accumulate external function implementations
An option to define if 'accumulate' propagates its result even when its accumulate function result is 'null'.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
A class for the belief system configuration.
An enum to enable beta node range index option.
 
 
A channel provides a mechanism to send objects from the working memory to some external process or function.
ChannelModel is a model allowing to programmatically define a Channel and wire it to a KieSession
Filters objects by class, only accepting objects of the class specified in the constructor
Annotation used to declare that a given class is not property specific
A class for the session clock configuration.
 
Batch Executor allows for the scripting of a KieSession using Commands, both the KieSession and KieSession implement this interface.
 
 
A connection is a link from one Node to another.
 
 
The context of an execution
Data transformation capabilities used by data input and data output transformation as part of BPMN2 process definition.
 
 
An enum to enable Declarative Agenda option.
 
 
 
 
 
Annotation used to decorate a field or class with a description.
 
An option to define if the KieSession should directly firing consequences bypassing the agenda.
 
 
An entry-point is an abstract channel through where facts are inserted into the engine.
 
 
An Enum for EqualityBehavior option.
An event when a error is thrown
A public interface to be implemented by all evaluators
A markup interface for Evaluator definitions
 
An interface that represents an element that is listening for specific types of events.
An Enum for Event Processing option.
 
 
 
Contains the results for the BatchExecution Command.
 
 
A field from a declared fact type
An handle to a fact inserted into the working memory
The way how the fact to which this FactHandle was assigned has been inserted into the working memory
FactType declarations are fact definitions (like classes) that are managed alongside the rules.
FileLoggerModel is a model allowing to programmatically define a FileLogger and wire it to a KieSession
A simple immutable pojo representing Maven GAV coordinates, with a JMX-compliant method in order to be exposed and used via JMX/Monitoring.
An MBean interface for KieSession monitoring
 
 
 
 
 
 
 
Option to configure if the KieBase should retain a reference to the KieSession or not.
Annotation used to declare that a field is a key for the class it belongs to and then it will be used to calculate the equals/hashCode methods of the class itself.
 
 
The KieBase is a repository of all the application's knowledge definitions.
A class to store KieBase related configuration.
 
 
 
 
KieBaseModel is a model allowing to programmatically define a KieBase
An option to define if a KieBase should be mutable or not.
A markup interface for KieBase options.
A base interface for type safe configurations
KieBuilder is a builder for the resources contained in a KieModule
A marker interace implemented by the different type of projects supported by this KieBuilder
KieCommands is a factory for Commands that can be used by classes that implement CommandExecutor.
A container for all the KieBases of a given KieModule
 
A pool of session created from a KieContainer
 
Marker interface for all KnowlegeDefinition's
 
A top level interface for Knowledge Descriptors.
 
 
KieFileSystem is an in memory file system used to programmatically define the resources composing a KieModule
KieLoggers is a factory for KieRuntimeLogger
A tree root level class for all the drools management MBeans published to an MBean agent
This api is experimental and thus the classes and the interfaces returned are subject to change.
A KieModule is a container of all the resources necessary to define a set of KieBases like a pom.xml defining its ReleaseId, a kmodule.xml file declaring the KieBases names and configurations together with all the KieSession that can be created from them and all the other files necessary to build the KieBases themselves
KieModuleModel is a model allowing to programmatically define a KieModule
This provides a collection of knowledge definitions that can be given to a KieBase.
KieRepository is a singleton acting as a repository for all the available KieModules regardless if they are stored in the maven repository or programmatically built by the user
KieResources is a factory that provides Resource implementations for the desired IO resource
 
 
An event that is generated by the KIE runtime.
A manager for runtime events.
Maintains a collection of Knowledge Runtimes that is bound to the given KieBase.
A logger for audit events.
 
 
A KieScanner is a scanner of the maven repositories (both local and remote) used to automatically discover if there are new releases for a given KieModule and its dependencies and eventually deploy them in the KieRepository
 
 
 
 
 
 
 
 
The KieServices is a thread-safe singleton acting as a hub giving access to the other Services provided by Kie.
A Factory for this KieServices
KieSession is the most common way to interact with the engine.
An action that will be executed atomically on this session.
A class to store Session related configuration.
KieSessionModel is a model allowing to programmatically define a KieSession
 
An MBean interface for KieSession monitoring
A markup interface for KieSessionConfiguration options
A base interface for type safe configurations
A pool of session created from a KieContainer
 
 
 
Annotation used to decorate a field or class with a label.
ListenerModel is a model allowing to programmatically define a Listener and wire it to a KieSession
 
 
 
 
 
 
 
 
 
An Enum for MBeans Enabled option.
A Message generated by the building process of a KieModule
 
An event when a message is sent
Annotation used to declare that a given method (potenially) modifies the values of the named properties
A markup interface for MultiValueKieBaseConfiguration options
A markup interface for MultiValueKieSessionConfiguration options
A markup interface for MultiValueKieBaseConfiguration options
 
 
A Node represents an activity in the process flow chart.
A NodeContainer contains a set of Nodes There are different types of NodeContainers and NodeContainers may be nested.
A node instance represents the execution of one specific node in a process instance.
A node instance container is a container that can contain (zero or more) node instances.
 
 
ObjectFilter is used with WorkingMemories to filter out instances during Iteration
 
 
 
 
 
An interface for OTN MBean
 
An interface for Operator definitions.
A base interface for type safe options in configuration objects
OptionKey<T extends Option>
 
 
 
 
A class for the session persistence configuration.
NONE : On restoring a session, filter firing based on StoredObject.isPropagated ACTIVATION_KEY : On restoring a session, filter firing based on StoredObject.isPropagated and persisted ActivationKey
 
 
 
 
 
 
 
 
 
 
 
This class provides a vanilla mechanism for sending data to the rule engine, for use in having a PMML model applied against it
Annotation used to declare the Position of a field, when using Positional field constraints.
A Process represents one modular piece of business logic that can be executed by a process engine.
A runtime event that is generated when a ProcessInstance is completed.
Represents the context when executing a process.
 
A runtime event related to the execution of process instances.
A listener for events related to process instance execution.
A manager for process related events.
A process instance represents one specific instance of a process that is currently executing.
An event when a process instance has been started.
An event related to the execution of a node instance within a process instance.
An event when a node inside a process instance has been left.
An event when a node inside a process instance has been triggered.
A runtime event that is generated when a ProcessInstance is re-triggered after an error.
The ProcessRuntime is a super-interface for all KieSessions.
An event when a process instance has been started.
An event when a variable inside a process instance has been changed.
 
 
 
 
 
Base class for other Configuration classes.
 
Annotation used to declare that a given class is property specific
 
 
 
 
 
 
 
 
 
 
An Enum for the option to allow use of prototypes.
 
Public Query interface for runtime query inspection.
An enum to configure the session query listener configuration.
Contains the results of a query.
A row of data from the QueryResults container.
ReleaseId is a full identifier far a given version of an artifact.
 
 
 
This annotation should be used by users to specify (user-defined) classes that should be available to remote services (REST, JMS, WS) when using a workbench.
An Enum for Remove Identities option.
 
Generic interface to provide a Reader or InputStream for the underlying IO resource.
This interface is a marker interface and should be implemented by any class that will provide configurations to the KieBuilder - currently this is only used by decision tables.
 
A container for resources that have been processed by a KieAssemblerService.
Represent a tuple of a Resource with associated ResourceConfiguration, along with necessary kbuilder callbacks, to be used in in KieAssemblerService.
The Results of the building process of a KieModule
Annotation used to declare if a given class is a plain fact or an event
 
 
Public Rule interface for runtime rule inspection.
 
 
 
 
 
The RuleRuntime is a super-interface for all KieSessions.
 
 
 
RuleTemplateModel is a model allowing to programmatically apply a Drools Rule Template to a Decision Table
 
An Enum for Sequential option.
A clock interface that all engine clocks must implement
A clock interface for the implementation of pseudo clocks, that are clocks where the user have control over the actual clock working.
 
 
An event when a signal is thrown
A markup interface for KieBaseConfiguration options
A markup interface for SingleValueKieSessionConfiguration options
A markup interface for KieBaseConfiguration options
 
 
An event when a SLA has been violated.
There are currently no process related methods that are used with the external KieSession class.
This interface adds methods available to the KieSession beyond what the WorkingMemory provides.
StatelessKieSession provides a convenience API, wrapping KieSession.
An MBean interface for StatelessKieSession monitoring
There are currently no process related methods that are used with the external StatelessKieSession class.
This interface is used as part of the StatelessKieSession, which is the interface returned from the KieBase.
 
An option to define if the KieSession should should be thread safe or not.
 
 
 
A class for the timer job factory manager configuration.
 
 
 
 
 
 
 
A WorkflowProcess is a type of Process that uses a flow chart (as a collection of Nodes and Connections) to model the business logic.
A workflow process instance represents one specific instance of a workflow process that is currently executing.
Represents one unit of work that needs to be executed.
A work item handler is responsible for executing work items of a specific type.
WorkItemHandlerModel is a model allowing to programmatically define a WorkItemHandler and wire it to a KieSession
WorkItemHandlers configuration option
A work item manager is responsible for finding the right work item handler when a work item should be executed and should be notified when this work item has been completed (or aborted).