Class ProxyingBeanDefinitionWriter

java.lang.Object

io.micronaut.aop.writer.ProxyingBeanDefinitionWriter

All Implemented Interfaces:

ProxyBuilder<ClassElement, MethodElement, List<OutputObjectDef>>, Buildable<List<OutputObjectDef>>, ElementProxyBuilder<OutputObjectDef>, OriginatingElements

Direct Known Subclasses:

AopProxyWriter, RuntimeProxyBeanDefinitionWriter

@NullUnmarked
@Internal
public abstract class ProxyingBeanDefinitionWriter
extends Object
implements ElementProxyBuilder<OutputObjectDef>

An abstract class for writing proxy bean definitions.

Since:

5.0

Author:

Denis Stepanov

Field Summary

Fields

Modifier and Type	Field	Description
protected final MethodElement	constructor
protected final ExecutableMethodsDefinitionWriter	executableMethodsDefinitionWriter
protected final boolean	implementInterface
protected final Set<AnnotationValue<?>>	interceptorBinding
protected final Set<ClassElement>	interfaceTypes
protected final boolean	isIntroduction
protected final boolean	isProxyTarget
protected final OriginatingElements	originatingElements
protected final BeanDefinitionWriter	parentWriter
protected final BeanDefinitionWriter	proxyBeanDefinitionWriter
protected final ClassElement	proxyType
protected final ClassElement	targetType
protected VisitorContext	visitorContext

Constructor Summary

Constructors

Constructor	Description
ProxyingBeanDefinitionWriter(MethodElement constructor, ClassElement proxyType, ClassElement targetType, boolean implementInterface, VisitorContext visitorContext, AnnotationValue<?>... interceptorBinding)	Constructs a new ProxyingBeanDefinitionWriter for the purposes of writing Introduction advise.
ProxyingBeanDefinitionWriter(MethodElement constructor, ClassElement proxyType, ClassElement targetType, VisitorContext visitorContext, AnnotationValue<?>... interceptorBinding)	Constructs a new ProxyingBeanDefinitionWriter for the purposes of writing Introduction advise.
ProxyingBeanDefinitionWriter(MethodElement constructor, ClassElement proxyType, ClassElement targetType, BeanDefinitionWriter parent, OptionalValues<Boolean> settings, VisitorContext visitorContext, AnnotationValue<?>... interceptorBinding)	Constructs a new ProxyingBeanDefinitionWriter for the given parent BeanDefinitionWriter and starting interceptors types.

Method Summary

Modifier and Type	Method	Description
ProxyingBeanDefinitionWriter	addAroundMethod(MethodElement methodElement)	Adds a method that should participate in around advice.
ProxyingBeanDefinitionWriter	addIntroductionMethod(MethodElement methodElement)	Adds an introduction method implemented directly by the proxy.
void	addOriginatingElement(Element element)	Add another element that should be included in the originating elements.
ProxyingBeanDefinitionWriter	addProxyMethod(MethodElement methodElement)	Adds a proxied method that delegates to the target.
ElementBeanDefinitionBuilder<OutputObjectDef>	beanDefinitionBuilder()
List<OutputObjectDef>	build()	Builds the result.
protected final @Nullable MethodElement	findOverriddenBy(MethodElement methodElement)	Find overridden by method with a different signature.
protected static MethodElement	getConstructor(ClassElement type)
protected @Nullable String	getCustomBeanDefinitionName()	Allows subclasses to provide a custom bean definition name for the proxy.
Element[]	getOriginatingElements()
protected boolean	getProxyTarget(ClassElement targetType, BeanDefinitionWriter parent, OptionalValues<Boolean> settings)
ProxyingBeanDefinitionWriter	implementInterface(ClassElement interfaceElement)	Adds an interface to be implemented by the proxy.
void	postConstructor()
protected final void	processAlreadyVisitedMethods(BeanDefinitionWriter parent)
protected static String	toTypeString(ClassElement p)
protected void	visitInterceptorBinding(AnnotationValue<?>... interceptorBinding)	visitInterceptorTypes.

Methods inherited from class Object

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

Field Details

proxyType

protected final ClassElement proxyType

constructor

protected final MethodElement constructor

targetType

protected final ClassElement targetType

proxyBeanDefinitionWriter

protected final BeanDefinitionWriter proxyBeanDefinitionWriter

interceptorBinding

protected final Set<AnnotationValue<?>> interceptorBinding

parentWriter

protected final BeanDefinitionWriter parentWriter

isProxyTarget

protected final boolean isProxyTarget

isIntroduction

protected final boolean isIntroduction

implementInterface

protected final boolean implementInterface

interfaceTypes

protected final Set<ClassElement> interfaceTypes

visitorContext

protected VisitorContext visitorContext

originatingElements

protected final OriginatingElements originatingElements

executableMethodsDefinitionWriter

protected final ExecutableMethodsDefinitionWriter executableMethodsDefinitionWriter

Constructor Details

ProxyingBeanDefinitionWriter

public ProxyingBeanDefinitionWriter(MethodElement constructor,
 ClassElement proxyType,
 ClassElement targetType,
 BeanDefinitionWriter parent,
 OptionalValues<Boolean> settings,
 VisitorContext visitorContext,
 AnnotationValue<?>... interceptorBinding)

