io.micronaut.aop.chain

Class InterceptorChain<B,R>

java.lang.Object

io.micronaut.aop.chain.InterceptorChain<B,R>

Type Parameters:

B - The declaring type

R - The result of the method call

All Implemented Interfaces:

InvocationContext<B,R>, AnnotationMetadata, AnnotationMetadataDelegate, AnnotationMetadataProvider, AnnotationSource, AttributeHolder, MutableAttributeHolder, Executable<B,R>

Direct Known Subclasses:

MethodInterceptorChain

@Internal
public class InterceptorChain<B,R>
extends Object
implements InvocationContext<B,R>

An internal representation of the Interceptor chain. This class implements InvocationContext and is consumed by the framework itself and should not be used directly in application code.

Since:

1.0

Author:

Graeme Rocher

Field Summary

Fields

Modifier and Type	Field and Description
protected MutableConvertibleValues<Object>	attributes
protected ExecutableMethod<B,R>	executionHandle
protected int	index
protected int	interceptorCount
protected Interceptor<B,R>[]	interceptors
protected static org.slf4j.Logger	LOG Used by subclasses!
protected Object[]	originalParameters
protected Map<String,MutableArgumentValue<?>>	parameters
protected B	target

Fields inherited from interface io.micronaut.core.annotation.AnnotationMetadata

CLASS_NAME_SUFFIX, EMPTY_METADATA, VALUE_MEMBER

Fields inherited from interface io.micronaut.core.annotation.AnnotationSource

EMPTY

Constructor Summary

Constructors

Constructor and Description
InterceptorChain(Interceptor<B,R>[] interceptors, B target, ExecutableMethod<B,R> method, Object... originalParameters) Constructor.

Method Summary

Modifier and Type	Method and Description
AnnotationMetadata	getAnnotationMetadata() Supplies the metadata.
Argument[]	getArguments() The required argument types.
MutableConvertibleValues<Object>	getAttributes() Overrides the default AttributeHolder.getAttributes() method to return a mutable object.
Map<String,MutableArgumentValue<?>>	getParameters() Returns the current parameters as a map of mutable argument values.
Object[]	getParameterValues() Returns the current state of the parameters as an array by parameter index.
B	getTarget()
R	invoke(B instance, Object... arguments) Invokes the method.
R	proceed() Proceeds with the invocation.
R	proceed(Interceptor from) Proceeds with the invocation using the given interceptor as a position to start from.
static Interceptor[]	resolveAroundInterceptors(BeanContext beanContext, ExecutableMethod<?,?> method, Interceptor... interceptors) Deprecated. Replaced by resolveAroundInterceptors(BeanContext, ExecutableMethod, List)
static Interceptor[]	resolveAroundInterceptors(BeanContext beanContext, ExecutableMethod<?,?> method, List<BeanRegistration<Interceptor<?,?>>> interceptors) Resolves the Around interceptors for a method.
protected static Collection<AnnotationValue<?>>	resolveInterceptorValues(AnnotationMetadata annotationMetadata, InterceptorKind kind) Resolve interceptor binding for the given annotation metadata and kind.
static Interceptor[]	resolveIntroductionInterceptors(BeanContext beanContext, ExecutableMethod<?,?> method, Interceptor... interceptors) Deprecated.
static Interceptor[]	resolveIntroductionInterceptors(BeanContext beanContext, ExecutableMethod<?,?> method, List<BeanRegistration<Interceptor<?,?>>> interceptors) Resolves the Introduction interceptors for a method.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.aop.InvocationContext

getDeclaringType, getKind, getParameters, getParameterValueMap, getParameterValues, proceed, setAttribute

Methods inherited from interface io.micronaut.core.annotation.AnnotationMetadataDelegate

