Package org.axonframework.messaging.core.interception

Class DefaultDispatchInterceptorRegistry

java.lang.Object

org.axonframework.messaging.core.interception.DefaultDispatchInterceptorRegistry

All Implemented Interfaces:

DescribableComponent, DispatchInterceptorRegistry

@Internal
public class DefaultDispatchInterceptorRegistry
extends Object
implements DispatchInterceptorRegistry

Default implementation of the DispatchInterceptorRegistry, maintaining lists of CommandMessage, EventMessage, and QueryMessage-specific MessageDispatchInterceptors.

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

Since:

5.0.0

Author:

Steven van Beelen

Constructor Summary

Constructors

Constructor	Description
DefaultDispatchInterceptorRegistry()

Method Summary

Modifier and Type	Method	Description
List<MessageDispatchInterceptor<? super CommandMessage>>	commandInterceptors(Configuration config, Class<?> componentType, @Nullable String componentName)	Returns the list of CommandMessage-specific MessageDispatchInterceptors registered in this registry for a specific componentType and componentName.
void	describeTo(ComponentDescriptor descriptor)	Describe the properties of this DescribableComponent with the given descriptor.
List<MessageDispatchInterceptor<? super EventMessage>>	eventInterceptors(Configuration config, Class<?> componentType, @Nullable String componentName)	Returns the list of EventMessage-specific MessageDispatchInterceptors registered in this registry for a specific componentType and componentName.
List<MessageDispatchInterceptor<? super QueryMessage>>	queryInterceptors(Configuration config, Class<?> componentType, @Nullable String componentName)	Returns the list of QueryMessage-specific MessageDispatchInterceptors registered in this registry for a specific componentType and componentName.
DispatchInterceptorRegistry	registerCommandInterceptor(ComponentBuilder<MessageDispatchInterceptor<? super CommandMessage>> interceptorBuilder)	Registers the given interceptorBuilder for a CommandMessage-specific MessageDispatchInterceptor.
DispatchInterceptorRegistry	registerCommandInterceptor(DispatchInterceptorFactory<? super CommandMessage> interceptorFactory)	Registers the given component-aware interceptorFactory for a CommandMessage-specific MessageDispatchInterceptor.
DispatchInterceptorRegistry	registerEventInterceptor(ComponentBuilder<MessageDispatchInterceptor<? super EventMessage>> interceptorBuilder)	Registers the given interceptorBuilder for a EventMessage-specific MessageDispatchInterceptor.
DispatchInterceptorRegistry	registerEventInterceptor(DispatchInterceptorFactory<? super EventMessage> interceptorFactory)	Registers the given component-aware interceptorFactory for a EventMessage-specific MessageDispatchInterceptor.
DispatchInterceptorRegistry	registerInterceptor(ComponentBuilder<MessageDispatchInterceptor<Message>> interceptorBuilder)	Registers the given interceptorBuilder for a generic Message MessageDispatchInterceptor.
DispatchInterceptorRegistry	registerInterceptor(DispatchInterceptorFactory<Message> interceptorFactory)	Registers the given component-aware interceptorFactory for a generic Message MessageDispatchInterceptor.
DispatchInterceptorRegistry	registerQueryInterceptor(ComponentBuilder<MessageDispatchInterceptor<? super QueryMessage>> interceptorBuilder)	Registers the given interceptorBuilder for a QueryMessage-specific MessageDispatchInterceptor.
DispatchInterceptorRegistry	registerQueryInterceptor(DispatchInterceptorFactory<? super QueryMessage> interceptorFactory)	Registers the given component-aware interceptorFactory for a QueryMessage-specific MessageDispatchInterceptor.
DispatchInterceptorRegistry	registerSubscriptionQueryUpdateInterceptor(ComponentBuilder<MessageDispatchInterceptor<? super SubscriptionQueryUpdateMessage>> interceptorBuilder)	Registers the given interceptorBuilder for a SubscriptionQueryUpdateMessage-specific MessageDispatchInterceptor.
DispatchInterceptorRegistry	registerSubscriptionQueryUpdateInterceptor(DispatchInterceptorFactory<? super SubscriptionQueryUpdateMessage> interceptorFactory)	Registers the given component-aware interceptorFactory for a SubscriptionQueryUpdateMessage-specific MessageDispatchInterceptor.
List<MessageDispatchInterceptor<? super SubscriptionQueryUpdateMessage>>	subscriptionQueryUpdateInterceptors(Configuration config, Class<?> componentType, @Nullable String componentName)	Returns the list of SubscriptionQueryUpdateMessage-specific MessageDispatchInterceptors registered in this registry for a specific componentType and componentName.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultDispatchInterceptorRegistry

public DefaultDispatchInterceptorRegistry()

Method Details

registerInterceptor

public DispatchInterceptorRegistry registerInterceptor(ComponentBuilder<MessageDispatchInterceptor<Message>> interceptorBuilder)