Constructs a new ProxyingBeanDefinitionWriter for the given parent BeanDefinitionWriter and starting interceptors types.

Additional Interceptor types can be added downstream with visitInterceptorBinding(AnnotationValue[]) .

Parameters:

constructor - The constructor used to materialize the proxy

proxyType - The proxyType

targetType - The targetType

parent - The parent BeanDefinitionWriter

settings - optional setting

visitorContext - The visitor context

interceptorBinding - The interceptor binding of the Interceptor instances to be injected

ProxyingBeanDefinitionWriter

public ProxyingBeanDefinitionWriter(MethodElement constructor,
 ClassElement proxyType,
 ClassElement targetType,
 VisitorContext visitorContext,
 AnnotationValue<?>... interceptorBinding)

Constructs a new ProxyingBeanDefinitionWriter for the purposes of writing Introduction advise.

Parameters:

constructor - The constructor

proxyType - The proxy type

targetType - The target type

visitorContext - The visitor context

interceptorBinding - The interceptor types

ProxyingBeanDefinitionWriter

public ProxyingBeanDefinitionWriter(MethodElement constructor,
 ClassElement proxyType,
 ClassElement targetType,
 boolean implementInterface,
 VisitorContext visitorContext,
 AnnotationValue<?>... interceptorBinding)

Constructs a new ProxyingBeanDefinitionWriter for the purposes of writing Introduction advise.

Parameters:

constructor - The constructor

proxyType - The proxy type

targetType - The target type

implementInterface - Whether the interface should be implemented. If false the interfaceTypes argument should contain at least one entry

visitorContext - The visitor context

interceptorBinding - The interceptor binding

Method Details

getCustomBeanDefinitionName

protected @Nullable String getCustomBeanDefinitionName()

Allows subclasses to provide a custom bean definition name for the proxy. Implementations must return either null to use the default naming strategy or a fully qualified class name unique within the module.

Returns:

The custom bean definition name or null to use the default

implementInterface

public ProxyingBeanDefinitionWriter implementInterface(ClassElement interfaceElement)

Description copied from interface: ProxyBuilder

Adds an interface to be implemented by the proxy.

Specified by:

implementInterface in interface ProxyBuilder<ClassElement, MethodElement, List<OutputObjectDef>>

Parameters:

interfaceElement - The interface element

addProxyMethod

public ProxyingBeanDefinitionWriter addProxyMethod(MethodElement methodElement)

Description copied from interface: ProxyBuilder

Adds a proxied method that delegates to the target.

Specified by:

addProxyMethod in interface ProxyBuilder<ClassElement, MethodElement, List<OutputObjectDef>>

Parameters:

methodElement - The method to proxy

getConstructor

protected static MethodElement getConstructor(ClassElement type)

getProxyTarget

protected boolean getProxyTarget(ClassElement targetType,
 BeanDefinitionWriter parent,
 OptionalValues<Boolean> settings)

Parameters:

targetType - The target type

parent - The parent

settings - The settings

Returns:

is proxy target

build

public List<OutputObjectDef> build()

Description copied from interface: Buildable

Builds the result.

Specified by:

build in interface Buildable<List<OutputObjectDef>>

Returns:

The builder result

postConstructor

public void postConstructor()

visitInterceptorBinding

protected void visitInterceptorBinding(AnnotationValue<?>... interceptorBinding)

visitInterceptorTypes.

Parameters:

interceptorBinding - the interceptor binding

processAlreadyVisitedMethods

protected final void processAlreadyVisitedMethods(BeanDefinitionWriter parent)

getOriginatingElements

public Element[] getOriginatingElements()

Specified by:

getOriginatingElements in interface OriginatingElements

Returns:

The elements where the bean definition originated from as an array.

addOriginatingElement

public void addOriginatingElement(Element element)

Description copied from interface: OriginatingElements

Add another element that should be included in the originating elements.

Specified by:

addOriginatingElement in interface OriginatingElements

Parameters:

element - The element to add

toTypeString

protected static String toTypeString(ClassElement p)

Parameters:

p - The class element

Returns:

The string representation

findOverriddenBy

protected final @Nullable MethodElement findOverriddenBy(MethodElement methodElement)

Find overridden by method with a different signature.

Parameters:

methodElement - The method element

Returns:

the overridden

addAroundMethod

public ProxyingBeanDefinitionWriter addAroundMethod(MethodElement methodElement)

Description copied from interface: ProxyBuilder

Adds a method that should participate in around advice.

Specified by:

addAroundMethod in interface ProxyBuilder<ClassElement, MethodElement, List<OutputObjectDef>>

Parameters:

methodElement - The method element

addIntroductionMethod

public ProxyingBeanDefinitionWriter addIntroductionMethod(MethodElement methodElement)

Description copied from interface: ProxyBuilder

Adds an introduction method implemented directly by the proxy.

Specified by:

addIntroductionMethod in interface ProxyBuilder<ClassElement, MethodElement, List<OutputObjectDef>>

Parameters:

methodElement - The method to introduce

beanDefinitionBuilder

public ElementBeanDefinitionBuilder<OutputObjectDef> beanDefinitionBuilder()

Specified by:

beanDefinitionBuilder in interface ElementProxyBuilder<OutputObjectDef>

Returns:

The underlying bean definition builder used to materialize the proxy