Package org.axonframework.messaging.core.interception

Interface DispatchInterceptorRegistry

All Superinterfaces:

DescribableComponent

All Known Implementing Classes:

DefaultDispatchInterceptorRegistry

@Internal
public interface DispatchInterceptorRegistry
extends DescribableComponent

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

Provides operations to register generic Message, CommandMessage-specific, EventMessage-specific, QueryMessage-specific, or SubscriptionQueryUpdateMessage-specific MessageDispatchInterceptor. Registered type specific MessageDispatchInterceptor can be retrieved through commandInterceptors(Configuration), eventInterceptors(Configuration), queryInterceptors(Configuration), and subscriptionQueryUpdateInterceptors(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 ac

Since:

5.0.0

Author:

Steven van Beelen

Method Summary

Modifier and Type	Method	Description
List<MessageDispatchInterceptor<? super CommandMessage>>	commandInterceptors(Configuration config)	Returns the list of MessageDispatchInterceptors registered in this registry.
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 interface org.axonframework.common.infra.DescribableComponent

describeTo

Method Details

registerInterceptor

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

Registers the given interceptorBuilder for a generic Message MessageDispatchInterceptor.

Parameters:

interceptorBuilder - The generic Message MessageDispatchInterceptor builder to register.

Returns:

This InterceptorRegistry, for fluent interfacing.

registerCommandInterceptor

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

Registers the given interceptorBuilder for a CommandMessage-specific MessageDispatchInterceptor.

Parameters:

interceptorBuilder - The CommandMessage-specific MessageDispatchInterceptor builder to register.

Returns:

This InterceptorRegistry, for fluent interfacing.

registerEventInterceptor

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

Registers the given interceptorBuilder for a EventMessage-specific MessageDispatchInterceptor.

Parameters:

interceptorBuilder - The EventMessage-specific MessageDispatchInterceptor builder to register.

Returns:

This InterceptorRegistry, for fluent interfacing.

registerQueryInterceptor

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

Registers the given interceptorBuilder for a QueryMessage-specific MessageDispatchInterceptor.

Parameters:

interceptorBuilder - The QueryMessage-specific MessageDispatchInterceptor builder to register.

Returns:

This InterceptorRegistry, for fluent interfacing.

registerSubscriptionQueryUpdateInterceptor

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

Registers the given interceptorBuilder for a SubscriptionQueryUpdateMessage-specific MessageDispatchInterceptor.

Parameters:

interceptorBuilder - The SubscriptionQueryUpdateMessage-specific MessageDispatchInterceptor builder to register.

Returns:

This InterceptorRegistry, for fluent interfacing.

commandInterceptors

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

Returns the list of MessageDispatchInterceptors registered in this registry.

Parameters:

config - The configuration to build all MessageDispatchInterceptors with.

Returns:

The list of MessageDispatchInterceptors registered in this registry.

eventInterceptors

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

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

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

Parameters:

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

Returns:

The list of EventMessage-specific MessageDispatchInterceptors.

queryInterceptors

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

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

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

Parameters:

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

Returns:

The list of QueryMessage-specific MessageDispatchInterceptors.

subscriptionQueryUpdateInterceptors

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

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

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

Parameters:

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

Returns:

The list of SubscriptionQueryUpdateMessage-specific MessageDispatchInterceptors.