Description copied from interface: DispatchInterceptorRegistry

Registers the given interceptorBuilder for a generic Message MessageDispatchInterceptor.

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

Specified by:

registerInterceptor in interface DispatchInterceptorRegistry

Parameters:

interceptorBuilder - the generic Message MessageDispatchInterceptor builder to register

Returns:

this InterceptorRegistry, for fluent interfacing

registerInterceptor

public DispatchInterceptorRegistry registerInterceptor(DispatchInterceptorFactory<Message> interceptorFactory)

Description copied from interface: DispatchInterceptorRegistry

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

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 DispatchInterceptorFactory enforces construction of the interceptor for every invocation of the factory, ensuring uniqueness per given typa and name. If the interceptor will be identical regardless of the given type or name, please use DispatchInterceptorRegistry.registerInterceptor(ComponentBuilder) instead.

Specified by:

registerInterceptor in interface DispatchInterceptorRegistry

Parameters:

interceptorFactory - the generic Message MessageDispatchInterceptor factory to register

Returns:

this InterceptorRegistry, for fluent interfacing

registerCommandInterceptor

public DispatchInterceptorRegistry registerCommandInterceptor(ComponentBuilder<MessageDispatchInterceptor<? super CommandMessage>> interceptorBuilder)

Description copied from interface: DispatchInterceptorRegistry

Registers the given interceptorBuilder for a CommandMessage-specific MessageDispatchInterceptor.

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

Specified by:

registerCommandInterceptor in interface DispatchInterceptorRegistry

Parameters:

interceptorBuilder - the CommandMessage-specific MessageDispatchInterceptor builder to register

Returns:

this InterceptorRegistry, for fluent interfacing

registerCommandInterceptor

public DispatchInterceptorRegistry registerCommandInterceptor(DispatchInterceptorFactory<? super CommandMessage> interceptorFactory)

Description copied from interface: DispatchInterceptorRegistry

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

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 DispatchInterceptorFactory enforces construction of the interceptor for every invocation of the factory, ensuring uniqueness per given typa and name. If the interceptor will be identical regardless of the given type or name, please use DispatchInterceptorRegistry.registerCommandInterceptor(ComponentBuilder) instead.

Specified by:

registerCommandInterceptor in interface DispatchInterceptorRegistry

Parameters:

interceptorFactory - the CommandMessage-specific MessageDispatchInterceptor factory to register

Returns:

this InterceptorRegistry, for fluent interfacing

registerEventInterceptor

public DispatchInterceptorRegistry registerEventInterceptor(ComponentBuilder<MessageDispatchInterceptor<? super EventMessage>> interceptorBuilder)

Description copied from interface: DispatchInterceptorRegistry

Registers the given interceptorBuilder for a EventMessage-specific MessageDispatchInterceptor.

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

Specified by:

registerEventInterceptor in interface DispatchInterceptorRegistry

Parameters:

interceptorBuilder - the EventMessage-specific MessageDispatchInterceptor builder to register

Returns:

this InterceptorRegistry, for fluent interfacing

registerEventInterceptor

public DispatchInterceptorRegistry registerEventInterceptor(DispatchInterceptorFactory<? super EventMessage> interceptorFactory)

Description copied from interface: DispatchInterceptorRegistry

Registers the given component-aware interceptorFactory for a EventMessage-specific MessageDispatchInterceptor.

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 DispatchInterceptorFactory enforces construction of the interceptor for every invocation of the factory, ensuring uniqueness per given typa and name. If the interceptor will be identical regardless of the given type or name, please use DispatchInterceptorRegistry.registerEventInterceptor(ComponentBuilder) instead.

Specified by:

registerEventInterceptor in interface DispatchInterceptorRegistry

Parameters:

interceptorFactory - the EventMessage-specific MessageDispatchInterceptor factory to register

Returns:

this InterceptorRegistry, for fluent interfacing

registerQueryInterceptor

public DispatchInterceptorRegistry registerQueryInterceptor(ComponentBuilder<MessageDispatchInterceptor<? super QueryMessage>> interceptorBuilder)

Description copied from interface: DispatchInterceptorRegistry

Registers the given interceptorBuilder for a QueryMessage-specific MessageDispatchInterceptor.

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

Specified by:

registerQueryInterceptor in interface DispatchInterceptorRegistry

Parameters:

interceptorBuilder - the QueryMessage-specific MessageDispatchInterceptor builder to register

Returns:

this InterceptorRegistry, for fluent interfacing

registerQueryInterceptor

public DispatchInterceptorRegistry registerQueryInterceptor(DispatchInterceptorFactory<? super QueryMessage> interceptorFactory)

Description copied from interface: DispatchInterceptorRegistry

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

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 DispatchInterceptorFactory enforces construction of the interceptor for every invocation of the factory, ensuring uniqueness per given typa and name. If the interceptor will be identical regardless of the given type or name, please use DispatchInterceptorRegistry.registerQueryInterceptor(ComponentBuilder) instead.

Specified by:

registerQueryInterceptor in interface DispatchInterceptorRegistry

Parameters:

interceptorFactory - the QueryMessage-specific MessageDispatchInterceptor factory to register

Returns:

this InterceptorRegistry, for fluent interfacing

registerSubscriptionQueryUpdateInterceptor

public DispatchInterceptorRegistry registerSubscriptionQueryUpdateInterceptor(ComponentBuilder<MessageDispatchInterceptor<? super SubscriptionQueryUpdateMessage>> interceptorBuilder)

Description copied from interface: DispatchInterceptorRegistry

Registers the given interceptorBuilder for a SubscriptionQueryUpdateMessage-specific MessageDispatchInterceptor.

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

Specified by:

registerSubscriptionQueryUpdateInterceptor in interface DispatchInterceptorRegistry

Parameters:

interceptorBuilder - the SubscriptionQueryUpdateMessage-specific MessageDispatchInterceptor builder to register

Returns:

this InterceptorRegistry, for fluent interfacing

registerSubscriptionQueryUpdateInterceptor

public DispatchInterceptorRegistry registerSubscriptionQueryUpdateInterceptor(DispatchInterceptorFactory<? super SubscriptionQueryUpdateMessage> interceptorFactory)

Description copied from interface: DispatchInterceptorRegistry

Registers the given component-aware interceptorFactory for a SubscriptionQueryUpdateMessage-specific MessageDispatchInterceptor.

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 DispatchInterceptorFactory enforces construction of the interceptor for every invocation of the factory, ensuring uniqueness per given typa and name. If the interceptor will be identical regardless of the given type or name, please use DispatchInterceptorRegistry.registerSubscriptionQueryUpdateInterceptor(ComponentBuilder) instead.

Specified by:

registerSubscriptionQueryUpdateInterceptor in interface DispatchInterceptorRegistry

Parameters:

interceptorFactory - the SubscriptionQueryUpdateMessage-specific MessageDispatchInterceptor factory to register

Returns:

this InterceptorRegistry, for fluent interfacing

commandInterceptors

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

Description copied from interface: DispatchInterceptorRegistry

Returns the list of CommandMessage-specific MessageDispatchInterceptors registered in this registry for a specific componentType and componentName.

This collection contains generic Message MessageDispatchInterceptors that have been registered when the generic builder returns an instance.

Specified by:

commandInterceptors in interface DispatchInterceptorRegistry

Parameters:

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

componentType - the type of the component being intercepted

componentName - the name of the component being intercepted

Returns:

the list of CommandMessage-specific MessageDispatchInterceptors

eventInterceptors

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

Description copied from interface: DispatchInterceptorRegistry

Returns the list of EventMessage-specific MessageDispatchInterceptors registered in this registry for a specific componentType and componentName.

This collection contains generic Message MessageDispatchInterceptors that have been registered when the generic builder returns an instance.

Specified by:

eventInterceptors in interface DispatchInterceptorRegistry

Parameters:

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

componentType - the type of the component to retrieve a dispatch interceptor for

componentName - the name of the component to retrieve a dispatch interceptor for

Returns:

the list of EventMessage-specific MessageDispatchInterceptors

queryInterceptors

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

Description copied from interface: DispatchInterceptorRegistry

Returns the list of QueryMessage-specific MessageDispatchInterceptors registered in this registry for a specific componentType and componentName.

This collection contains generic Message MessageDispatchInterceptors that have been registered when the generic builder returns an instance.

Specified by:

queryInterceptors in interface DispatchInterceptorRegistry

Parameters:

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

componentType - the type of the component to retrieve a dispatch interceptor for

componentName - the name of the component to retrieve a dispatch interceptor for

Returns:

the list of QueryMessage-specific MessageDispatchInterceptors

subscriptionQueryUpdateInterceptors

public List<MessageDispatchInterceptor<? super SubscriptionQueryUpdateMessage>> subscriptionQueryUpdateInterceptors(Configuration config,
 Class<?> componentType,
 @Nullable String componentName)

Description copied from interface: DispatchInterceptorRegistry

Returns the list of SubscriptionQueryUpdateMessage-specific MessageDispatchInterceptors registered in this registry for a specific componentType and componentName.

This collection contains generic Message MessageDispatchInterceptors that have been registered when the generic builder returns an instance.

Specified by:

subscriptionQueryUpdateInterceptors in interface DispatchInterceptorRegistry

Parameters:

config - the configuration to build all SubscriptionQueryUpdateMessage-specific MessageDispatchInterceptors with

componentType - the type of the component to retrieve a dispatch interceptor for

componentName - the name of the component to retrieve a dispatch interceptor for

Returns:

the list of SubscriptionQueryUpdateMessage-specific MessageDispatchInterceptors

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.