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, Class, String), eventInterceptors(Configuration, Class, String), queryInterceptors(Configuration, Class, String), and subscriptionQueryUpdateInterceptors(Configuration, Class, String).

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<MessageDispatchInterceptor<? super CommandMessage>>	commandInterceptors(Configuration config, Class<?> componentType, @Nullable String componentName)	Returns the list of CommandMessage-specific MessageDispatchInterceptors registered in this registry for a specific componentType and componentName.
List<MessageDispatchInterceptor<? super EventMessage>>	eventInterceptors(Configuration config, Class<?> componentType, @Nullable String componentName)	Returns the list of EventMessage-specific MessageDispatchInterceptors registered in this registry for a specific componentType and componentName.
List<MessageDispatchInterceptor<? super QueryMessage>>	queryInterceptors(Configuration config, Class<?> componentType, @Nullable String componentName)	Returns the list of QueryMessage-specific MessageDispatchInterceptors registered in this registry for a specific componentType and componentName.
DispatchInterceptorRegistry	registerCommandInterceptor(ComponentBuilder<MessageDispatchInterceptor<? super CommandMessage>> interceptorBuilder)	Registers the given interceptorBuilder for a CommandMessage-specific MessageDispatchInterceptor.
DispatchInterceptorRegistry	registerCommandInterceptor(DispatchInterceptorFactory<? super CommandMessage> interceptorFactory)	Registers the given component-aware interceptorFactory for a CommandMessage-specific MessageDispatchInterceptor.
DispatchInterceptorRegistry	registerEventInterceptor(ComponentBuilder<MessageDispatchInterceptor<? super EventMessage>> interceptorBuilder)	Registers the given interceptorBuilder for a EventMessage-specific MessageDispatchInterceptor.
DispatchInterceptorRegistry	registerEventInterceptor(DispatchInterceptorFactory<? super EventMessage> interceptorFactory)	Registers the given component-aware interceptorFactory for a EventMessage-specific MessageDispatchInterceptor.
DispatchInterceptorRegistry	registerInterceptor(ComponentBuilder<MessageDispatchInterceptor<Message>> interceptorBuilder)	Registers the given interceptorBuilder for a generic Message MessageDispatchInterceptor.
DispatchInterceptorRegistry	registerInterceptor(DispatchInterceptorFactory<Message> interceptorFactory)	Registers the given component-aware interceptorFactory for a generic Message MessageDispatchInterceptor.
DispatchInterceptorRegistry	registerQueryInterceptor(ComponentBuilder<MessageDispatchInterceptor<? super QueryMessage>> interceptorBuilder)	Registers the given interceptorBuilder for a QueryMessage-specific MessageDispatchInterceptor.
DispatchInterceptorRegistry	registerQueryInterceptor(DispatchInterceptorFactory<? super QueryMessage> interceptorFactory)	Registers the given component-aware interceptorFactory for a QueryMessage-specific MessageDispatchInterceptor.
DispatchInterceptorRegistry	registerSubscriptionQueryUpdateInterceptor(ComponentBuilder<MessageDispatchInterceptor<? super SubscriptionQueryUpdateMessage>> interceptorBuilder)	Registers the given interceptorBuilder for a SubscriptionQueryUpdateMessage-specific MessageDispatchInterceptor.
DispatchInterceptorRegistry	registerSubscriptionQueryUpdateInterceptor(DispatchInterceptorFactory<? super SubscriptionQueryUpdateMessage> interceptorFactory)	Registers the given component-aware interceptorFactory for a SubscriptionQueryUpdateMessage-specific MessageDispatchInterceptor.
List<MessageDispatchInterceptor<? super SubscriptionQueryUpdateMessage>>	subscriptionQueryUpdateInterceptors(Configuration config, Class<?> componentType, @Nullable String componentName)	Returns the list of SubscriptionQueryUpdateMessage-specific MessageDispatchInterceptors registered in this registry for a specific componentType and componentName.

Methods inherited from interface org.axonframework.common.infra.DescribableComponent

describeTo

Method Details

registerInterceptor

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

Registers the given interceptorBuilder for a generic Message MessageDispatchInterceptor.

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

Parameters:

interceptorBuilder - the generic Message MessageDispatchInterceptor builder to register

Returns:

this InterceptorRegistry, for fluent interfacing

registerInterceptor

DispatchInterceptorRegistry registerInterceptor(DispatchInterceptorFactory<Message> interceptorFactory)

Registers the given component-aware interceptorFactory for a generic Message MessageDispatchInterceptor.

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

Parameters:

interceptorFactory - the generic Message MessageDispatchInterceptor factory to register

Returns:

