Class ScriptRepository

java.lang.Object
org.jboss.byteman.agent.ScriptRepository

public class ScriptRepository extends Object
Class to manage indexing and lookup of rule scripts by rule name and by either class or interface name
  • Field Details

    • targetClassIndex

      private final Map<String,List<RuleScript>> targetClassIndex
      a 1-1 mapping from target class names which appear in rules to a script object holding the rule details
    • targetInterfaceIndex

      private final Map<String,List<RuleScript>> targetInterfaceIndex
      a 1-m mapping from target interface names which appear in rules to a script object holding the rule details
    • ruleNameIndex

      private final Map<String,RuleScript> ruleNameIndex
      a 1-m mapping from rule names which appear in rules to a script object holding the rule details
    • skipOverrideRules

      private final boolean skipOverrideRules
      a flag derived from the transformer which enables us to avoid testing superclass rules for matches if it is set
    • overrideRuleCount

      private int overrideRuleCount
      a count of how many rules there are in the script repository which employ injection into hierarchies
  • Constructor Details

    • ScriptRepository

      public ScriptRepository(boolean skipOverrideRules)
  • Method Details

    • processScripts

      public List<RuleScript> processScripts(String scriptText, String scriptFile) throws Exception
      Split the text of a script file into a list of individual rule scripts
      Parameters:
      scriptText - the text obtained from a script file
      scriptFile - teh name of the file containing teh text
      Returns:
      a list of rule scripts
      Throws:
      Exception - if there is an error in the format of the script file tesxt
    • addScript

      public RuleScript addScript(RuleScript script)
      add a rule script to the repository returning any existing script with the same name or null if no such script can be found. if a script is returned it will have been deactivated.
      Parameters:
      script - the script to be added to the repository
      Returns:
      any previous script with the same name or null
    • removeScript

      public RuleScript removeScript(RuleScript script)
      remove a rule script from the repository returning the script if it is found or null if is not found. if a script is returned it will have been deactivated.
      Parameters:
      script - the script to be removed from the repository.
      Returns:
      the script if it was found in the repository and removed successfully or null if it had already been removed.
    • removeScript

      public RuleScript removeScript(String name)
      remove a rule script from the repository by name returning the script if it is found or null if is not found. if a script is returned it will have been deactivated.
      Parameters:
      name - the name of the script to be removed from the repository
      Returns:
      the script if it was found in the repository or null if none was found
    • scriptForRuleName

      public RuleScript scriptForRuleName(String name)
      locate a rule script with a given name
      Parameters:
      name - the name of the rule script
      Returns:
      the script with that name or null if no such script can be found
    • scriptsForClassName

      public List<RuleScript> scriptsForClassName(String name)
      return a list of all class scripts indexed using the supplied name. note that if name is package qualified then only scripts with the full package qualificaton will be returned whereas if name is not package qualified then only scripts with the unqualified name will be returned. Note that the returned list can be iterated safely but will not reflect later additions to or deletions from the list.
      Parameters:
      name - the name of the class for which scripts should be listed
      Returns:
      the list of scripts for that name
    • scriptsForInterfaceName

      public List<RuleScript> scriptsForInterfaceName(String name)
      return a list of all interface scripts indexed using the supplied name. note that if name is package qualified then only scripts with the full package qualificaton will be returned whereas if name is not package qualified then only scripts with the unqualified name will be returned. Note that the returned list can be iterated safely but will not reflect later additions to or deletions from the list.
      Parameters:
      name - the name of the interface for which scripts should be listed
      Returns:
      the list of scripts for that name
    • matchClass

      public boolean matchClass(Class<?> clazz) throws Exception
      return true if there is a rule which applies to the supplied class otherwise false
      Parameters:
      clazz - the name of the class for which rules are being sought
      Returns:
      true if there is a rule which applies
      Throws:
      Exception - if an error occurs during class lookup
    • currentRules

      public List<RuleScript> currentRules()
      return a list containing all the currently installed rule scripts.
      Returns:
      the list of all installed scripts
    • matchTarget

      private boolean matchTarget(String name, Class<?> clazz, boolean isInterface, boolean isOverride)
      return true if there are any scripts indexed under name which meet the required matching conditions
      Parameters:
      name - the name under which the scripts are indexed
      clazz - a class which should be checked for a method whose name matches the script method name
      isInterface - true if we are interested in matching interface rules false if we are interested in matching class rules
      isOverride - true if we are only interested in rules which apply to overriding methods false if we are happy with any rule
      Returns:
      true if any scripts are found otherwise false
    • indexTarget

      private void indexTarget(RuleScript script, Map<String,List<RuleScript>> index)
      insert a script into the index using the script target class name as the index key.
      Parameters:
      script -
      index -
    • unindexTarget

      private void unindexTarget(RuleScript script, Map<String,List<RuleScript>> index)
      remove a script from the index using the script target class name as the index key.
      Parameters:
      script -
      index -
    • reindexTarget

      private void reindexTarget(RuleScript script, RuleScript previous, Map<String,List<RuleScript>> index)
      replace a script in the index using the script target class name as the index key.
      Parameters:
      script -
      index -
    • add

      private void add(List<RuleScript> entries, RuleScript script)
      add a rule script to start or end of the index list according to its location type. AT ENTRY rules are pushed so they are sorted in reverse load order. other rules are appended so they are sorted in load order.
      Parameters:
      entries -
      script -
    • checkInterfaces

      public boolean checkInterfaces()
      see if we need to do any transformation of interfaces
      Returns:
      true if there are any interface rules false if there are none
    • skipOverrideRules

      public boolean skipOverrideRules()
      check whether any overriding rules are currently loaded
      Returns:
      true if there are no overriding rules false if there are any