Package org.axonframework.messaging.core.interception

Interface HandlerInterceptorRegistry

All Superinterfaces:

DescribableComponent

All Known Implementing Classes:

DefaultHandlerInterceptorRegistry

@Internal
public interface HandlerInterceptorRegistry
extends DescribableComponent

A registry of MessageHandlerInterceptors, acting as a collection of registered MessageHandlerInterceptors components.

Provides operations to register generic Message, CommandMessage-specific, EventMessage-specific, or QueryMessage-specific MessageHandlerInterceptors. Registered type specific MessageHandlerInterceptors can be retrieved through commandInterceptors(Configuration), eventInterceptors(Configuration), and queryInterceptors(Configuration).

These operations are expected to be invoked within a DecoratorDefinition. As such, any registered interceptors are only applied when the infrastructure component requiring them is constructed. When, for example, an InterceptingCommandBus is constructed, this registry is invoked to retrieve interceptors. Interceptors that are registered once the InterceptingCommandBus has already been constructed are not taken into account.

Since:

5.0.0

Author:

Steven van Beelen

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.
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 interface org.axonframework.common.infra.DescribableComponent

describeTo

Method Details

registerInterceptor

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

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

Parameters:

interceptorBuilder - The generic Message MessageHandlerInterceptor builder to register.

Returns:

This InterceptorRegistry, for fluent interfacing.

registerCommandInterceptor

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

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

Parameters:

interceptorBuilder - The CommandMessage-specific MessageHandlerInterceptor builder to register.

Returns:

This InterceptorRegistry, for fluent interfacing.

registerEventInterceptor

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

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

Parameters:

interceptorBuilder - The EventMessage-specific MessageHandlerInterceptor builder to register.

Returns:

This InterceptorRegistry, for fluent interfacing.

registerQueryInterceptor

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

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

Parameters:

interceptorBuilder - The QueryMessage-specific MessageHandlerInterceptor builder to register.

Returns:

This InterceptorRegistry, for fluent interfacing.

commandInterceptors

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

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

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

Parameters:

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

Returns:

The list of CommandMessage-specific MessageHandlerInterceptors.

eventInterceptors

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

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

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

Parameters:

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

Returns:

The list of EventMessage-specific MessageHandlerInterceptors.

queryInterceptors

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

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

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

Parameters:

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

Returns:

The list of QueryMessage-specific MessageHandlerInterceptors.