org.jboss.byteman.agent

Class RuleScript

java.lang.Object

org.jboss.byteman.agent.RuleScript

public class RuleScript
extends Object

details of a single rule obtained from a rule file. RuleScript instances are stored in the script repository attached to the transformer. They are used to generate Rule instances at transform time. The RuleScript contains a list of Transforms which detail failed or successful transforms performed using the script.

Constructor Summary

Constructors

Constructor and Description
RuleScript(String name, String targetClass, boolean isInterface, boolean isOverride, String targetMethod, String targetHelper, String[] imports, Location targetLocation, String ruleText, int line, String file, boolean compileToBytecode) standard constructor for a rule

Method Summary

Modifier and Type	Method and Description
String	getFile()
String[]	getImports()
int	getLine()
String	getName()
String	getRuleText()
String	getTargetClass()
String	getTargetHelper()
Location	getTargetLocation()
String	getTargetMethod()
List<Transform>	getTransformed() getter for list of transforms applied for this script.
int	getTransformedCount() return a count of the number of transforms applied for this script.
boolean	hasTransform(Class<?> clazz) check whether a rule has been used to transform a specific class.
boolean	isCompileToBytecode()
boolean	isDeleted() called when indexing a script to ensure that it has not already been deleted.
boolean	isInterface()
boolean	isOverride()
void	purge() uninstall any rules associated with this script.
void	recordCompile(String triggerClass, ClassLoader loader, boolean successful, String detail) record the fact that a rule has been compiled with or without success
boolean	recordFailedTransform(ClassLoader loader, String internalClassName, Throwable th) record the fact that an error was thrown when attempting to transform a given class using this rule script
boolean	recordMethodTransform(ClassLoader loader, String internalClassName, String triggerMethodName, String desc, Rule rule) record the fact that a trigger call has been successfully installed into bytecode associated with a specific class and loader and a corresponding rule instance been installed
boolean	recordTransform(ClassLoader loader, String internalClassName, String triggerMethodName, String desc, Rule rule, Throwable th) record the fact that a trigger call has failed to install into bytecode associated with a specific class and loader
boolean	setDeleted() invoked by the scriptmanager when a rule is redefined to inhibit further transformations via this script
String	toString()
void	writeTo(PrintWriter writer)

Methods inherited from class java.lang.Object

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

Constructor Detail

RuleScript

public RuleScript(String name,
                  String targetClass,
                  boolean isInterface,
                  boolean isOverride,
                  String targetMethod,
                  String targetHelper,
                  String[] imports,
                  Location targetLocation,
                  String ruleText,
                  int line,
                  String file,
                  boolean compileToBytecode)

standard constructor for a rule

Parameters:

name - the name of the rule

targetClass - the name of the class or interface to which the rule applies

isInterface - true if the ruel applies to an interface false if it appies ot a class

isOverride - true if the rule should inject down class hierarchies false if it should inly inject into direct implementations

targetMethod - the name of the method to which the rule applies

targetHelper - the name of the helper class to be used

imports - the list of imports for the module system

targetLocation - description of where the rule should be injected

ruleText - the body of the rule as text including the BIND, IF and DO clasue

line - the line at which the rule starts in it's rule script

file - the path to the file containing the rule

compileToBytecode - true if the rule should be compiled otherwise false

Method Detail

getName

public String getName()

getTargetClass

public String getTargetClass()

isInterface

public boolean isInterface()

getTargetHelper

public String getTargetHelper()

getImports

public String[] getImports()

getTargetMethod

public String getTargetMethod()

isOverride

public boolean isOverride()

getTargetLocation

public Location getTargetLocation()

getRuleText

public String getRuleText()

getLine

public int getLine()

getFile

public String getFile()

isCompileToBytecode

public boolean isCompileToBytecode()

getTransformed

public List<Transform> getTransformed()

getter for list of transforms applied for this script. must be called synchronized on the script.

Returns:

the list of transforms

getTransformedCount

public int getTransformedCount()

return a count of the number of transforms applied for this script. must be called synchronized on the script.

Returns:

the size of the list of transforms

setDeleted

public boolean setDeleted()

invoked by the scriptmanager when a rule is redefined to inhibit further transformations via this script

Returns:

the previous setting of deleted

isDeleted

public boolean isDeleted()

called when indexing a script to ensure that it has not already been deleted. it must only be called when synchronized on the script. This avoids a race where a script can be added by thread A, deleted by thread B, unindexed -- unsuccessfully -- by thread B then indexed by thread A

Returns:

the previous setting of deleted

recordFailedTransform

public boolean recordFailedTransform(ClassLoader loader,
                                     String internalClassName,
                                     Throwable th)

record the fact that an error was thrown when attempting to transform a given class using this rule script

Parameters:

loader - the loader of the class for which injection was attempted

internalClassName - the internal Java name of the class

th - the Throwable reocrding details of the failure

Returns:

true if the failure was recorded false if not

recordMethodTransform

public boolean recordMethodTransform(ClassLoader loader,
                                     String internalClassName,
                                     String triggerMethodName,
                                     String desc,
                                     Rule rule)

record the fact that a trigger call has been successfully installed into bytecode associated with a specific class and loader and a corresponding rule instance been installed

Parameters:

loader - the loader of the class for which injection was attempted

internalClassName - the internal Java name of the class

triggerMethodName - the name of the method injected into

desc - the descriptor of the method injected into

rule - the rule which was injected

Returns:

true if the successful injection was recorded false if not

recordTransform

public boolean recordTransform(ClassLoader loader,
                               String internalClassName,
                               String triggerMethodName,
                               String desc,
                               Rule rule,
                               Throwable th)

record the fact that a trigger call has failed to install into bytecode associated with a specific class and loader

Parameters:

loader - the loader of the class for which injection was attempted

internalClassName - the internal Java name of the class

triggerMethodName - the name of the method injected into

desc - the descriptor of the method injected into

rule - the rule which was injected

th - throwable generated during the attempt to parse the rule text or inject code at the trigger point

Returns:

true if the successful injection was recorded false if not

hasTransform

public boolean hasTransform(Class<?> clazz)

check whether a rule has been used to transform a specific class. this can be used when rules are redefined to decide whether or not a class needs to be retransformed. Note that it must only be called after the script has been deleted by calling setDeleted.

Parameters:

clazz - the class for which a transform is being sought.

Returns:

true if the class has been transformed using this script otherwise false.

recordCompile

public void recordCompile(String triggerClass,
                          ClassLoader loader,
                          boolean successful,
                          String detail)

record the fact that a rule has been compiled with or without success

Parameters:

triggerClass - the name of the trigger class to which the rule is attached

loader - the classloader of the trigger class

successful - true if the rule compiled successfully and false if it suffered from parse, type or compile errors

detail - text decribing more details of the compilation outcome

purge

public void purge()

uninstall any rules associated with this script. this is called after marking the script as deleted and regenerating the methods for any associated transformed class to ensure that it does not cause a rule trigger call to fail.

toString

public String toString()

Overrides:

toString in class Object

writeTo

public void writeTo(PrintWriter writer)