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 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
DefaultHandlerInterceptorRegistry()

Method Summary

Modifier and Type	Method	Description
List<MessageHandlerInterceptor<? super CommandMessage>>	commandInterceptors(Configuration config, Class<?> componentType, @Nullable String componentName)	Returns the list of CommandMessage-specific MessageHandlerInterceptors registered in this registry for a componentType and componentName.
void	describeTo(ComponentDescriptor descriptor)	Describe the properties of this DescribableComponent with the given descriptor.
List<MessageHandlerInterceptor<? super EventMessage>>	eventInterceptors(Configuration config, Class<?> componentType, @Nullable String componentName)	Returns the list of EventMessage-specific MessageHandlerInterceptors registered in this registry for a componentType and componentName.
List<MessageHandlerInterceptor<? super QueryMessage>>	queryInterceptors(Configuration config, Class<?> componentType, @Nullable String componentName)	Returns the list of QueryMessage-specific MessageHandlerInterceptors registered in this registry for a componentType and componentName.
HandlerInterceptorRegistry	registerCommandInterceptor(ComponentBuilder<MessageHandlerInterceptor<? super CommandMessage>> interceptorBuilder)	Registers the given interceptorBuilder for a CommandMessage MessageHandlerInterceptor for all command handling infrastructure components.
HandlerInterceptorRegistry	registerCommandInterceptor(HandlerInterceptorFactory<? super CommandMessage> interceptorFactory)	Registers the given component-aware interceptorFactory 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	registerEventInterceptor(HandlerInterceptorFactory<? super EventMessage> interceptorFactory)	Registers the given component-aware interceptorFactory 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	registerInterceptor(HandlerInterceptorFactory<Message> interceptorFactory)	Registers the given component-aware interceptorFactory 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
HandlerInterceptorRegistry	registerQueryInterceptor(HandlerInterceptorFactory<? super QueryMessage> interceptorFactory)	Registers the given component-aware interceptorFactory 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

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

Description copied from interface: HandlerInterceptorRegistry

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

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

Specified by:

registerInterceptor in interface HandlerInterceptorRegistry

Parameters:

interceptorBuilder - the generic Message MessageHandlerInterceptor builder to register

Returns:

this InterceptorRegistry, for fluent interfacing

registerInterceptor

public HandlerInterceptorRegistry registerInterceptor(HandlerInterceptorFactory<Message> interceptorFactory)

Description copied from interface: HandlerInterceptorRegistry

Registers the given component-aware interceptorFactory constructing a generic Message MessageHandlerInterceptor for all handling infrastructure components.

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 HandlerInterceptorFactory 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 HandlerInterceptorRegistry.registerInterceptor(ComponentBuilder) instead.

Specified by:

registerInterceptor in interface HandlerInterceptorRegistry

Parameters:

interceptorFactory - the generic Message MessageHandlerInterceptor factory to register

Returns:

this InterceptorRegistry, for fluent interfacing

registerCommandInterceptor

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

Description copied from interface: HandlerInterceptorRegistry

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

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

Specified by:

registerCommandInterceptor in interface HandlerInterceptorRegistry

Parameters:

interceptorBuilder - the CommandMessage-specific MessageHandlerInterceptor builder to register

Returns:

this InterceptorRegistry, for fluent interfacing

registerCommandInterceptor

public HandlerInterceptorRegistry registerCommandInterceptor(HandlerInterceptorFactory<? super CommandMessage> interceptorFactory)

Description copied from interface: HandlerInterceptorRegistry

Registers the given component-aware interceptorFactory for a CommandMessage MessageHandlerInterceptor for all command handling infrastructure components.

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 HandlerInterceptorFactory 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 HandlerInterceptorRegistry.registerCommandInterceptor(ComponentBuilder) instead.

Specified by:

registerCommandInterceptor in interface HandlerInterceptorRegistry

Parameters:

interceptorFactory - the CommandMessage-specific MessageHandlerInterceptor factory to register

Returns:

this InterceptorRegistry, for fluent interfacing

registerEventInterceptor

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

Description copied from interface: HandlerInterceptorRegistry

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

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

Specified by:

registerEventInterceptor in interface HandlerInterceptorRegistry

Parameters:

interceptorBuilder - the EventMessage-specific MessageHandlerInterceptor builder to register

Returns:

this InterceptorRegistry, for fluent interfacing

registerEventInterceptor

public HandlerInterceptorRegistry registerEventInterceptor(HandlerInterceptorFactory<? super EventMessage> interceptorFactory)

Description copied from interface: HandlerInterceptorRegistry

Registers the given component-aware interceptorFactory for a EventMessage MessageHandlerInterceptor for all event handling infrastructure components.

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 HandlerInterceptorFactory 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 HandlerInterceptorRegistry.registerEventInterceptor(ComponentBuilder) instead.

Specified by:

registerEventInterceptor in interface HandlerInterceptorRegistry

Parameters:

interceptorFactory - the EventMessage-specific MessageHandlerInterceptor factory to register

Returns:

this InterceptorRegistry, for fluent interfacing

registerQueryInterceptor

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

Description copied from interface: HandlerInterceptorRegistry

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

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

Specified by:

registerQueryInterceptor in interface HandlerInterceptorRegistry

Parameters:

interceptorBuilder - the QueryMessage-specific MessageHandlerInterceptor builder to register

Returns:

this InterceptorRegistry, for fluent interfacing

registerQueryInterceptor

public HandlerInterceptorRegistry registerQueryInterceptor(HandlerInterceptorFactory<? super QueryMessage> interceptorFactory)

Description copied from interface: HandlerInterceptorRegistry

Registers the given component-aware interceptorFactory for a QueryMessage MessageHandlerInterceptor for all query handling infrastructure components.

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 HandlerInterceptorFactory 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 HandlerInterceptorRegistry.registerQueryInterceptor(ComponentBuilder) instead.

Specified by:

registerQueryInterceptor in interface HandlerInterceptorRegistry

Parameters:

interceptorFactory - the QueryMessage-specific MessageHandlerInterceptor factory to register

Returns:

this InterceptorRegistry, for fluent interfacing

commandInterceptors

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

Description copied from interface: HandlerInterceptorRegistry

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

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

Specified by:

commandInterceptors in interface HandlerInterceptorRegistry

Parameters:

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

componentType - the type of the component being intercepted to retrieve a handler interceptor for

componentName - the name of the component being intercepted to retrieve a handler interceptor for

Returns:

the list of CommandMessage-specific MessageHandlerInterceptors

eventInterceptors

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

Description copied from interface: HandlerInterceptorRegistry

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

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

Specified by:

eventInterceptors in interface HandlerInterceptorRegistry

Parameters:

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

componentType - the type of the component being intercepted to retrieve a handler interceptor for

componentName - the name of the component being intercepted to retrieve a handler interceptor for

Returns:

the list of EventMessage-specific MessageHandlerInterceptors

queryInterceptors

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

Description copied from interface: HandlerInterceptorRegistry

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

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

Specified by:

queryInterceptors in interface HandlerInterceptorRegistry

Parameters:

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

componentType - the type of the component being intercepted to retrieve a handler interceptor for

componentName - the name of the component being intercepted to retrieve a handler interceptor for

Returns:

the list of QueryMessage-specific MessageHandlerInterceptors

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.