COM.TIBCO.hawk.config.rbengine.rulebase

Class Rulebase

java.lang.Object

COM.TIBCO.hawk.config.rbengine.rulebase.RulebaseElement

COM.TIBCO.hawk.config.rbengine.rulebase.Rulebase

All Implemented Interfaces:

RBEConfigObject, java.lang.Cloneable

public class Rulebase
extends RulebaseElement
implements RBEConfigObject

This class represents a rulebase. A rulebase is a configuration object for the RulebaseEngine microagent of a TIB/Hawk agent. It provides the instructions for the monitoring activities that are to be autonomously performed.

The author and lastModification attributes are maintained by convention. Your code should set the author when a new rulebase is constructed. It should also record last modification information each time the rulebase is modified.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CNAME
static java.lang.String	FILE_EXTENSION

Constructor Summary

Constructors

Constructor and Description
Rulebase(java.io.Reader reader) Construct the ruleBase object from a reader.
Rulebase(java.lang.String name, Rule[] rules) Constructs a Rulebase.

Method Summary

Modifier and Type	Method and Description
Rulebase	applyVariables(java.util.Properties variables) Substitutes variable in the rulebase with the key:value pairs in the variables.
java.lang.Object	clone() Returns a copy of this object
boolean	equals(java.lang.Object obj) Compare the specified object with this rulebase.
java.lang.String	getAuthor() Returns the author of the rulebase.
long	getChecksum() Returns the checksum of the config object
java.lang.String[]	getCommands() Returns the command list of a rulebase.
java.lang.String	getComment() Returns the rulebase comment.
java.lang.String	getFileExtension() Returns file extension based on the configuration object type.
java.lang.String[]	getIncludedRulebases() Returns the rulebase include list.
java.lang.String	getLastModification() Returns the last modification string.
Rule[]	getRules() Returns the list of Rule objects that make up this rulebase.
void	setAuthor(java.lang.String author) Sets the author
void	setCommands(java.lang.String[] commands) Sets the commands list.
void	setComment(java.lang.String comment) Sets the comment.
void	setIncludedRulebases(java.lang.String[] rbNames) Sets the include rulebase list.
void	setLastModification(java.lang.String mod) Sets the last modification record.
void	setName(java.lang.String name) Sets the name of this rulebase element.
void	setRules(Rule[] rules) Sets the list of Rule objects that make up this rulebase.
static java.lang.String	substituteValues(java.lang.String source, java.util.Properties prop) substitues keys with values in the input
java.lang.String	toString() Returns the string representation of the parameter.
void	toXML(java.io.Writer writer) Write the configuration object to the writer in XML.

Methods inherited from class COM.TIBCO.hawk.config.rbengine.rulebase.RulebaseElement

getName, getSchedule, setSchedule

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface COM.TIBCO.hawk.config.rbengine.RBEConfigObject

getName

Field Detail

CNAME

public static java.lang.String CNAME

FILE_EXTENSION

public static final java.lang.String FILE_EXTENSION

Constructor Detail

Rulebase

public Rulebase(java.io.Reader reader)
         throws RulebaseException

Construct the ruleBase object from a reader. The reader should provide the rulebase represented in XML. This is a convinien way to contruct the object from a file via FileReader.

Parameters:

reader - the input reader of the configuration object in XML representation.

Throws:

RulebaseException - if error encountered when creating rulebase from the reader

Rulebase

public Rulebase(java.lang.String name,
                Rule[] rules)

Constructs a Rulebase.

Parameters:

name - the rulebase name, it must contain only alpha-numeric characters, "_", "-", and no spaces.

rules - an array of Rule objects, all rules must have unique names.

Throws:

java.lang.IllegalArgumentException - if either argument is null

java.lang.IllegalArgumentException - if name contains illegal characters

java.lang.IllegalArgumentException - if any of the rule names are not unique

Method Detail

getFileExtension

public java.lang.String getFileExtension()

Returns file extension based on the configuration object type.

Specified by:

getFileExtension in interface RBEConfigObject

Returns:

the file extension of the configuration object

toXML

public void toXML(java.io.Writer writer)
           throws RulebaseException

Write the configuration object to the writer in XML.

Specified by:

toXML in interface RBEConfigObject

Throws:

RulebaseException

toString

public java.lang.String toString()

Returns the string representation of the parameter.

Overrides:

toString in class java.lang.Object

setName

public void setName(java.lang.String name)

Sets the name of this rulebase element.

Overrides:

setName in class RulebaseElement

Throws:

java.lang.IllegalArgumentException - if name contains illegal characters

setAuthor

public void setAuthor(java.lang.String author)

Sets the author

getAuthor

public java.lang.String getAuthor()

Returns the author of the rulebase.

setLastModification

public void setLastModification(java.lang.String mod)

Sets the last modification record.

getLastModification

public java.lang.String getLastModification()

Returns the last modification string. This attribute is used to record information about the last edit made to the rulebase.

setComment

public void setComment(java.lang.String comment)

Sets the comment.

getComment

public java.lang.String getComment()

Returns the rulebase comment. The comment attribute is used to record user comments about the purpose of the rulebase. It also may serve as a place to record the rulebase change history.

setRules

public void setRules(Rule[] rules)
              throws java.lang.IllegalArgumentException

Sets the list of Rule objects that make up this rulebase.

Parameters:

rules - the array of rules, may not be null, all names must be unique

Throws:

java.lang.IllegalArgumentException - if rules is null

java.lang.IllegalArgumentException - if the rule names are not unique

getRules

public Rule[] getRules()

Returns the list of Rule objects that make up this rulebase.

setIncludedRulebases

public void setIncludedRulebases(java.lang.String[] rbNames)
                          throws java.lang.IllegalArgumentException

Sets the include rulebase list.

Throws:

java.lang.IllegalArgumentException

getIncludedRulebases

public java.lang.String[] getIncludedRulebases()

Returns the rulebase include list. This is a list of rulebases that the RulebaseEngine will attempt to load when it loads the current rulebase.

setCommands

public void setCommands(java.lang.String[] commands)
                 throws java.lang.IllegalArgumentException

Sets the commands list.

Throws:

java.lang.IllegalArgumentException

getCommands

public java.lang.String[] getCommands()

Returns the command list of a rulebase.

applyVariables

public Rulebase applyVariables(java.util.Properties variables)
                        throws java.io.IOException

Substitutes variable in the rulebase with the key:value pairs in the variables. The variables in the rulebase are expected in the form of %%key%%.

Parameters:

variables - a list of key:value pairs of the variables to be substituted.

Returns:

Returns a Rulebase with variables substituted.

Throws:

java.io.IOException - if there is an error substituting rulebase variables.

equals

public boolean equals(java.lang.Object obj)

Compare the specified object with this rulebase.

Overrides:

equals in class RulebaseElement

Parameters:

obj - the object to compare with

Returns:

true if the objects are the same; false otherwise

getChecksum

public long getChecksum()

Returns the checksum of the config object

Specified by:

getChecksum in interface RBEConfigObject

clone

public java.lang.Object clone()

Returns a copy of this object

Specified by:

clone in class RulebaseElement

substituteValues

public static java.lang.String substituteValues(java.lang.String source,
                                                java.util.Properties prop)
                                         throws java.lang.Exception

substitues keys with values in the input

Parameters:

input -

prop - REPLACES KEY with VALUES

Throws:

java.lang.Exception