Package org.axonframework.messaging.monitoring.configuration

Interface MessageMonitorRegistry

All Superinterfaces:

DescribableComponent

All Known Implementing Classes:

DefaultMessageMonitorRegistry

@Internal
public interface MessageMonitorRegistry
extends DescribableComponent

A registry of MessageMonitors, acting as a collection of registered MessageMonitor components.

Provides operations to register generic Message, CommandMessage-specific, EventMessage-specific, or QueryMessage-specific MessageMonitors. Multiple MessageMonitors will be combined to a single MultiMessageMonitor.

Ingesting and reporting of messages is done via monitoring interception which wrap the monitor. These interception are registered through the MessagingConfigurationDefaults dispatcher registry factory methods.

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

Since:

5.0.0

Author:

Jan Galinski

Method Summary

Modifier and Type	Method	Description
MessageMonitor<? super CommandMessage>	commandMonitor(Configuration config, Class<?> componentType, @Nullable String componentName)	Retrieves a MessageMonitor dedicated for monitoring CommandMessage processing for a specific componentType and componentName.
MessageMonitor<? super EventMessage>	eventMonitor(Configuration config, Class<?> componentType, @Nullable String componentName)	Retrieves a MessageMonitor specifically designed to monitor the processing of EventMessage instances for a specific componentType and componentName.
MessageMonitor<? super QueryMessage>	queryMonitor(Configuration config, Class<?> componentType, @Nullable String componentName)	Retrieves a MessageMonitor for monitoring the processing of QueryMessage instances for a specific componentType and componentName.
MessageMonitorRegistry	registerCommandMonitor(ComponentBuilder<MessageMonitor<? super CommandMessage>> monitorBuilder)	Registers a MessageMonitor specifically for monitoring the processing of CommandMessage instances.
MessageMonitorRegistry	registerCommandMonitor(MessageMonitorFactory<? super CommandMessage> monitorFactory)	Registers a component-aware MessageMonitor specifically for monitoring the processing of CommandMessage instances using the given monitorFactory.
MessageMonitorRegistry	registerEventMonitor(ComponentBuilder<MessageMonitor<? super EventMessage>> monitorBuilder)	Registers a MessageMonitor specific for EventMessage types using the supplied monitor builder.
MessageMonitorRegistry	registerEventMonitor(MessageMonitorFactory<? super EventMessage> monitorFactory)	Registers a component-aware MessageMonitor specifically for monitoring the processing of EventMessage instances using the given monitorFactory.
MessageMonitorRegistry	registerMonitor(ComponentBuilder<MessageMonitor<Message>> monitorBuilder)	Registers a MessageMonitor for generic Message types using the supplied monitor builder.
MessageMonitorRegistry	registerMonitor(MessageMonitorFactory<Message> monitorFactory)	Registers a component-aware MessageMonitor for generic Message types using the given monitorFactory.
MessageMonitorRegistry	registerQueryMonitor(ComponentBuilder<MessageMonitor<? super QueryMessage>> monitorBuilder)	Registers a MessageMonitor specifically for QueryMessage types using the provided ComponentBuilder.
MessageMonitorRegistry	registerQueryMonitor(MessageMonitorFactory<? super QueryMessage> monitorFactory)	Registers a component-aware MessageMonitor specifically for monitoring the processing of QueryMessage instances using the given monitorFactory.
MessageMonitorRegistry	registerSubscriptionQueryUpdateMonitor(ComponentBuilder<MessageMonitor<? super SubscriptionQueryUpdateMessage>> monitorBuilder)	Registers a MessageMonitor specifically for SubscriptionQueryUpdateMessage types using the provided ComponentBuilder.
MessageMonitorRegistry	registerSubscriptionQueryUpdateMonitor(MessageMonitorFactory<? super SubscriptionQueryUpdateMessage> monitorFactory)	Registers a component-aware MessageMonitor specifically for monitoring the processing of SubscriptionQueryUpdateMessage instances using the given monitorFactory.
MessageMonitor<? super SubscriptionQueryUpdateMessage>	subscriptionQueryUpdateMonitor(Configuration config, Class<?> componentType, @Nullable String componentName)	Retrieves a MessageMonitor for monitoring the processing of SubscriptionQueryUpdateMessage instances for a specific componentType and componentName.

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

describeTo

Method Details

registerMonitor

MessageMonitorRegistry registerMonitor(ComponentBuilder<MessageMonitor<Message>> monitorBuilder)

Registers a MessageMonitor for generic Message types using the supplied monitor builder.

Registering a monitor per a ComponentBuilder ensures the monitor is only built once.

Parameters:

monitorBuilder - the ComponentBuilder responsible for creating the MessageMonitor instance for generic Message types

Returns:

the updated MessageMonitorRegistry instance for fluent configuration

registerMonitor

MessageMonitorRegistry registerMonitor(MessageMonitorFactory<Message> monitorFactory)

Registers a component-aware MessageMonitor for generic Message types using the given monitorFactory.

The factory will receive the component type and name when the monitor is retrieved allowing for omponent-specific customization of the monitor. Registering a monitor per a MessageMonitorFactory enforces construction of the monitor for every invocation of the factory, ensuring uniqueness per given type and name. If the monitor will be identical regardless of the given type or name, please use registerMonitor(ComponentBuilder) instead.

Parameters:

monitorFactory - the MessageMonitorFactory responsible for creating the MessageMonitor instance for generic Message types

Returns:

the updated MessageMonitorRegistry instance for fluent configuration

registerCommandMonitor

MessageMonitorRegistry registerCommandMonitor(ComponentBuilder<MessageMonitor<? super CommandMessage>> monitorBuilder)

Registers a MessageMonitor specifically for monitoring the processing of CommandMessage instances.

Registering a monitor per a ComponentBuilder ensures the monitor is only build once.

Parameters:

monitorBuilder - the ComponentBuilder used to create the MessageMonitor instance for CommandMessage types

Returns:

the updated MessageMonitorRegistry instance, allowing for a fluent configuration approach

registerCommandMonitor

MessageMonitorRegistry registerCommandMonitor(MessageMonitorFactory<? super CommandMessage> monitorFactory)

Registers a component-aware MessageMonitor specifically for monitoring the processing of CommandMessage instances using the given monitorFactory.

The factory will receive the component type and name when the monitor is retrieved allowing for component-specific customization of the monitor. Registering a monitor per a MessageMonitorFactory enforces construction of the monitor for every invocation of the factory, ensuring uniqueness per given type and name. If the monitor will be identical regardless of the given type or name, please use registerCommandMonitor(ComponentBuilder) instead.

Parameters:

monitorFactory - the MessageMonitorFactory used to create the MessageMonitor instance for CommandMessage types

Returns:

the updated MessageMonitorRegistry instance, allowing for a fluent configuration approach

registerEventMonitor

MessageMonitorRegistry registerEventMonitor(ComponentBuilder<MessageMonitor<? super EventMessage>> monitorBuilder)

Registers a MessageMonitor specific for EventMessage types using the supplied monitor builder.

Registering a monitor per a ComponentBuilder ensures the monitor is only build once.

Parameters:

monitorBuilder - the ComponentBuilder responsible for creating the MessageMonitor instance for EventMessage types

Returns:

the updated MessageMonitorRegistry instance, allowing for a fluent configuration approach

registerEventMonitor

MessageMonitorRegistry registerEventMonitor(MessageMonitorFactory<? super EventMessage> monitorFactory)

Registers a component-aware MessageMonitor specifically for monitoring the processing of EventMessage instances using the given monitorFactory.

The factory will receive the component type and name when the monitor is retrieved allowing for component-specific customization of the monitor. Registering a monitor per a MessageMonitorFactory enforces construction of the monitor for every invocation of the factory, ensuring uniqueness per given type and name. If the monitor will be identical regardless of the given type or name, please use registerEventMonitor(ComponentBuilder) instead.

Parameters:

monitorFactory - the MessageMonitorFactory responsible for creating the MessageMonitor instance for EventMessage types

Returns:

the updated MessageMonitorRegistry instance, allowing for a fluent configuration approach

registerQueryMonitor

MessageMonitorRegistry registerQueryMonitor(ComponentBuilder<MessageMonitor<? super QueryMessage>> monitorBuilder)

Registers a MessageMonitor specifically for QueryMessage types using the provided ComponentBuilder.

Registering a monitor per a ComponentBuilder ensures the monitor is only build once.

Parameters:

monitorBuilder - the ComponentBuilder responsible for creating the MessageMonitor for QueryMessage types

Returns:

the updated MessageMonitorRegistry instance, allowing for a fluent configuration approach

registerQueryMonitor

MessageMonitorRegistry registerQueryMonitor(MessageMonitorFactory<? super QueryMessage> monitorFactory)

Registers a component-aware MessageMonitor specifically for monitoring the processing of QueryMessage instances using the given monitorFactory.

The factory will receive the component type and name when the monitor is retrieved allowing for component-specific customization of the monitor. Registering a monitor per a MessageMonitorFactory enforces construction of the monitor for every invocation of the factory, ensuring uniqueness per given type and name. If the monitor will be identical regardless of the given type or name, please use registerQueryMonitor(ComponentBuilder) instead.

