Package COM.TIBCO.hawk.config.rbengine.rbmap

Class RBMap

java.lang.Object
COM.TIBCO.hawk.config.rbengine.rbmap.RBMap
All Implemented Interfaces:
RBEConfigObject, Cloneable
public class RBMap extends Object implements RBEConfigObject, Cloneable
RBMap represents a rulebase map. A rulebase map is a configuration object for the RulebaseEngine microagent of a TIB/Hawk agent. It can be viewed as having three distinct set of mappings:
  • Group mapping - to organize agents into groups for the purpose of rulebase assignment.
  • Rulebase mapping - to map rulebases to agents or groups of agents.
  • Command mapping - to delegate the rulebase mapping function to an external command.
Groups mapping contains a set of group mappings. Each group mapping maps a group name to a list of agents or groups, or combination agents and groups.

Rulebases mapping contains a set of rulebase mappings. A rulebase mapping maps a rulebase to a list of agents or groups, or combination agents and groups.

Commands mapping contains a set of command mappings. A command mapping maps a command to a list of agents or groups, or combination agents and groups.

The agents and/or groups in a mapping are referred to as members of that mapping. Methods that involve using a member may use an agent or a group as an argument. For example, in setMembersInGroup(String group, String[] members), each member in the array can represent either an agent or a group.

The Command mapping can be used as an alternate or a supplement to the main mapping portion of the rulebase map. To use command mapping, it is required to turn on the 'useCommandMapping' flag in the rulebase map attributes by calling Attributes.setUseCommandMapping(boolean, boolean).

