Skip navigation links

Rule Execution Server API

The APIs listed in this documentation are the only supported APIs - any API (class, interface, method, constructor or member) in a package not explicitly listed in this documentation is subject to change or removal without prior deprecation in any subsequent release (including technical releases), and its use in customer code is not supported.

See:
Description

Rule Execution Server

com.ibm.rules.res.xu.event	Provides the classes and interfaces for the Execution Unit (XU) to uses events.
com.ibm.rules.res.xu.plugin	Provides the classes necessary to implement the Execution Unit (XU) plug-ins that are compatible with both decision engine and the classic rule engines.
ilog.rules.bom	Contains the interfaces that are used for representing BOMs and XOMs.
ilog.rules.bom.annotations	Contains annotations you can use to decorate Java classes in order to modify how they are imported into a BOM.
ilog.rules.bom.dynamic	Contains an implementation of the object model.
ilog.rules.bom.mutable	Defines the object model mutable API.
ilog.rules.bom.serializer	Contains the IlrSerializer interface which can read and write an object model.
ilog.rules.bom.util	Contains miscellaneous utility classes.
ilog.rules.res.decisionservice.mbean	Use this package to create and manage a decision service MBean.
ilog.rules.res.jsr94	Provides the classes that implement the JavaTM Rule Engine API (JSR-94) on top of Rule Execution Server.
ilog.rules.res.model	Provides interfaces for the Rule Execution Server management model.
ilog.rules.res.model.archive	Use this package to backup a RuleApp or a set of RuleApps into a RuleApp archive.
ilog.rules.res.model.mbean	Provides interfaces for Rule Execution Server management MBeans.
ilog.rules.res.model.trace	Provides interfaces for the Decision Warehouse trace model.
ilog.rules.res.persistence.trace	Provides interfaces for the Decision Warehouse DAO.
ilog.rules.res.session	Provides the core classes and interfaces to manage Decision Server rule sessions.
ilog.rules.res.session.async	Provides classes for asynchronous ruleset execution via the Rule Sessions API.
ilog.rules.res.session.config	Classes and interfaces to configure a session factory.
ilog.rules.res.session.interceptor	Classes and interfaces for rule session interceptors.
ilog.rules.res.session.rawdata	Provides the API for raw data rule services.
ilog.rules.res.session.ruleset	Provides the interfaces for execution traces.
ilog.rules.res.xu.event	Provides classes and interfaces for the events the Execution Unit (XU) uses.
ilog.rules.res.xu.persistence	This package provides classes and methods that you can use to write a custom XU file persistence mode.
ilog.rules.res.xu.plugin	Provides the classes necessary to implement Execution Unit (XU) plug-ins.
ilog.rules.res.xu.pool	Provides the classes and interfaces you need to implement a custom pool that the Execution Unit (XU) uses for pooling connections.
ilog.rules.res.xu.ruleset	This package provides an API that you can use to write a custom ruleset cache for the Execution Unit (XU).
ilog.rules.studio.res	Provides an interface to manage Rule Execution Server Configurations in Rule Designer.
ilog.rules.studio.res.generator	Provides a set of abstract classes that you can extend to create and add a new generator for a Client Project for Ruleapps in Rule Designer.
ilog.rules.studio.res.generator.impl	Provides classes that extend the velocity template.
ilog.rules.studio.res.ruleapp	Provides a set of interfaces to manage RuleApps and RuleApp projects in Rule Designer.
ilog.rules.studio.res.ui.generator.impl.wizard	Provides classes that the Client Project for RuleApps wizard can display as a nested wizard after the generator and the RuleApp project had been selected.
ilog.rules.studio.res.ui.generator.impl.wizard.page	Provides classes that the Client Project for RuleApps wizard can display.
ilog.rules.xml	Provides the base classes and interfaces involved in the XML binding process.
ilog.rules.xml.binding	Provides the default implementation of the XML binding interface.
ilog.rules.xml.model	Contains the XML model class that provides information for the whole schema.
ilog.rules.xml.types	Contains the Java classes representing the XSD simple data types.
ilog.rules.xml.util	Contains a number of utility interfaces that are useful for parameterizing the XML binding mapping.

Classic Rule Engine

ilog.rules.archive	Contains the classes needed to build a ruleset archive and extract its contents, without any interpretation of the contents.
ilog.rules.debug	Provides the IlrLocalTracerToolFactory class, which allows you to create a local trace.
ilog.rules.engine	Provides the core classes of the IBM Decisin Server rule engine.
ilog.rules.factory	Contains the Factory API, which provides reflection for IBM Decision Server rules.
ilog.rules.factory.translation	Contains the Translation API, which supports the creation and modification of translations between rules based on a business model and rules based on an execution model.
ilog.rules.tools	Provides command-line tools.
ilog.rules.util	Provides utilities for handling classes.
ilog.rules.util.engine	Provides engine configuration and optimization constants.
ilog.rules.util.prefs	Allows applications to retrieve preferences and localized messages.
ilog.rules.util.resources	Provides the configuration properties for the rule engine.

Decision Engine

com.ibm.rules.engine.load	Utilities for loading an engine.
com.ibm.rules.engine.observer	Observer engine API.
com.ibm.rules.engine.ruledef.runtime	Rule engine runtime API.
com.ibm.rules.engine.ruleflow.runtime	Provides the entry point for running ruleflow engine.
com.ibm.rules.engine.runtime	Engine runtime API.
com.ibm.rules.engine.service	Engine service API.
com.ibm.rules.engine.util	Utility classes including filters, properties and exceptions.

Other Packages

ilog.rules.teamserver.auth

Defines the API used to connect to Decision Center.

The APIs listed in this documentation are the only supported APIs - any API (class, interface, method, constructor or member) in a package not explicitly listed in this documentation is subject to change or removal without prior deprecation in any subsequent release (including technical releases), and its use in customer code is not supported.

Business rules are an expression of business policy in a form that is comprehensible to business users and executable by a rule engine. From a business perspective, a business rule is a precise statement that describes, constrains, or controls some aspect of your business. From the IT perspective, business rules are a package of executable business policy statements that can be called from an application.

The APIs documented here provide the means to automate and extend business rules-driven applications.

Rule Execution Server

Rule Execution Server provides an environment for you to manage the execution of your rules on both the Java SE and Java EE platforms. Rule Execution Server includes a set of management facilities that allow system administrators to change the behavior of the execution stack, and disable rulesets in emergency situations.

The API enables RuleApp and ruleset deployment, administration, and execution.

The main packages and classes for this group are:

Package Name	Description	Main classes
ilog.rules.res.session	Provides the core classes and interfaces to manage rule sessions.	IlrEJB3SessionFactory IlrJ2SESessionFactory IlrManagementSession IlrPOJOSessionFactory IlrSessionFactory IlrSessionRequest IlrSessionResponse IlrStatefulSession IlrStatelessSession IlrTraceFilter
ilog.rules.res.session.ruleset	Provides the interfaces for execution traces and execution events.	IlrExecutionEvent IlrExecutionTrace IlrRuleEvent IlrRuleInformation IlrTaskEvent IlrTaskInformation
Core classes in non-core packages.		IlrDWTrace IlrDWTraceFilter