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, Class, String), eventInterceptors(Configuration, Class, String), and queryInterceptors(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<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.
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 interface org.axonframework.common.infra.DescribableComponent

describeTo

Method Details

registerInterceptor

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

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.

Parameters:

interceptorBuilder - the generic Message MessageHandlerInterceptor builder to register

Returns:

this InterceptorRegistry, for fluent interfacing

registerInterceptor

HandlerInterceptorRegistry registerInterceptor(HandlerInterceptorFactory<Message> interceptorFactory)

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

Parameters:

interceptorFactory - the generic Message MessageHandlerInterceptor factory to register

Returns:

this InterceptorRegistry, for fluent interfacing

registerCommandInterceptor

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

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.

Parameters:

interceptorBuilder - the CommandMessage-specific MessageHandlerInterceptor builder to register

Returns:

this InterceptorRegistry, for fluent interfacing

registerCommandInterceptor

HandlerInterceptorRegistry registerCommandInterceptor(HandlerInterceptorFactory<? super CommandMessage> interceptorFactory)

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

Parameters:

interceptorFactory - the CommandMessage-specific MessageHandlerInterceptor factory to register

Returns:

this InterceptorRegistry, for fluent interfacing

registerEventInterceptor

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

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.

Parameters:

interceptorBuilder - the EventMessage-specific MessageHandlerInterceptor builder to register

Returns:

this InterceptorRegistry, for fluent interfacing

registerEventInterceptor

HandlerInterceptorRegistry registerEventInterceptor(HandlerInterceptorFactory<? super EventMessage> interceptorFactory)

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

Parameters:

interceptorFactory - the EventMessage-specific MessageHandlerInterceptor factory to register

Returns:

this InterceptorRegistry, for fluent interfacing

registerQueryInterceptor

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

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.

Parameters:

interceptorBuilder - the QueryMessage-specific MessageHandlerInterceptor builder to register

Returns:

this InterceptorRegistry, for fluent interfacing

registerQueryInterceptor

HandlerInterceptorRegistry registerQueryInterceptor(HandlerInterceptorFactory<? super QueryMessage> interceptorFactory)

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

Parameters:

interceptorFactory - the QueryMessage-specific MessageHandlerInterceptor factory to register

Returns:

this InterceptorRegistry, for fluent interfacing

commandInterceptors

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.

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

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

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.

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

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

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.

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

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