Package org.axonframework.messaging.core.interception

Class DefaultHandlerInterceptorRegistry

java.lang.Object

org.axonframework.messaging.core.interception.DefaultHandlerInterceptorRegistry

All Implemented Interfaces:

DescribableComponent, HandlerInterceptorRegistry

@Internal
public class DefaultHandlerInterceptorRegistry
extends Object
implements HandlerInterceptorRegistry

Default implementation of the HandlerInterceptorRegistry, maintaining lists of CommandMessage, EventMessage, and QueryMessage-specific MessageHandlerInterceptors.

This implementation ensures give interceptor factory methods are only invoked once.

Since:

5.0.0

Author:

Steven van Beelen

Constructor Summary

Constructors

Constructor	Description
DefaultHandlerInterceptorRegistry()

Method Summary

Modifier and Type	Method	Description
List<MessageHandlerInterceptor<? super CommandMessage>>	commandInterceptors(Configuration config)	Returns the list of CommandMessage-specific MessageHandlerInterceptors registered in this registry.
void	describeTo(ComponentDescriptor descriptor)	Describe the properties of this DescribableComponent with the given descriptor.
List<MessageHandlerInterceptor<? super EventMessage>>	eventInterceptors(Configuration config)	Returns the list of EventMessage-specific MessageHandlerInterceptors registered in this registry.
List<MessageHandlerInterceptor<? super QueryMessage>>	queryInterceptors(Configuration config)	Returns the list of QueryMessage-specific MessageHandlerInterceptors registered in this registry.
HandlerInterceptorRegistry	registerCommandInterceptor(ComponentBuilder<MessageHandlerInterceptor<? super CommandMessage>> interceptorBuilder)	Registers the given interceptorBuilder for a CommandMessage MessageHandlerInterceptor for all command handling infrastructure components.
HandlerInterceptorRegistry	registerEventInterceptor(ComponentBuilder<MessageHandlerInterceptor<? super EventMessage>> interceptorBuilder)	Registers the given interceptorBuilder for a EventMessage MessageHandlerInterceptor for all event handling infrastructure components
HandlerInterceptorRegistry	registerInterceptor(ComponentBuilder<MessageHandlerInterceptor<Message>> interceptorBuilder)	Registers the given interceptorBuilder constructing a generic Message MessageHandlerInterceptor for all handling infrastructure components.
HandlerInterceptorRegistry	registerQueryInterceptor(ComponentBuilder<MessageHandlerInterceptor<? super QueryMessage>> interceptorBuilder)	Registers the given interceptorBuilder for a QueryMessage MessageHandlerInterceptor for all query handling infrastructure components

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultHandlerInterceptorRegistry

public DefaultHandlerInterceptorRegistry()

Method Details

registerInterceptor

@Nonnull
public HandlerInterceptorRegistry registerInterceptor(@Nonnull
 ComponentBuilder<MessageHandlerInterceptor<Message>> interceptorBuilder)

Description copied from interface: HandlerInterceptorRegistry

Registers the given interceptorBuilder constructing a generic Message MessageHandlerInterceptor for all handling infrastructure components.

Specified by:

registerInterceptor in interface HandlerInterceptorRegistry

Parameters:

interceptorBuilder - The generic Message MessageHandlerInterceptor builder to register.

Returns:

This InterceptorRegistry, for fluent interfacing.

registerCommandInterceptor

@Nonnull
public HandlerInterceptorRegistry registerCommandInterceptor(@Nonnull
 ComponentBuilder<MessageHandlerInterceptor<? super CommandMessage>> interceptorBuilder)

Description copied from interface: HandlerInterceptorRegistry

Registers the given interceptorBuilder for a CommandMessage MessageHandlerInterceptor for all command handling infrastructure components.

Specified by:

registerCommandInterceptor in interface HandlerInterceptorRegistry

Parameters:

interceptorBuilder - The CommandMessage-specific MessageHandlerInterceptor builder to register.

Returns:

This InterceptorRegistry, for fluent interfacing.

registerEventInterceptor

@Nonnull
public HandlerInterceptorRegistry registerEventInterceptor(@Nonnull
 ComponentBuilder<MessageHandlerInterceptor<? super EventMessage>> interceptorBuilder)

Description copied from interface: HandlerInterceptorRegistry

Registers the given interceptorBuilder for a EventMessage MessageHandlerInterceptor for all event handling infrastructure components

Specified by:

registerEventInterceptor in interface HandlerInterceptorRegistry

Parameters:

interceptorBuilder - The EventMessage-specific MessageHandlerInterceptor builder to register.

Returns:

This InterceptorRegistry, for fluent interfacing.

registerQueryInterceptor

@Nonnull
public HandlerInterceptorRegistry registerQueryInterceptor(@Nonnull
 ComponentBuilder<MessageHandlerInterceptor<? super QueryMessage>> interceptorBuilder)

Description copied from interface: HandlerInterceptorRegistry

Registers the given interceptorBuilder for a QueryMessage MessageHandlerInterceptor for all query handling infrastructure components

Specified by:

registerQueryInterceptor in interface HandlerInterceptorRegistry

Parameters:

interceptorBuilder - The QueryMessage-specific MessageHandlerInterceptor builder to register.

Returns:

This InterceptorRegistry, for fluent interfacing.

commandInterceptors

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

Description copied from interface: HandlerInterceptorRegistry

Returns the list of CommandMessage-specific MessageHandlerInterceptors registered in this registry.

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

Specified by:

commandInterceptors in interface HandlerInterceptorRegistry

Parameters:

config - The configuration to build all CommandMessage-specific MessageHandlerInterceptors with.

Returns:

The list of CommandMessage-specific MessageHandlerInterceptors.

eventInterceptors

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

Description copied from interface: HandlerInterceptorRegistry

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

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

Specified by:

eventInterceptors in interface HandlerInterceptorRegistry

Parameters:

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

Returns:

The list of EventMessage-specific MessageHandlerInterceptors.

queryInterceptors

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

Description copied from interface: HandlerInterceptorRegistry

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

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

Specified by:

queryInterceptors in interface HandlerInterceptorRegistry

Parameters:

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

Returns:

The list of QueryMessage-specific MessageHandlerInterceptors.

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.