Tool for enhancing classes annotated with tracing facility annotations. The processing is divided into two phases:

The first phase adds code to the static initialized of the class to register the class with the TF framework. This phase also modifies all calls to @InfoMethod annotated methods to pass extra arguments needed for tracing. Note that this phase must be done at build time, because it modifies the schema of the class.
The second phase adds the actual trace code to methods annotated with tracing annotations. This does not change the schema, so this phase could be done either at build time, or at runtime. Tracing the code only at runtime may reduce the overhead, since untraced code need not be modified.

This tool can do either phase 1, or phase 1 and 2, against ALL classes reachable from a starting directory.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static interface	EnhanceTool.Arguments
private class	EnhanceTool.EnhancerFileAction References Deprecated `Scanner.Action` is deprecated or references (maybe indirectly) at least one deprecated element.
public static enum	EnhanceTool.ProcessingMode

Field Summary

Modifier and Type	Field and Description
private EnhanceTool.Arguments	args
private static int	errorCount
private TimingInfoProcessor	tip
private Util	util

Access	Constructor and Description
public	EnhanceTool()

Method Summary

Modifier and Type	Method and Description
private void	doScan(EnhanceTool.Arguments args, ActionFactory af, Scanner scanner, Scanner.Action classAct) References Deprecated `Scanner.Action` is deprecated or references (maybe indirectly) at least one deprecated element.
private void	generatePropertiesFile(EnhanceTool.Arguments args, Set<String> anames)
public static void	main(String[] strs)
private Scanner.Action	makeIgnoreAction(final boolean trace) References Deprecated `Scanner.Action` is deprecated or references (maybe indirectly) at least one deprecated element.
public void	run(String[] strs)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

args	back to summary
private EnhanceTool.Arguments args

errorCount	back to summary
private static int errorCount

tip	back to summary
private TimingInfoProcessor tip

util	back to summary
private Util util

EnhanceTool	back to summary
public EnhanceTool()

Method Detail

doScan	back to summary
private void doScan(EnhanceTool.Arguments args, ActionFactory af, Scanner scanner, Scanner.Action classAct) throws IOException References Deprecated `Scanner.Action` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information.

generatePropertiesFile	back to summary
private void generatePropertiesFile(EnhanceTool.Arguments args, Set<String> anames) throws IOException

main	back to summary
public static void main(String[] strs)

makeIgnoreAction	back to summary
private Scanner.Action makeIgnoreAction(final boolean trace) References Deprecated `Scanner.Action` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information.

run	back to summary
public void run(String[] strs)

org.glassfish.pfl.tf.tools.enhancer back to summary

public Interface EnhanceTool.Arguments

Method Summary

Modifier and Type	Method and Description
public boolean	debug()
public File	dir()
public boolean	dryrun()
public EnhanceTool.ProcessingMode	mode()
public boolean	newout()
public File	rf()
public String	timingPointClass()
public String	timingPointDir()
public int	verbose()

Method Detail

debug	back to summary
public boolean debug() Annotations @DefaultValue:false @Help:Debug flag

dir	back to summary
public File dir() Annotations @DefaultValue:. @Help:Directory to scan for class file

dryrun	back to summary
public boolean dryrun() Annotations @DefaultValue:false @Help:Indicates a run that only prints out actions, but does not perform them

mode	back to summary
public EnhanceTool.ProcessingMode mode() Annotations @DefaultValue:TimingPoints @Help:Control the mode of operation: TimingPoints, UpdateSchema, or TraceEnhance

newout	back to summary
public boolean newout() Annotations @DefaultValue:false @Help:If true, write output to a .class.new file

rf	back to summary
public File rf() Annotations @DefaultValue:tfannotations.properties @Help:Name of resource file containing information about tf annotations

timingPointClass	back to summary
public String timingPointClass() Annotations @DefaultValue @Help:The timing point class name

timingPointDir	back to summary
public String timingPointDir() Annotations @DefaultValue @Help:The directory in which to write the TimingPoint file