booleanValue, booleanValue, booleanValue, booleanValue, classValue, classValue, classValue, classValue, classValues, classValues, classValues, classValues, doubleValue, doubleValue, doubleValue, enumValue, enumValue, enumValue, enumValue, enumValues, enumValues, enumValues, enumValues, findAnnotation, findAnnotation, findDeclaredAnnotation, findDeclaredAnnotation, findRepeatableAnnotation, findRepeatableAnnotation, getAnnotation, getAnnotation, getAnnotationNameByStereotype, getAnnotationNameByStereotype, getAnnotationNames, getAnnotationNamesByStereotype, getAnnotationNamesByStereotype, getAnnotationType, getAnnotationType, getAnnotationTypeByStereotype, getAnnotationTypeByStereotype, getAnnotationTypesByStereotype, getAnnotationTypesByStereotype, getAnnotationTypesByStereotype, getAnnotationValuesByType, getDeclaredAnnotation, getDeclaredAnnotation, getDeclaredAnnotationNameByStereotype, getDeclaredAnnotationNames, getDeclaredAnnotationNamesByStereotype, getDeclaredAnnotationTypeByStereotype, getDeclaredAnnotationTypeByStereotype, getDeclaredAnnotationValuesByType, getDeclaredMetadata, getDefaultValue, getDefaultValue, getDefaultValue, getDefaultValue, getDefaultValues, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValues, getValues, hasAnnotation, hasAnnotation, hasDeclaredAnnotation, hasDeclaredAnnotation, hasDeclaredStereotype, hasDeclaredStereotype, hasDeclaredStereotype, hasPropertyExpressions, hasSimpleAnnotation, hasSimpleDeclaredAnnotation, hasStereotype, hasStereotype, hasStereotype, hasStereotype, intValue, intValue, intValue, isAnnotationPresent, isDeclaredAnnotationPresent, isEmpty, isFalse, isFalse, isPresent, isPresent, isRepeatableAnnotation, isRepeatableAnnotation, isTrue, isTrue, longValue, longValue, stringValue, stringValue, stringValue, stringValue, stringValues, stringValues, stringValues, stringValues, synthesize, synthesize, synthesizeAll, synthesizeAnnotationsByType, synthesizeDeclared, synthesizeDeclared, synthesizeDeclared, synthesizeDeclaredAnnotationsByType

Methods inherited from interface io.micronaut.core.annotation.AnnotationMetadata

getAnnotationValuesByName, getDeclaredAnnotationValuesByName, getValues, hasDeclaredStereotype, isAnnotationPresent, isDeclaredAnnotationPresent

Methods inherited from interface io.micronaut.core.attr.MutableAttributeHolder

getAttributes, removeAttribute

Methods inherited from interface io.micronaut.core.attr.AttributeHolder

getAttribute, getAttribute

Field Detail

target

protected final B target

executionHandle

protected final ExecutableMethod<B,R> executionHandle

LOG

protected static final org.slf4j.Logger LOG

Used by subclasses!

interceptors

protected final Interceptor<B,R>[] interceptors

originalParameters

protected final Object[] originalParameters

interceptorCount

protected final int interceptorCount

attributes

protected volatile MutableConvertibleValues<Object> attributes

index

protected int index

parameters

protected volatile Map<String,MutableArgumentValue<?>> parameters

Constructor Detail

InterceptorChain

public InterceptorChain(Interceptor<B,R>[] interceptors,
                        B target,
                        ExecutableMethod<B,R> method,
                        Object... originalParameters)

Constructor.

Parameters:

interceptors - array of interceptors

target - target type

method - result method

originalParameters - parameters

Method Detail

getAnnotationMetadata

public AnnotationMetadata getAnnotationMetadata()

Description copied from interface: AnnotationMetadataProvider

Supplies the metadata. Defaults to AnnotationMetadata.EMPTY_METADATA.

Specified by:

getAnnotationMetadata in interface AnnotationMetadataProvider

Returns:

The AnnotationMetadata

getArguments

public Argument[] getArguments()

Description copied from interface: Executable

The required argument types.

Specified by:

getArguments in interface Executable<B,R>

Returns:

The arguments

invoke

public R invoke(B instance,
                Object... arguments)

Description copied from interface: Executable

Invokes the method.

Specified by:

invoke in interface Executable<B,R>

Parameters:

instance - The instance

arguments - The arguments

Returns:

The result

getTarget

public B getTarget()

Specified by:

getTarget in interface InvocationContext<B,R>

Returns:

The target object

proceed

public R proceed()
          throws RuntimeException

Description copied from interface: InvocationContext

Proceeds with the invocation. If this is the last interceptor in the chain then the final implementation method is invoked

Specified by:

proceed in interface InvocationContext<B,R>

