Package org.axonframework.messaging.monitoring.configuration

Interface MessageMonitorRegistry

All Superinterfaces:

DescribableComponent

All Known Implementing Classes:

DefaultMessageMonitorRegistry

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.

Since:

5.0.0

Author:

Jan Galinski

Method Summary

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

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

describeTo

Method Details

registerMonitor

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

Registers a MessageMonitor for generic Message types using the supplied monitor builder. The registered monitor will be added to the registry and can be used for monitoring message processing.

Parameters:

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

Returns:

the updated MessageMonitorRegistry instance for fluent configuration

registerEventMonitor

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

Registers a MessageMonitor specific for EventMessage types using the supplied monitor builder. The registered monitor can be utilized for monitoring event message processing.

Parameters:

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

Returns:

the updated MessageMonitorRegistry instance, allowing fluent configuration

registerCommandMonitor

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

Registers a MessageMonitor specifically for monitoring the processing of CommandMessage instances. The provided ComponentBuilder is responsible for creating the MessageMonitor.

Parameters:

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

Returns:

the updated MessageMonitorRegistry instance, allowing for a fluent configuration approach.

registerQueryMonitor

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

Registers a MessageMonitor specifically for QueryMessage types using the provided ComponentBuilder. The registered monitor will be utilized for monitoring query message processing and is added to the registry.

Parameters:

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

Returns:

the updated MessageMonitorRegistry instance, allowing for fluent configuration

registerSubscriptionQueryUpdateMonitor

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

Registers a MessageMonitor specifically for SubscriptionQueryUpdateMessage types using the provided ComponentBuilder. The registered monitor will be utilized for monitoring subscription query update message processing and is added to the registry.

Parameters:

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

Returns:

the updated MessageMonitorRegistry instance, allowing for fluent configuration

commandMonitor

MessageMonitor<? super CommandMessage> commandMonitor(@Nonnull
 Configuration config)

Retrieves a MessageMonitor dedicated for monitoring CommandMessage processing.

Parameters:

config - the Configuration instance used to create the MessageMonitor instances

Returns:

MultiMessageMonitor composed of all registered MessageMonitors, or NoOpMessageMonitor.

eventMonitor

MessageMonitor<? super EventMessage> eventMonitor(@Nonnull
 Configuration config)

Retrieves a MessageMonitor specifically designed to monitor the processing of EventMessage instances.

Parameters:

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

Returns:

MultiMessageMonitor composed of all registered MessageMonitors, or NoOpMessageMonitor.

queryMonitor

MessageMonitor<? super QueryMessage> queryMonitor(@Nonnull
 Configuration config)

Retrieves a MessageMonitor for monitoring the processing of QueryMessage instances.

Parameters:

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

Returns:

MultiMessageMonitor composed of all registered MessageMonitors, or NoOpMessageMonitor.

subscriptionQueryUpdateMonitor

MessageMonitor<? super SubscriptionQueryUpdateMessage> subscriptionQueryUpdateMonitor(@Nonnull
 Configuration config)

Retrieves a MessageMonitor for monitoring the processing of SubscriptionQueryUpdateMessage instances.

Parameters:

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

Returns:

MultiMessageMonitor composed of all registered MessageMonitors, or NoOpMessageMonitor.