See Also:

  • Field Details

    • FILE_EXTENSION

      public static final String FILE_EXTENSION
      File extension for the rulebase map.
      See Also:

    • ruleBaseMapName

      public static String ruleBaseMapName
      Default name for rulebase map.

    • ruleBaseMapFileName

      public static String ruleBaseMapFileName
      Default filename for rulebase map.

  • Constructor Details

    • RBMap

      public RBMap()
      Construct an empty rulebase map.

    • RBMap

      protected RBMap(COM.TIBCO.hawk.config.rbengine.rbmap.impl.RBMapUiModel rbMapUiModel)

    • RBMap

      public RBMap(Reader reader) throws RBMapException
      Create a RBMap from the reader. The reader contains a rulebase map in an XML format. This constructor is useful when recreating a RBMap from RBMapXML object: 
          RBMap schedules = new RBMap(aRBMapXML.getXMLReader());

      Parameters:
      reader - a reader which contain the rulebase map in XML format.
      Throws:
      RBMapException - if not able to create rulebase map from the reader.

  • Method Details

    • getFileExtension

      public 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

    • getChecksum

      public long getChecksum()
      Returns the checksum of this RBMap.

      Specified by:
      getChecksum in interface RBEConfigObject

    • setName

      public void setName(String name)
      Deprecated.
      Sets the name of this RBMap.

    • getName

      public String getName()
      Returns the name for this RBMap.

      Specified by:
      getName in interface RBEConfigObject

    • setAttributes

      public void setAttributes(Attributes p)
      Sets the attributes of this RBMap.

    • getAttributes

      public Attributes getAttributes()
      Returns the attributes of this RBMap.

    • getGroups

      public String[] getGroups()
      Returns the group names that has a group mapping. The groups returned can be used for getting members in the groups.

      Returns:
      an array of group names that has a mapping defined for that group. Empty array if no group mapping is defined.
      See Also:

    • getMembersInGroup

      public String[] getMembersInGroup(String group)
      Returns all the members in the specified group.

      Parameters:
      group - the group whose members will be retrieved.
      Returns:
      an array of member names that belongs to the specified group. Empty array if the specified group has no mapping defined.
      Throws:
      IllegalArgumentException - if group is null or does not start with a "+".
      See Also:

    • setMembersInGroup

      public void setMembersInGroup(String group, String[] members)
      Maps a group to the specified list of agents or groups.

      Parameters:
      group - the group name for the mapping.
      members - a list of agents or groups that the group will contains.
      Throws:
      IllegalArgumentException - if the group or the members is null. A group must start with a "+".
      See Also:

    • removeGroup

      public void removeGroup(String group)
      Removes a group mapping for the specified group.

      Parameters:
      group - the group of which the mapping to be removed. If group is null or does not exist, the operation is ignored.
      See Also:

    • getRulebases

      public String[] getRulebases()
      Returns the rulebases that has a rulebase mapping. The rulebases returned can be used for getting members in the rulebases.

      Returns:
      an array of rulebases that has a mapping defined for that rulebase. Empty array if no rulebase mapping is defined.
      See Also:

    • getMembersForRulebase

      public String[] getMembersForRulebase(String rulebase)
      Returns all the members that uses the specified rulebase.

      Parameters:
      rulebase - the rulebase whose members will be retrieved.
      Returns:
      an array of member names that uses the specified rulebase.. Empty array if the specified rulebase has no mapping defined.
      Throws:
      IllegalArgumentException - if rulebase is null.
      See Also:

    • setMembersForRulebase

      public void setMembersForRulebase(String rulebase, String[] members)
      Maps rulebases to the specified list of agents or groups.

      Parameters:
      group - the group name for the mapping.
      members - a list of agents or groups that will use the rulebase.
      Throws:
      IllegalArgumentException - if the rulebase or the members is null.
      See Also:

    • removeRulebase

      public void removeRulebase(String rulebase)
      Removes a rulebase mapping for the specified rulebase.

      Parameters:
      rulebase - the rulebase of which the mapping to be removed. If rulebase is null or does not exist, the operation is ignored.
      See Also:

    • getCommands

      public String[] getCommands()
      Returns the commands in the set of commands mapping. The commands returned can be used for getting members for a command.

      Returns:
      an array of commands that has a mapping defined for that commands. Empty array if no commands mapping is defined.
      See Also:

    • getMemberForCommand

      public String getMemberForCommand(String command)
      Returns the agent or group that uses the command.

      Parameters:
      command - the command whose agent or group will be retrieved.
      Returns:
      the agent or group that uses the specified command for generating rulebases.
      Throws:
      IllegalArgumentException - if command is null.
      See Also:

    • setMemberForCommand

      public void setMemberForCommand(String command, String member)
      Maps a command to the specified agent or group. If the same command is used for another agent or group, it will be replaced by the new mapping.

      Parameters:
      command - the command for the mapping.
      members - an agent or group that will use the command.
      Throws:
      IllegalArgumentException - if the command or the members is null.
      See Also:

    • removeCommand

      public void removeCommand(String command)
      Removes a command mapping for the specified command.

      Parameters:
      command - the command of which the mapping to be removed. If command is null or does not exist, the operation is ignored.
      See Also:

    • toXML

      public void toXML(Writer writer) throws RBEConfigObjectException
      Writes the rulebase map in XML representation to Writer in XML.

      Specified by:
      toXML in interface RBEConfigObject
      Throws:
      RBEConfigObjectException

    • equals

      public boolean equals(Object obj)
      Compares two rulebase maps. The result is true if the argument is not null and is a rulebase map object has the same group, rulebase, and command mappings.

      Overrides:
      equals in class Object
      Parameters:
      obj - the object to compare with
      Returns:
      true if the objects are the same; false otherwise.

    • clone

      public Object clone() throws CloneNotSupportedException
      Returns a copy of this object.
      Overrides:
      clone in class Object
      Returns:
      a copy of this object.
      Throws:
      CloneNotSupportedException

    • getAgentRulebases

      public String[] getAgentRulebases(String agent, String autoGroup)
      Returns a list of rulebases for specified agent and the default group that this agent is belongs to. The list of rulebases for an agent include rulebases for all the groups that agent belongs.

      If a group is specified, then the rulebases for the group is returned and the autogroup is ignored.

      When generating the rulebases, the rulebase map may or may not use command mapping to generate the rulebases. This depends on the setting in the Attributes. Refere to Attributes.setUseCommandMapping(boolean, boolean) for more details.

      This method is use by the RulebaseEngine MicroAgent to generate the list of rulebases that will be loaded during startup.

      For example, with the following rulebase and group mappings: 

           rulebase1  agent1 agent2
     rulebase2  +group1
     +group1    agent1 agent2 agent3
      getAgentRulebases(java.lang.String,java.lang.String) will return both rulebase1 and rulebase2 for agent1.

      Parameters:
      agent - the agent or group whose rulebases to be retrieved.
      autoGroup - the automatic group that the agent is in.
      Returns:
      a list of rulebases for specified agent and its autoGroup.
      See Also: