Package org.axonframework.extension.reactor.messaging.core.interception

Class DefaultReactorDispatchInterceptorRegistry

java.lang.Object

org.axonframework.extension.reactor.messaging.core.interception.DefaultReactorDispatchInterceptorRegistry

All Implemented Interfaces:

DescribableComponent, ReactorDispatchInterceptorRegistry

@Internal
public class DefaultReactorDispatchInterceptorRegistry
extends Object
implements ReactorDispatchInterceptorRegistry

Default implementation of the ReactorDispatchInterceptorRegistry, maintaining lists of CommandMessage, EventMessage, and QueryMessage-specific ReactorMessageDispatchInterceptors.

This implementation ensures given interceptor builders methods are only invoked once. Note that this does not apply to given factories!

Since:

5.1.0

Author:

Theo Emanuelsson

Constructor Summary

Constructors

Constructor	Description
DefaultReactorDispatchInterceptorRegistry()

Method Summary

Modifier and Type	Method	Description
List<ReactorMessageDispatchInterceptor<? super CommandMessage>>	commandInterceptors(Configuration config, Class<?> componentType, @Nullable String componentName)	Returns the list of ReactorMessageDispatchInterceptors registered for CommandMessages for a specific componentType and componentName.
void	describeTo(ComponentDescriptor descriptor)	Describe the properties of this DescribableComponent with the given descriptor.
List<ReactorMessageDispatchInterceptor<? super EventMessage>>	eventInterceptors(Configuration config, Class<?> componentType, @Nullable String componentName)	Returns the list of ReactorMessageDispatchInterceptors registered for EventMessages for a specific componentType and componentName.
List<ReactorMessageDispatchInterceptor<? super QueryMessage>>	queryInterceptors(Configuration config, Class<?> componentType, @Nullable String componentName)	Returns the list of ReactorMessageDispatchInterceptors registered for QueryMessages for a specific componentType and componentName.
ReactorDispatchInterceptorRegistry	registerCommandInterceptor(ComponentBuilder<ReactorMessageDispatchInterceptor<? super CommandMessage>> interceptorBuilder)	Registers the given interceptorBuilder for a CommandMessage-specific ReactorMessageDispatchInterceptor.
ReactorDispatchInterceptorRegistry	registerCommandInterceptor(ReactorDispatchInterceptorFactory<? super CommandMessage> interceptorFactory)	Registers the given component-aware interceptorFactory for a CommandMessage-specific ReactorMessageDispatchInterceptor.
ReactorDispatchInterceptorRegistry	registerEventInterceptor(ComponentBuilder<ReactorMessageDispatchInterceptor<? super EventMessage>> interceptorBuilder)	Registers the given interceptorBuilder for an EventMessage-specific ReactorMessageDispatchInterceptor.
ReactorDispatchInterceptorRegistry	registerEventInterceptor(ReactorDispatchInterceptorFactory<? super EventMessage> interceptorFactory)	Registers the given component-aware interceptorFactory for an EventMessage-specific ReactorMessageDispatchInterceptor.
ReactorDispatchInterceptorRegistry	registerInterceptor(ComponentBuilder<ReactorMessageDispatchInterceptor<Message>> interceptorBuilder)	Registers the given interceptorBuilder for a generic Message ReactorMessageDispatchInterceptor.
ReactorDispatchInterceptorRegistry	registerInterceptor(ReactorDispatchInterceptorFactory<Message> interceptorFactory)	Registers the given component-aware interceptorFactory for a generic Message ReactorMessageDispatchInterceptor.
ReactorDispatchInterceptorRegistry	registerQueryInterceptor(ComponentBuilder<ReactorMessageDispatchInterceptor<? super QueryMessage>> interceptorBuilder)	Registers the given interceptorBuilder for a QueryMessage-specific ReactorMessageDispatchInterceptor.
ReactorDispatchInterceptorRegistry	registerQueryInterceptor(ReactorDispatchInterceptorFactory<? super QueryMessage> interceptorFactory)	Registers the given component-aware interceptorFactory for a QueryMessage-specific ReactorMessageDispatchInterceptor.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultReactorDispatchInterceptorRegistry

public DefaultReactorDispatchInterceptorRegistry()

Method Details

registerInterceptor

public ReactorDispatchInterceptorRegistry registerInterceptor(ComponentBuilder<ReactorMessageDispatchInterceptor<Message>> interceptorBuilder)

Description copied from interface: ReactorDispatchInterceptorRegistry

Registers the given interceptorBuilder for a generic Message ReactorMessageDispatchInterceptor.

Registering an interceptor per a ComponentBuilder ensures the interceptor is only built once.

Specified by:

registerInterceptor in interface ReactorDispatchInterceptorRegistry

Parameters:

