com.ibm.di.api.act
Class ACTEngineManager

java.lang.Object
  com.ibm.di.api.act.ACTEngineManager

public class ACTEngineManager
extends Object

A TDI wrapper for an Active Correlation Technology engine. Can be enabled/disabled (depending on the value of the "act.engine.on" system property).

When enabled, it instantiates an ACT engine and delegates processing of events to that engine. A rule set must be configured for the engine, by specifying a compiled ACT rule set file through the "act.engine.rule.set.file" system property. The specified set of rules is parsed and loaded into the ACT engine on initialization. The rules can use a special TDI object, which allows them to send server notifications. This special object implements the com.ibm.di.api.act.TDIFunctions interface and is registered in the ACT engine at startup. The underlying ACT engine is configured to use JLog as its log manager. The following JLog configuration file is used: etc/act-jlog.properties.

When disabled, this class throws an exception if asked to process an event.

Since:

TDI 6.1.1

Field Summary

static String

TDI_FUNCTIONS_KEY Under this key is registered a TDI object for the use of the ACT rules.

Constructor Summary

ACTEngineManager(Session localServerAPISession)
Creates the ACT engine wrapper.

Method Summary

void	processEvent(Serializable event) Processes an event by the Active Correlation Technology engine of the TDI server.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TDI_FUNCTIONS_KEY

public static final String TDI_FUNCTIONS_KEY

Under this key is registered a TDI object for the use of the ACT rules. The object implements the com.ibm.di.api.act.TDIFunctions interface.

See Also:

Constant Field Values

Constructor Detail

ACTEngineManager

public ACTEngineManager(Session localServerAPISession)
                 throws DIException

Creates the ACT engine wrapper. Reads the configuration. If configured to be enabled, it instantiates and initializes an internal ACT engine. The initialization involves parsing the specified rule file and registering a TDI object for the use of the rules.

Parameters:

localServerAPISession - A session to the local TDI server API. It is used to allow the ACT rules to send server notifications.

Throws:

DIException - The ACT engine cannot be created, the rule file cannot be parsed, or an error occurred while loading the rules into the engine.

Method Detail

processEvent

public void processEvent(Serializable event)
                  throws DIException

Processes an event by the Active Correlation Technology engine of the TDI server. The method returns when the engine has completely processed the event.

Parameters:

event - Event to be processed by ACT engine - currently only org.eclipse.hyades.logging.events.cbe.CommonBaseEvent is supported.

Throws:

DIException - An error occurred while processing the event or the event type is not supported.