this InterceptorRegistry, for fluent interfacing

registerCommandInterceptor

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

Registers the given interceptorBuilder for a CommandMessage-specific MessageDispatchInterceptor.

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

Parameters:

interceptorBuilder - the CommandMessage-specific MessageDispatchInterceptor builder to register

Returns:

this InterceptorRegistry, for fluent interfacing

registerCommandInterceptor

DispatchInterceptorRegistry registerCommandInterceptor(DispatchInterceptorFactory<? super CommandMessage> interceptorFactory)

Registers the given component-aware interceptorFactory for a CommandMessage-specific MessageDispatchInterceptor.

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

Parameters:

interceptorFactory - the CommandMessage-specific MessageDispatchInterceptor factory to register

Returns:

this InterceptorRegistry, for fluent interfacing

registerEventInterceptor

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

Registers the given interceptorBuilder for a EventMessage-specific MessageDispatchInterceptor.

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

Parameters:

interceptorBuilder - the EventMessage-specific MessageDispatchInterceptor builder to register

Returns:

this InterceptorRegistry, for fluent interfacing

registerEventInterceptor

DispatchInterceptorRegistry registerEventInterceptor(DispatchInterceptorFactory<? super EventMessage> interceptorFactory)

Registers the given component-aware interceptorFactory for a EventMessage-specific MessageDispatchInterceptor.

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

Parameters:

interceptorFactory - the EventMessage-specific MessageDispatchInterceptor factory to register

Returns:

this InterceptorRegistry, for fluent interfacing

registerQueryInterceptor

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

Registers the given interceptorBuilder for a QueryMessage-specific MessageDispatchInterceptor.

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

Parameters:

interceptorBuilder - the QueryMessage-specific MessageDispatchInterceptor builder to register

Returns:

this InterceptorRegistry, for fluent interfacing

registerQueryInterceptor

DispatchInterceptorRegistry registerQueryInterceptor(DispatchInterceptorFactory<? super QueryMessage> interceptorFactory)

Registers the given component-aware interceptorFactory for a QueryMessage-specific MessageDispatchInterceptor.

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

Parameters:

interceptorFactory - the QueryMessage-specific MessageDispatchInterceptor factory to register

Returns:

this InterceptorRegistry, for fluent interfacing

registerSubscriptionQueryUpdateInterceptor

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

Registers the given interceptorBuilder for a SubscriptionQueryUpdateMessage-specific MessageDispatchInterceptor.

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

Parameters:

interceptorBuilder - the SubscriptionQueryUpdateMessage-specific MessageDispatchInterceptor builder to register

Returns:

this InterceptorRegistry, for fluent interfacing

registerSubscriptionQueryUpdateInterceptor

DispatchInterceptorRegistry registerSubscriptionQueryUpdateInterceptor(DispatchInterceptorFactory<? super SubscriptionQueryUpdateMessage> interceptorFactory)

Registers the given component-aware interceptorFactory for a SubscriptionQueryUpdateMessage-specific MessageDispatchInterceptor.

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 DispatchInterceptorFactory 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 registerSubscriptionQueryUpdateInterceptor(ComponentBuilder) instead.

Parameters:

interceptorFactory - the SubscriptionQueryUpdateMessage-specific MessageDispatchInterceptor factory to register

Returns:

this InterceptorRegistry, for fluent interfacing

commandInterceptors

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

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

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

Parameters:

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

componentType - the type of the component being intercepted

componentName - the name of the component being intercepted

Returns:

the list of CommandMessage-specific MessageDispatchInterceptors

eventInterceptors

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

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

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

Parameters:

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

componentType - the type of the component to retrieve a dispatch interceptor for

componentName - the name of the component to retrieve a dispatch interceptor for

Returns:

the list of EventMessage-specific MessageDispatchInterceptors

queryInterceptors

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

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

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

Parameters:

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

componentType - the type of the component to retrieve a dispatch interceptor for

componentName - the name of the component to retrieve a dispatch interceptor for

Returns:

the list of QueryMessage-specific MessageDispatchInterceptors

subscriptionQueryUpdateInterceptors

List<MessageDispatchInterceptor<? super SubscriptionQueryUpdateMessage>> subscriptionQueryUpdateInterceptors(Configuration config,
 Class<?> componentType,
 @Nullable String componentName)

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

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

Parameters:

config - the configuration to build all SubscriptionQueryUpdateMessage-specific MessageDispatchInterceptors with

componentType - the type of the component to retrieve a dispatch interceptor for

componentName - the name of the component to retrieve a dispatch interceptor for

Returns:

the list of SubscriptionQueryUpdateMessage-specific MessageDispatchInterceptors