Package org.axonframework.messaging.core.interception.annotation

Class InterceptorChainParameterResolverFactory

java.lang.Object

org.axonframework.messaging.core.interception.annotation.InterceptorChainParameterResolverFactory

All Implemented Interfaces:

ParameterResolver<MessageHandlerInterceptorChain<?>>, ParameterResolverFactory

public class InterceptorChainParameterResolverFactory
extends Object
implements ParameterResolverFactory, ParameterResolver<MessageHandlerInterceptorChain<?>>

Parameter resolver factory that adds support for resolving current MessageHandlerInterceptorChain. This can function only if there is a ProcessingContext.

Since:

3.3.0

Author:

Milan Savic

Constructor Summary

Constructors

Constructor	Description
InterceptorChainParameterResolverFactory()

Method Summary

Modifier and Type	Method	Description
static <M extends Message> MessageStream<?>	callWithInterceptorChain(ProcessingContext processingContext, MessageHandlerInterceptorChain<M> interceptorChain, Function<ProcessingContext,MessageStream<?>> action)	Invoke the given action with the given interceptorChain being available for parameter injection.
static <M extends Message> ProcessingContext	contextWithInterceptorChain(ProcessingContext processingContext, MessageHandlerInterceptorChain<M> interceptorChain)	Deprecated, for removal: This API element is subject to removal in a future version. use callWithInterceptorChain(ProcessingContext, MessageHandlerInterceptorChain, Function) instead.
@Nullable ParameterResolver<MessageHandlerInterceptorChain<?>>	createInstance(Executable executable, Parameter[] parameters, int parameterIndex)	If available, creates a ParameterResolver instance that can provide a parameter of type parameterType for a given message.
static <M extends Message> @Nullable MessageHandlerInterceptorChain<M>	currentInterceptorChain(ProcessingContext processingContext)	Returns the current interceptor chain registered in the given processingContext, or null if none is present.
boolean	matches(ProcessingContext context)	Indicates whether this resolver is capable of providing a value for the given context.
CompletableFuture<MessageHandlerInterceptorChain<?>>	resolveParameterValue(ProcessingContext context)	Asynchronously resolves the parameter value from the context.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.axonframework.messaging.core.annotation.ParameterResolver

supportedPayloadType

Constructor Details

InterceptorChainParameterResolverFactory

public InterceptorChainParameterResolverFactory()

Method Details

callWithInterceptorChain

public static <M extends Message> MessageStream<?> callWithInterceptorChain(ProcessingContext processingContext,
 MessageHandlerInterceptorChain<M> interceptorChain,
 Function<ProcessingContext,MessageStream<?>> action)

Invoke the given action with the given interceptorChain being available for parameter injection. Because this parameter is not bound to a message, it is important to invoke handlers using this method.

Type Parameters:

M - the message type

Parameters:

processingContext - the ProcessingContext to use

interceptorChain - the InterceptorChain to consider for injection as parameter

action - the action to invoke

Returns:

the response from the invocation of given action

contextWithInterceptorChain

@Deprecated(since="5.2.0",
            forRemoval=true)
public static <M extends Message> ProcessingContext contextWithInterceptorChain(ProcessingContext processingContext,
 MessageHandlerInterceptorChain<M> interceptorChain)

Deprecated, for removal: This API element is subject to removal in a future version.

use callWithInterceptorChain(ProcessingContext, MessageHandlerInterceptorChain, Function) instead.

Creates a new ProcessingContext that carries the given interceptorChain as a resource, making it available for parameter injection via currentInterceptorChain(ProcessingContext).

Use this in synchronous code paths where the chain must be injected without going through the async callWithInterceptorChain(ProcessingContext, MessageHandlerInterceptorChain, java.util.function.Function) wrapper.

Type Parameters:

M - the message type

Parameters:

processingContext - the base context to extend

interceptorChain - the interceptor chain to register

Returns:

a new context with the chain registered as a resource

currentInterceptorChain

public static <M extends Message>
@Nullable MessageHandlerInterceptorChain<M> currentInterceptorChain(ProcessingContext processingContext)

Returns the current interceptor chain registered in the given processingContext, or null if none is present. The chain is stored via callWithInterceptorChain(ProcessingContext, MessageHandlerInterceptorChain, Function) and is available for the duration of that call.

Type Parameters:

M - the message type

Parameters:

processingContext - the processing context to retrieve the interceptor chain from

Returns:

the interceptor chain registered in the context, or null if not present

resolveParameterValue

public CompletableFuture<MessageHandlerInterceptorChain<?>> resolveParameterValue(ProcessingContext context)

Description copied from interface: ParameterResolver

Asynchronously resolves the parameter value from the context.

Specified by:

resolveParameterValue in interface ParameterResolver<MessageHandlerInterceptorChain<?>>

Parameters:

context - The current processing context.

Returns:

A CompletableFuture that will complete with the parameter value, or completes with null.

matches

public boolean matches(ProcessingContext context)

Description copied from interface: ParameterResolver

Indicates whether this resolver is capable of providing a value for the given context.

Specified by:

matches in interface ParameterResolver<MessageHandlerInterceptorChain<?>>

Parameters:

context - The current processing context.

Returns:

Returns true if this resolver can provide a value for the message, otherwise false.

createInstance

public @Nullable ParameterResolver<MessageHandlerInterceptorChain<?>> createInstance(Executable executable,
 Parameter[] parameters,
 int parameterIndex)

Description copied from interface: ParameterResolverFactory

If available, creates a ParameterResolver instance that can provide a parameter of type parameterType for a given message.

If the ParameterResolverFactory cannot provide a suitable ParameterResolver, returns null.

Specified by:

createInstance in interface ParameterResolverFactory

Parameters:

executable - The executable (constructor or method) to inspect.

parameters - The parameters on the executable to inspect.

parameterIndex - The index of the parameter to return a ParameterResolver for.

Returns:

A suitable ParameterResolver, or null if none is found.