verbose	back to summary
public int verbose() Annotations @DefaultValue:0 @Help:Verbose flag

org.glassfish.pfl.tf.tools.enhancer back to summary

private Class EnhanceTool.EnhancerFileAction

Class Inheritance

extends Object
implements Action

java.lang.Object
org.glassfish.pfl.tf.tools.enhancer.EnhanceTool.EnhancerFileAction

All Implemented Interfaces

org.glassfish.pfl.basic.tools.file.Scanner.Action, org.glassfish.pfl.basic.func.UnaryPredicate, java.util.function.Predicate

References Deprecated

Scanner.Action is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Field Summary

Modifier and Type	Field and Description
private UnaryFunction<byte[], byte[]>	ea References Deprecated `UnaryFunction` is deprecated or references (maybe indirectly) at least one deprecated element.

Constructor Summary

Access	Constructor and Description
public	EnhancerFileAction(UnaryFunction<byte[], byte[]> ea) References Deprecated `UnaryFunction` is deprecated or references (maybe indirectly) at least one deprecated element.

Method Summary

Modifier and Type	Method and Description
public boolean	evaluate(FileWrapper fw) Implements org.glassfish.pfl.basic.func.UnaryPredicate.evaluate.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

ea	back to summary
private UnaryFunction<byte[], byte[]> ea References Deprecated `UnaryFunction` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information.

Constructor Detail

EnhancerFileAction	back to summary
public EnhancerFileAction(UnaryFunction<byte[], byte[]> ea) References Deprecated `UnaryFunction` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information.

Method Detail

evaluate	back to summary
public boolean evaluate(FileWrapper fw) Implements org.glassfish.pfl.basic.func.UnaryPredicate.evaluate. Annotations @Override

evaluate

back to summary

public boolean evaluate(FileWrapper fw)

Implements org.glassfish.pfl.basic.func.UnaryPredicate.evaluate.

Annotations

@Override

org.glassfish.pfl.tf.tools.enhancer back to summary

public final Enum EnhanceTool.ProcessingMode

Class Inheritance

extends Enum<EnhanceTool.ProcessingMode>

java.lang.Object
java.lang.Enum
org.glassfish.pfl.tf.tools.enhancer.EnhanceTool.ProcessingMode

Field Summary

Modifier and Type	Field and Description
public static final EnhanceTool.ProcessingMode	TimingPoints Only generate the timing points file: no changes to monitored class bytecode.
public static final EnhanceTool.ProcessingMode	TraceEnhance Update the class schema and insert tracing code.
public static final EnhanceTool.ProcessingMode	UpdateSchemas Update the class schemas for monitored classes, but don't insert the tracing code.

Constructor Summary

Access	Constructor and Description
private	ProcessingMode()

Method Summary

Modifier and Type	Method and Description
public static EnhanceTool.ProcessingMode	valueOf(String name)
public static EnhanceTool.ProcessingMode[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

TimingPoints	back to summary
public static final EnhanceTool.ProcessingMode TimingPoints Only generate the timing points file: no changes to monitored class bytecode.

TraceEnhance	back to summary
public static final EnhanceTool.ProcessingMode TraceEnhance Update the class schema and insert tracing code. Generate the TimingPoints file if the timingPointDir and timingPointClass options are set.

UpdateSchemas	back to summary
public static final EnhanceTool.ProcessingMode UpdateSchemas Update the class schemas for monitored classes, but don't insert the tracing code. Generate the TimingPoints file if the timingPointDir and timingPointClass options are set.

Constructor Detail

ProcessingMode	back to summary
private ProcessingMode()

Method Detail

valueOf	back to summary
public static EnhanceTool.ProcessingMode valueOf(String name)

values	back to summary
public static EnhanceTool.ProcessingMode[] values()

public Class EnhanceTool

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface EnhanceTool.Arguments

Method Summary

Method Detail

private Class EnhanceTool.EnhancerFileAction

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum EnhanceTool.ProcessingMode

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail