org.apache.skywalking.apm.agent.core.plugin

Class AbstractClassEnhancePluginDefine

java.lang.Object

org.apache.skywalking.apm.agent.core.plugin.AbstractClassEnhancePluginDefine

Direct Known Subclasses:

ClassEnhancePluginDefine

public abstract class AbstractClassEnhancePluginDefine
extends Object

Basic abstract class of all sky-walking auto-instrumentation plugins.

It provides the outline of enhancing the target class. If you want to know more about enhancing, you should go to see ClassEnhancePluginDefine

Constructor Summary

Constructors

Constructor and Description
AbstractClassEnhancePluginDefine()

Method Summary

Modifier and Type	Method and Description
net.bytebuddy.dynamic.DynamicType.Builder<?>	define(net.bytebuddy.description.type.TypeDescription typeDescription, net.bytebuddy.dynamic.DynamicType.Builder<?> builder, ClassLoader classLoader, EnhanceContext context) Main entrance of enhancing the class.
protected abstract net.bytebuddy.dynamic.DynamicType.Builder<?>	enhance(net.bytebuddy.description.type.TypeDescription typeDescription, net.bytebuddy.dynamic.DynamicType.Builder<?> newClassBuilder, ClassLoader classLoader, EnhanceContext context)
protected abstract ClassMatch	enhanceClass() Define the ClassMatch for filtering class.
abstract ConstructorInterceptPoint[]	getConstructorsInterceptPoints() Constructor methods intercept point.
abstract InstanceMethodsInterceptPoint[]	getInstanceMethodsInterceptPoints() Instance methods intercept point.
abstract StaticMethodsInterceptPoint[]	getStaticMethodsInterceptPoints() Static methods intercept point.
boolean	isBootstrapInstrumentation()
protected String[]	witnessClasses() Witness classname list.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractClassEnhancePluginDefine

public AbstractClassEnhancePluginDefine()

Method Detail

define

public net.bytebuddy.dynamic.DynamicType.Builder<?> define(net.bytebuddy.description.type.TypeDescription typeDescription,
                                                           net.bytebuddy.dynamic.DynamicType.Builder<?> builder,
                                                           ClassLoader classLoader,
                                                           EnhanceContext context)
                                                    throws PluginException

Main entrance of enhancing the class.

Parameters:

typeDescription - target class description.

builder - byte-buddy's builder to manipulate target class's bytecode.

classLoader - load the given transformClass

Returns:

the new builder, or null if not be enhanced.

Throws:

PluginException - when set builder failure.

enhance

protected abstract net.bytebuddy.dynamic.DynamicType.Builder<?> enhance(net.bytebuddy.description.type.TypeDescription typeDescription,
                                                                        net.bytebuddy.dynamic.DynamicType.Builder<?> newClassBuilder,
                                                                        ClassLoader classLoader,
                                                                        EnhanceContext context)
                                                                 throws PluginException

Throws:

PluginException

enhanceClass

protected abstract ClassMatch enhanceClass()

Define the ClassMatch for filtering class.

Returns:

ClassMatch

witnessClasses

protected String[] witnessClasses()

Witness classname list. Why need witness classname? Let's see like this: A library existed two released versions (like 1.0, 2.0), which include the same target classes, but because of version iterator, they may have the same name, but different methods, or different method arguments list. So, if I want to target the particular version (let's say 1.0 for example), version number is obvious not an option, this is the moment you need "Witness classes". You can add any classes only in this particular release version ( something like class com.company.1.x.A, only in 1.0 ), and you can achieve the goal.

Returns:

isBootstrapInstrumentation

public boolean isBootstrapInstrumentation()

getConstructorsInterceptPoints

public abstract ConstructorInterceptPoint[] getConstructorsInterceptPoints()

Constructor methods intercept point. See ConstructorInterceptPoint

Returns:

collections of ConstructorInterceptPoint

getInstanceMethodsInterceptPoints

public abstract InstanceMethodsInterceptPoint[] getInstanceMethodsInterceptPoints()

Instance methods intercept point. See InstanceMethodsInterceptPoint

Returns:

collections of InstanceMethodsInterceptPoint

getStaticMethodsInterceptPoints

public abstract StaticMethodsInterceptPoint[] getStaticMethodsInterceptPoints()

Static methods intercept point. See StaticMethodsInterceptPoint

Returns:

collections of StaticMethodsInterceptPoint