Parameters:

monitorFactory - the MessageMonitorFactory responsible for creating the MessageMonitor for QueryMessage types

Returns:

the updated MessageMonitorRegistry instance, allowing for a fluent configuration approach

registerSubscriptionQueryUpdateMonitor

MessageMonitorRegistry registerSubscriptionQueryUpdateMonitor(ComponentBuilder<MessageMonitor<? super SubscriptionQueryUpdateMessage>> monitorBuilder)

Registers a MessageMonitor specifically for SubscriptionQueryUpdateMessage types using the provided ComponentBuilder.

Registering a monitor per a ComponentBuilder ensures the monitor is only build once.

Parameters:

monitorBuilder - the ComponentBuilder responsible for creating the MessageMonitor for SubscriptionQueryUpdateMessage types

Returns:

the updated MessageMonitorRegistry instance, allowing for a fluent configuration approach

registerSubscriptionQueryUpdateMonitor

MessageMonitorRegistry registerSubscriptionQueryUpdateMonitor(MessageMonitorFactory<? super SubscriptionQueryUpdateMessage> monitorFactory)

Registers a component-aware MessageMonitor specifically for monitoring the processing of SubscriptionQueryUpdateMessage instances using the given monitorFactory.

The factory will receive the component type and name when the monitor is retrieved allowing for component-specific customization of the monitor. Registering a monitor per a MessageMonitorFactory enforces construction of the monitor for every invocation of the factory, ensuring uniqueness per given type and name. If the monitor will be identical regardless of the given type or name, please use registerSubscriptionQueryUpdateMonitor(ComponentBuilder) instead.

Parameters:

monitorFactory - the MessageMonitorFactory responsible for creating the MessageMonitor for SubscriptionQueryUpdateMessage types

Returns:

the updated MessageMonitorRegistry instance, allowing for a fluent configuration approach

commandMonitor

MessageMonitor<? super CommandMessage> commandMonitor(Configuration config,
 Class<?> componentType,
 @Nullable String componentName)

Retrieves a MessageMonitor dedicated for monitoring CommandMessage processing for a specific componentType and componentName.

The returned monitor contains generic Message MessageMonitors that have been registered when the generic builder/factory returns an instance.

Parameters:

config - the Configuration instance used to create the MessageMonitor instances

componentType - the type of the component to retrieve a monitor for

componentName - the name of the component to retrieve a monitor for

Returns:

MultiMessageMonitor composed of all registered MessageMonitors, or NoOpMessageMonitor

eventMonitor

MessageMonitor<? super EventMessage> eventMonitor(Configuration config,
 Class<?> componentType,
 @Nullable String componentName)

Retrieves a MessageMonitor specifically designed to monitor the processing of EventMessage instances for a specific componentType and componentName.

The returned monitor contains generic Message MessageMonitors that have been registered when the generic builder/factory returns an instance.

Parameters:

config - the Configuration instance used to create or retrieve the MessageMonitor instances

componentType - the type of the component to retrieve a monitor for

componentName - the name of the component to retrieve a monitor for

Returns:

MultiMessageMonitor composed of all registered MessageMonitors, or NoOpMessageMonitor

queryMonitor

MessageMonitor<? super QueryMessage> queryMonitor(Configuration config,
 Class<?> componentType,
 @Nullable String componentName)

Retrieves a MessageMonitor for monitoring the processing of QueryMessage instances for a specific componentType and componentName.

The returned monitor contains generic Message MessageMonitors that have been registered when the generic builder/factory returns an instance.

Parameters:

config - the Configuration used to create or retrieve the MessageMonitor for QueryMessage types

componentType - the type of the component to retrieve a monitor for

componentName - the name of the component to retrieve a monitor for

Returns:

MultiMessageMonitor composed of all registered MessageMonitors, or NoOpMessageMonitor

subscriptionQueryUpdateMonitor

MessageMonitor<? super SubscriptionQueryUpdateMessage> subscriptionQueryUpdateMonitor(Configuration config,
 Class<?> componentType,
 @Nullable String componentName)

Retrieves a MessageMonitor for monitoring the processing of SubscriptionQueryUpdateMessage instances for a specific componentType and componentName.

The returned monitor contains generic Message MessageMonitors that have been registered when the generic builder/factory returns an instance.

Parameters:

config - the Configuration used to create or retrieve the MessageMonitor for SubscriptionQueryUpdateMessage types

componentType - the type of the component to retrieve a monitor for

componentName - the name of the component to retrieve a monitor for

Returns:

MultiMessageMonitor composed of all registered MessageMonitors, or NoOpMessageMonitor