interceptorBuilder - the generic Message ReactorMessageDispatchInterceptor builder to register

Returns:

this registry, for fluent interfacing

registerInterceptor

public ReactorDispatchInterceptorRegistry registerInterceptor(ReactorDispatchInterceptorFactory<Message> interceptorFactory)

Description copied from interface: ReactorDispatchInterceptorRegistry

Registers the given component-aware interceptorFactory for a generic Message ReactorMessageDispatchInterceptor.

The factory will receive the component type and name when the interceptor is retrieved allowing for component-specific customization of the interceptor. Registering an interceptor per a ReactorDispatchInterceptorFactory enforces construction of the interceptor for every invocation of the factory, ensuring uniqueness per given type and name. If the interceptor will be identical regardless of the given type or name, please use ReactorDispatchInterceptorRegistry.registerInterceptor(ComponentBuilder) instead.

Specified by:

registerInterceptor in interface ReactorDispatchInterceptorRegistry

Parameters:

interceptorFactory - the generic Message ReactorMessageDispatchInterceptor factory to register

Returns:

this registry, for fluent interfacing

registerCommandInterceptor

public ReactorDispatchInterceptorRegistry registerCommandInterceptor(ComponentBuilder<ReactorMessageDispatchInterceptor<? super CommandMessage>> interceptorBuilder)

Description copied from interface: ReactorDispatchInterceptorRegistry

Registers the given interceptorBuilder for a CommandMessage-specific ReactorMessageDispatchInterceptor.

Registering an interceptor per a ComponentBuilder ensures the interceptor is only built once.

Specified by:

registerCommandInterceptor in interface ReactorDispatchInterceptorRegistry

Parameters:

interceptorBuilder - the CommandMessage-specific ReactorMessageDispatchInterceptor builder to register

Returns:

this registry, for fluent interfacing

registerCommandInterceptor

public ReactorDispatchInterceptorRegistry registerCommandInterceptor(ReactorDispatchInterceptorFactory<? super CommandMessage> interceptorFactory)

Description copied from interface: ReactorDispatchInterceptorRegistry

Registers the given component-aware interceptorFactory for a CommandMessage-specific ReactorMessageDispatchInterceptor.

The factory will receive the component type and name when the interceptor is retrieved allowing for component-specific customization of the interceptor. Registering an interceptor per a ReactorDispatchInterceptorFactory enforces construction of the interceptor for every invocation of the factory, ensuring uniqueness per given type and name. If the interceptor will be identical regardless of the given type or name, please use ReactorDispatchInterceptorRegistry.registerCommandInterceptor(ComponentBuilder) instead.

Specified by:

registerCommandInterceptor in interface ReactorDispatchInterceptorRegistry

Parameters:

interceptorFactory - the CommandMessage-specific ReactorMessageDispatchInterceptor factory to register

Returns:

this registry, for fluent interfacing

registerEventInterceptor

public ReactorDispatchInterceptorRegistry registerEventInterceptor(ComponentBuilder<ReactorMessageDispatchInterceptor<? super EventMessage>> interceptorBuilder)

Description copied from interface: ReactorDispatchInterceptorRegistry

Registers the given interceptorBuilder for an EventMessage-specific ReactorMessageDispatchInterceptor.

Registering an interceptor per a ComponentBuilder ensures the interceptor is only built once.

Specified by:

registerEventInterceptor in interface ReactorDispatchInterceptorRegistry

Parameters:

interceptorBuilder - the EventMessage-specific ReactorMessageDispatchInterceptor builder to register

Returns:

this registry, for fluent interfacing

registerEventInterceptor

public ReactorDispatchInterceptorRegistry registerEventInterceptor(ReactorDispatchInterceptorFactory<? super EventMessage> interceptorFactory)

Description copied from interface: ReactorDispatchInterceptorRegistry

Registers the given component-aware interceptorFactory for an EventMessage-specific ReactorMessageDispatchInterceptor.

The factory will receive the component type and name when the interceptor is retrieved allowing for component-specific customization of the interceptor. Registering an interceptor per a ReactorDispatchInterceptorFactory enforces construction of the interceptor for every invocation of the factory, ensuring uniqueness per given type and name. If the interceptor will be identical regardless of the given type or name, please use ReactorDispatchInterceptorRegistry.registerEventInterceptor(ComponentBuilder) instead.

Specified by:

registerEventInterceptor in interface ReactorDispatchInterceptorRegistry

Parameters:

interceptorFactory - the EventMessage-specific ReactorMessageDispatchInterceptor factory to register

Returns:

this registry, for fluent interfacing

registerQueryInterceptor

public ReactorDispatchInterceptorRegistry registerQueryInterceptor(ComponentBuilder<ReactorMessageDispatchInterceptor<? super QueryMessage>> interceptorBuilder)

