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 factory methods are only invoked once.

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)	Returns the list of MessageDispatchInterceptors registered in this registry.
void	describeTo(ComponentDescriptor descriptor)	Describe the properties of this DescribableComponent with the given descriptor.
List<MessageDispatchInterceptor<? super EventMessage>>	eventInterceptors(Configuration config)	Returns the list of EventMessage-specific MessageDispatchInterceptors registered in this registry.
List<MessageDispatchInterceptor<? super QueryMessage>>	queryInterceptors(Configuration config)	Returns the list of QueryMessage-specific MessageDispatchInterceptors registered in this registry.
DispatchInterceptorRegistry	registerCommandInterceptor(ComponentBuilder<MessageDispatchInterceptor<? super CommandMessage>> interceptorBuilder)	Registers the given interceptorBuilder for a CommandMessage-specific MessageDispatchInterceptor.
DispatchInterceptorRegistry	registerEventInterceptor(ComponentBuilder<MessageDispatchInterceptor<? super EventMessage>> interceptorBuilder)	Registers the given interceptorBuilder for a EventMessage-specific MessageDispatchInterceptor.
DispatchInterceptorRegistry	registerInterceptor(ComponentBuilder<MessageDispatchInterceptor<Message>> interceptorBuilder)	Registers the given interceptorBuilder for a generic Message MessageDispatchInterceptor.
DispatchInterceptorRegistry	registerQueryInterceptor(ComponentBuilder<MessageDispatchInterceptor<? super QueryMessage>> interceptorBuilder)	Registers the given interceptorBuilder for a QueryMessage-specific MessageDispatchInterceptor.
DispatchInterceptorRegistry	registerSubscriptionQueryUpdateInterceptor(ComponentBuilder<MessageDispatchInterceptor<? super SubscriptionQueryUpdateMessage>> interceptorBuilder)	Registers the given interceptorBuilder for a SubscriptionQueryUpdateMessage-specific MessageDispatchInterceptor.
List<MessageDispatchInterceptor<? super SubscriptionQueryUpdateMessage>>	subscriptionQueryUpdateInterceptors(Configuration config)	Returns the list of SubscriptionQueryUpdateMessage-specific MessageDispatchInterceptors registered in this registry.

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

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

Description copied from interface: DispatchInterceptorRegistry

Registers the given interceptorBuilder for a generic Message MessageDispatchInterceptor.

Specified by:

registerInterceptor in interface DispatchInterceptorRegistry

Parameters:

interceptorBuilder - The generic Message MessageDispatchInterceptor builder to register.

Returns:

This InterceptorRegistry, for fluent interfacing.

registerCommandInterceptor

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

Description copied from interface: DispatchInterceptorRegistry

Registers the given interceptorBuilder for a CommandMessage-specific MessageDispatchInterceptor.

Specified by:

registerCommandInterceptor in interface DispatchInterceptorRegistry

Parameters:

interceptorBuilder - The CommandMessage-specific MessageDispatchInterceptor builder to register.

Returns:

This InterceptorRegistry, for fluent interfacing.

registerEventInterceptor

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

Description copied from interface: DispatchInterceptorRegistry

Registers the given interceptorBuilder for a EventMessage-specific MessageDispatchInterceptor.

Specified by:

registerEventInterceptor in interface DispatchInterceptorRegistry

Parameters:

interceptorBuilder - The EventMessage-specific MessageDispatchInterceptor builder to register.

Returns:

This InterceptorRegistry, for fluent interfacing.

registerQueryInterceptor

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

Description copied from interface: DispatchInterceptorRegistry

Registers the given interceptorBuilder for a QueryMessage-specific MessageDispatchInterceptor.

Specified by:

registerQueryInterceptor in interface DispatchInterceptorRegistry

Parameters:

interceptorBuilder - The QueryMessage-specific MessageDispatchInterceptor builder to register.

Returns:

This InterceptorRegistry, for fluent interfacing.

registerSubscriptionQueryUpdateInterceptor

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

Description copied from interface: DispatchInterceptorRegistry

Registers the given interceptorBuilder for a SubscriptionQueryUpdateMessage-specific MessageDispatchInterceptor.

Specified by:

registerSubscriptionQueryUpdateInterceptor in interface DispatchInterceptorRegistry

Parameters:

interceptorBuilder - The SubscriptionQueryUpdateMessage-specific MessageDispatchInterceptor builder to register.

Returns:

This InterceptorRegistry, for fluent interfacing.

commandInterceptors

@Nonnull
public List<MessageDispatchInterceptor<? super CommandMessage>> commandInterceptors(@Nonnull
 Configuration config)

Description copied from interface: DispatchInterceptorRegistry

Returns the list of MessageDispatchInterceptors registered in this registry.

Specified by:

commandInterceptors in interface DispatchInterceptorRegistry

Parameters:

config - The configuration to build all MessageDispatchInterceptors with.

Returns:

The list of MessageDispatchInterceptors registered in this registry.

eventInterceptors

@Nonnull
public List<MessageDispatchInterceptor<? super EventMessage>> eventInterceptors(@Nonnull
 Configuration config)

Description copied from interface: DispatchInterceptorRegistry

Returns the list of EventMessage-specific MessageDispatchInterceptors registered in this registry.

This collection contains all generic Message MessageDispatchInterceptors that have been registered as well.

Specified by:

eventInterceptors in interface DispatchInterceptorRegistry

Parameters:

config - The configuration to build all EventMessage-specific MessageDispatchInterceptors with.

Returns:

The list of EventMessage-specific MessageDispatchInterceptors.

queryInterceptors

@Nonnull
public List<MessageDispatchInterceptor<? super QueryMessage>> queryInterceptors(@Nonnull
 Configuration config)

Description copied from interface: DispatchInterceptorRegistry

Returns the list of QueryMessage-specific MessageDispatchInterceptors registered in this registry.

This collection contains all generic Message MessageDispatchInterceptors that have been registered as well.

Specified by:

queryInterceptors in interface DispatchInterceptorRegistry

Parameters:

config - The configuration to build all QueryMessage-specific MessageDispatchInterceptors with.

Returns:

The list of QueryMessage-specific MessageDispatchInterceptors.

subscriptionQueryUpdateInterceptors

@Nonnull
public List<MessageDispatchInterceptor<? super SubscriptionQueryUpdateMessage>> subscriptionQueryUpdateInterceptors(@Nonnull
 Configuration config)

Description copied from interface: DispatchInterceptorRegistry

Returns the list of SubscriptionQueryUpdateMessage-specific MessageDispatchInterceptors registered in this registry.

This collection contains all generic Message MessageDispatchInterceptors that have been registered as well.

Specified by:

subscriptionQueryUpdateInterceptors in interface DispatchInterceptorRegistry

Parameters:

config - The configuration to build all SubscriptionQueryUpdateMessage-specific MessageDispatchInterceptors with.

Returns:

The list of SubscriptionQueryUpdateMessage-specific MessageDispatchInterceptors.

describeTo

public void describeTo(@Nonnull
 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.