Package COM.TIBCO.hawk.config.rbengine.rulebase
package COM.TIBCO.hawk.config.rbengine.rulebase
Provides classes for creating and processing rulebase used in TIBCO Hawk agents.
A rulebase is configuration object that provides the rules for the monitoring activities that are to be autonomously performed on an agent. At the core of all rulebase monitoring activity is the collection of data, testing of that data, and taking actions based on the test results. All monitored data is provided by the agent's microagents through microagent subscriptions. All actions taken by a rulebase are in the form of method invocations. Rulebase objects specify their data sources and actions using the MethodSubscription and MethodInvocation classes of the Console API. Therefore, understanding these, and related classes, is a prerequisite for using the rulebase api.
Definition of a rulebase
Each rulebase holds a set of rule definitions. Each rule identifies a data source and a list of tests to be applied to the data. The tests in turn hold a list of actions which are conditionally executed based on test results. Thus, a rulebase can be represented as a tree structure with a single rulebase object as the root and action objects as the leaves.Rulebase configuration management
Rulebase use by the agent are maintained in a Rulebase object. Agent stores and retrieves the each Rulebase to and from a rulebase file. The filename of the rulebase correspond to name of the rulebase and has an extension of ".hrb". If the filename of the rulebase does not correspond to the name of the rulebase, TIBCO Hawk Agents will not load the rulebase and an error is logged. When TIBCO Hawk Agents is running in auto config mode, rulebases are loaded from the the autoconfig directory. When TIBCO Hawk Agents is running in repository config mode, rulebases are loaded from the specified repository.Related Documentation
For more details on rulebases and handling of rulebases in TIBCO Hawk Agents, please refer to:- Since:
- TIBCO Hawk 4.0.0
-
ClassDescriptionThis class is the superclass for all actions.A ClearAction represents an action that may be executed when a test makes a T->F state transition.A ConsequenceAction represents an action that a test may execute when it undergoes a F->T or T->T state transition.This class is used to represent a rule's data source.Used to describe operandsThis class is used to build all operators for use as test expressions in Test objects.Used to describe operators.Used to signal exceptions in the creation or evaluation of OperatorsRule objects are the primary components of a rulebase.This class represents a rulebase.This class is a super class of the major rulebase elements: Rulebase, Rule, Test, and Action.Signals that an error occurred while processing the rulebase.This class encapsulates the xml representation of a Rulebase.This class represents the context of the rulebase.Test objects define the tests which are performed on the rule's data and what actions to take.Used to describe variable list operands.