Description copied from interface: ReactorDispatchInterceptorRegistry

Registers the given interceptorBuilder for a QueryMessage-specific ReactorMessageDispatchInterceptor.

Registering an interceptor per a ComponentBuilder ensures the interceptor is only built once.

Specified by:

registerQueryInterceptor in interface ReactorDispatchInterceptorRegistry

Parameters:

interceptorBuilder - the QueryMessage-specific ReactorMessageDispatchInterceptor builder to register

Returns:

this registry, for fluent interfacing

registerQueryInterceptor

public ReactorDispatchInterceptorRegistry registerQueryInterceptor(ReactorDispatchInterceptorFactory<? super QueryMessage> interceptorFactory)

Description copied from interface: ReactorDispatchInterceptorRegistry

Registers the given component-aware interceptorFactory for a QueryMessage-specific ReactorMessageDispatchInterceptor.

The factory will receive the component type and name when the interceptor is retrieved allowing for component-specific customization of the interceptor. Registering an interceptor per a ReactorDispatchInterceptorFactory enforces construction of the interceptor for every invocation of the factory, ensuring uniqueness per given type and name. If the interceptor will be identical regardless of the given type or name, please use ReactorDispatchInterceptorRegistry.registerQueryInterceptor(ComponentBuilder) instead.

Specified by:

registerQueryInterceptor in interface ReactorDispatchInterceptorRegistry

Parameters:

interceptorFactory - the QueryMessage-specific ReactorMessageDispatchInterceptor factory to register

Returns:

this registry, for fluent interfacing

commandInterceptors

public List<ReactorMessageDispatchInterceptor<? super CommandMessage>> commandInterceptors(Configuration config,
 Class<?> componentType,
 @Nullable String componentName)

Description copied from interface: ReactorDispatchInterceptorRegistry

Returns the list of ReactorMessageDispatchInterceptors registered for CommandMessages for a specific componentType and componentName.

Specified by:

commandInterceptors in interface ReactorDispatchInterceptorRegistry

Parameters:

config - the configuration to build all CommandMessage-specific ReactorMessageDispatchInterceptors with

componentType - the type of the component being intercepted

componentName - the name of the component being intercepted

Returns:

the list of command dispatch interceptors

eventInterceptors

public List<ReactorMessageDispatchInterceptor<? super EventMessage>> eventInterceptors(Configuration config,
 Class<?> componentType,
 @Nullable String componentName)

Description copied from interface: ReactorDispatchInterceptorRegistry

Returns the list of ReactorMessageDispatchInterceptors registered for EventMessages for a specific componentType and componentName.

Specified by:

eventInterceptors in interface ReactorDispatchInterceptorRegistry

Parameters:

config - the configuration to build all EventMessage-specific ReactorMessageDispatchInterceptors with

componentType - the type of the component being intercepted

componentName - the name of the component being intercepted

Returns:

the list of event dispatch interceptors

queryInterceptors

public List<ReactorMessageDispatchInterceptor<? super QueryMessage>> queryInterceptors(Configuration config,
 Class<?> componentType,
 @Nullable String componentName)

Description copied from interface: ReactorDispatchInterceptorRegistry

Returns the list of ReactorMessageDispatchInterceptors registered for QueryMessages for a specific componentType and componentName.

Specified by:

queryInterceptors in interface ReactorDispatchInterceptorRegistry

Parameters:

config - the configuration to build all QueryMessage-specific ReactorMessageDispatchInterceptors with

componentType - the type of the component being intercepted

componentName - the name of the component being intercepted

Returns:

the list of query dispatch interceptors

describeTo

public void describeTo(ComponentDescriptor descriptor)

Description copied from interface: DescribableComponent

Describe the properties of this DescribableComponent with the given descriptor.

Components should call the appropriate describeProperty methods on the descriptor to register their properties. The descriptor is responsible for determining how these properties are formatted and structured in the final output.

Best Practices: As a general rule, all relevant fields of a DescribableComponent implementation should be described in this method. However, developers have discretion to include only the fields that make sense in the context. Not every field may be meaningful for description purposes, especially internal implementation details. Furthermore, components might want to expose different information based on their current state. The final decision on what properties to include lies with the person implementing the describeTo method, who should focus on providing information that is useful for understanding the component's configuration and state.

Example implementation:

 public void describeTo(ComponentDescriptor descriptor) {
     descriptor.describeProperty("name", this.name);
     descriptor.describeProperty("enabled", this.enabled);
     descriptor.describeProperty("configuration", this.configuration); // A nested component
     descriptor.describeProperty("handlers", this.eventHandlers);      // A collection
 }
 

Specified by:

describeTo in interface DescribableComponent

Parameters:

descriptor - The component descriptor to describe this DescribableComponentn its properties in.