Package org.axonframework.messaging.core.annotation

Class InterceptorChainParameterResolverFactory

java.lang.Object

org.axonframework.messaging.core.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 <R> R	callWithInterceptorChainSync(MessageHandlerInterceptorChain<?> interceptorChain, Callable<R> action)	Invoke the given action with the given interceptorChain being available for parameter injection.
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 MessageHandlerInterceptorChain<?>	currentInterceptorChain()	Returns the current interceptor chain registered for injection as a parameter.
static <M extends Message> MessageHandlerInterceptorChain<M>	currentInterceptorChain(ProcessingContext processingContext)
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

callWithInterceptorChainSync

public static <R> R callWithInterceptorChainSync(MessageHandlerInterceptorChain<?> interceptorChain,
 Callable<R> action)
                                          throws Exception

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:

R - The type of response expected from the invocation

Parameters:

interceptorChain - The InterceptorChain to consider for injection as parameter

action - The action to invoke

Returns:

The response from the invocation of given action

Throws:

Exception - any exception that occurs while invoking given action

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.

Parameters:

interceptorChain - The InterceptorChain to consider for injection as parameter

action - The action to invoke

Returns:

The response from the invocation of given action

currentInterceptorChain

public static MessageHandlerInterceptorChain<?> currentInterceptorChain()

Returns the current interceptor chain registered for injection as a parameter. Will return the instance passed in callWithInterceptorChainSync(MessageHandlerInterceptorChain, Callable). When invoked outside the scope of that method, this will return null.

Returns:

the InterceptorChain instance passed in callWithInterceptorChainSync(MessageHandlerInterceptorChain, Callable)

currentInterceptorChain

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

resolveParameterValue

@Nonnull
public CompletableFuture<MessageHandlerInterceptorChain<?>> resolveParameterValue(@Nonnull
 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(@Nonnull
 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

@Nullable
public ParameterResolver<MessageHandlerInterceptorChain<?>> createInstance(@Nonnull
 Executable executable,
 @Nonnull
 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.