Skip navigation links

Package 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).

See:
Description

Interface Summary

IlrRulesetCache	Represents a ruleset cache.
IlrRulesetUsageInformation	Represents the usage information about a ruleset.
IlrRulesetUsageInformationMonitor	IlrRulesetUsageInformationMonitor contains information about ruleset usage.
IlrXURuleset	Represents a ruleset in the execution unit (XU).

Exception Summary

IlrRulesetCacheException

Thrown to indicate an error from the IlrRulesetCache interface.

Package ilog.rules.res.xu.ruleset Description

This package provides an API that you can use to write a custom ruleset cache for the Execution Unit (XU).

You can change the class that implements the cache in the XU configuration file ra.xml

For example, if you want to use the custom class mypackage.MyRulesetCache:

<config-property>
   <config-property-name>rulesetCacheProperties
   <config-property-type>java.lang.String</config-property-type>
   <config-property-value>ruleset.cache.class=mypackage.MyRulesetCache</config-property-value>
</config-property>
        

You can define custom properties to be passed to the ruleset cache:

<config-property>
   <config-property-name>rulesetCacheProperties
   <config-property-type>java.lang.String</config-property-type>
   <config-property-value>ruleset.cache.class=mypackage.MyRulesetCache<,mycustomprop=mycustomvalue/config-property-value>
</config-property>
        

You can retrieve information about ruleset usage from a XU plugin or ruleset cache implementation. To do so, you must specify the rulesetUsageMonitorEnabled XU configuration parameter in the configuration files and set it to true as follows:

<config-property>
   <config-property-name>rulesetUsageMonitorEnabled
   <config-property-type>java.lang.Boolean</config-property-type>
   <config-property-value>true/config-property-value>
</config-property>
        

The class must implement the IlrRulesetCache interface.

In Java SE, you must include the class in the same class path as that of the XU or in a parent class path.

In Java EE, you must package the class in the XU .rar file.

Since:

7.1