Returns:

The return value of the method

Throws:

RuntimeException - chain may throw RTE

resolveAroundInterceptors

@Internal
public static Interceptor[] resolveAroundInterceptors(@Nullable
                                                                BeanContext beanContext,
                                                                ExecutableMethod<?,?> method,
                                                                List<BeanRegistration<Interceptor<?,?>>> interceptors)

Resolves the Around interceptors for a method.

Parameters:

beanContext - bean context passed in

method - The method

interceptors - The array of interceptors

Returns:

The filtered array of interceptors

resolveIntroductionInterceptors

@Internal
public static Interceptor[] resolveIntroductionInterceptors(@Nullable
                                                                      BeanContext beanContext,
                                                                      ExecutableMethod<?,?> method,
                                                                      List<BeanRegistration<Interceptor<?,?>>> interceptors)

Resolves the Introduction interceptors for a method.

Parameters:

beanContext - bean context passed in

method - The method

interceptors - The array of interceptors

Returns:

The filtered array of interceptors

resolveAroundInterceptors

@Internal
 @Deprecated
public static Interceptor[] resolveAroundInterceptors(@Nullable
                                                                             BeanContext beanContext,
                                                                             ExecutableMethod<?,?> method,
                                                                             Interceptor... interceptors)

Deprecated. Replaced by resolveAroundInterceptors(BeanContext, ExecutableMethod, List)

Resolves the Around interceptors for a method.

Parameters:

beanContext - bean context passed in

method - The method

interceptors - The array of interceptors

Returns:

The filtered array of interceptors

resolveIntroductionInterceptors

@Internal
 @Deprecated
public static Interceptor[] resolveIntroductionInterceptors(@Nullable
                                                                                   BeanContext beanContext,
                                                                                   ExecutableMethod<?,?> method,
                                                                                   Interceptor... interceptors)

Deprecated.

Resolves the interceptors for a method for Introduction advise. For Introduction advise any Around advise interceptors are applied first

Parameters:

beanContext - Bean Context

method - The method

interceptors - The array of interceptors

Returns:

The filtered array of interceptors

getParameterValues

@NonNull
public Object[] getParameterValues()

Description copied from interface: InvocationContext

Returns the current state of the parameters as an array by parameter index. Note that mutations to the array have no effect. If you wish to mutate the parameters use InvocationContext.getParameters() and the MutableArgumentValue interface instead

Specified by:

getParameterValues in interface InvocationContext<B,R>

Returns:

The bound ArgumentValue instances

getAttributes

@NonNull
public MutableConvertibleValues<Object> getAttributes()

Description copied from interface: MutableAttributeHolder

Overrides the default AttributeHolder.getAttributes() method to return a mutable object.

Specified by:

getAttributes in interface AttributeHolder

Specified by:

getAttributes in interface MutableAttributeHolder

Returns:

The mutable attributes

getParameters

@NonNull
public Map<String,MutableArgumentValue<?>> getParameters()

Description copied from interface: InvocationContext

Returns the current parameters as a map of mutable argument values. This method allows mutation of the argument values and is generally more expensive than using InvocationContext.getParameterValues() and Executable.getArguments() directly, hence should be used with care.

Specified by:

getParameters in interface InvocationContext<B,R>

Returns:

The bound ArgumentValue instances

proceed

public R proceed(@NonNull
                 Interceptor from)
          throws RuntimeException

Description copied from interface: InvocationContext

Proceeds with the invocation using the given interceptor as a position to start from. Mainly useful for Introduction advise where you want to invoke the target multiple times or where you want to repeat the entire chain.

Specified by:

proceed in interface InvocationContext<B,R>

Parameters:

from - The interceptor to start from (note: will not be included in the execution)

Returns:

The return value of the method

Throws:

RuntimeException - chain may throw RTE

resolveInterceptorValues

@NonNull
protected static Collection<AnnotationValue<?>> resolveInterceptorValues(@NonNull
                                                                                  AnnotationMetadata annotationMetadata,
                                                                                  @NonNull
                                                                                  InterceptorKind kind)

Resolve interceptor binding for the given annotation metadata and kind.

Parameters:

annotationMetadata - The annotation metadata

kind - The kind

Returns:

The binding

Since:

3.3.0