Package org.axonframework.messaging.monitoring.configuration

Class DefaultMessageMonitorRegistry

java.lang.Object

org.axonframework.messaging.monitoring.configuration.DefaultMessageMonitorRegistry

All Implemented Interfaces:

DescribableComponent, MessageMonitorRegistry

public class DefaultMessageMonitorRegistry
extends Object
implements MessageMonitorRegistry

The DefaultMessageMonitorRegistry is a default implementation of the MessageMonitorRegistry interface responsible for managing and providing components of MessageMonitor for various message types such as CommandMessage, EventMessage, and QueryMessage.

This class allows registering monitor builders for each message type and resolves those monitors into properly initialized components when required. If no custom monitors are registered for a specific type, default implementations like NoOpMessageMonitor are returned to ensure no operational interruptions.

Internally, it maintains separate lists of ComponentDefinition to store the registered monitor builders for command, event, and query messages. It also supports registering a generic MessageMonitor for Message, in which case a specialized MessageMonitor is created for each of the supported subtypes.

Since:

5.0.0

Author:

Jan Galinski

Constructor Summary

Constructors

Constructor	Description
DefaultMessageMonitorRegistry()

Method Summary

Modifier and Type	Method	Description
MessageMonitor<? super CommandMessage>	commandMonitor(Configuration config)	Retrieves a MessageMonitor dedicated for monitoring CommandMessage processing.
void	describeTo(ComponentDescriptor descriptor)	Describe the properties of this DescribableComponent with the given descriptor.
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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DefaultMessageMonitorRegistry

public DefaultMessageMonitorRegistry()

Method Details

registerMonitor

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

Description copied from interface: MessageMonitorRegistry

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.

Specified by:

registerMonitor in interface MessageMonitorRegistry

Parameters:

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

Returns:

the updated MessageMonitorRegistry instance for fluent configuration

registerEventMonitor

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

Description copied from interface: MessageMonitorRegistry

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

Specified by:

registerEventMonitor in interface MessageMonitorRegistry

Parameters:

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

Returns:

the updated MessageMonitorRegistry instance, allowing fluent configuration

registerCommandMonitor

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

Description copied from interface: MessageMonitorRegistry

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

Specified by:

registerCommandMonitor in interface MessageMonitorRegistry

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
public MessageMonitorRegistry registerQueryMonitor(@Nonnull
 ComponentBuilder<MessageMonitor<? super QueryMessage>> monitorBuilder)

Description copied from interface: MessageMonitorRegistry

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.

Specified by:

registerQueryMonitor in interface MessageMonitorRegistry

Parameters:

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

Returns:

the updated MessageMonitorRegistry instance, allowing for fluent configuration

registerSubscriptionQueryUpdateMonitor

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

Description copied from interface: MessageMonitorRegistry

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.

Specified by:

registerSubscriptionQueryUpdateMonitor in interface MessageMonitorRegistry

Parameters:

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

Returns:

the updated MessageMonitorRegistry instance, allowing for fluent configuration

commandMonitor

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

Description copied from interface: MessageMonitorRegistry

Retrieves a MessageMonitor dedicated for monitoring CommandMessage processing.

Specified by:

commandMonitor in interface MessageMonitorRegistry

Parameters:

config - the Configuration instance used to create the MessageMonitor instances

Returns:

MultiMessageMonitor composed of all registered MessageMonitors, or NoOpMessageMonitor.

eventMonitor

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

Description copied from interface: MessageMonitorRegistry

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

Specified by:

eventMonitor in interface MessageMonitorRegistry

Parameters:

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

Returns:

MultiMessageMonitor composed of all registered MessageMonitors, or NoOpMessageMonitor.

queryMonitor

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

Description copied from interface: MessageMonitorRegistry

Retrieves a MessageMonitor for monitoring the processing of QueryMessage instances.

Specified by:

queryMonitor in interface MessageMonitorRegistry

Parameters:

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

Returns:

MultiMessageMonitor composed of all registered MessageMonitors, or NoOpMessageMonitor.

subscriptionQueryUpdateMonitor

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

Description copied from interface: MessageMonitorRegistry

Retrieves a MessageMonitor for monitoring the processing of SubscriptionQueryUpdateMessage instances.

Specified by:

subscriptionQueryUpdateMonitor in interface MessageMonitorRegistry

Parameters:

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

Returns:

MultiMessageMonitor composed of all registered MessageMonitors, or NoOpMessageMonitor.

describeTo

public void describeTo(@Nonnull
 ComponentDescriptor descriptor)

Description copied from interface: DescribableComponent

Describe the properties of this DescribableComponent with the given descriptor.

Components should call the appropriate describeProperty methods on the descriptor to register their properties. The descriptor is responsible for determining how these properties are formatted and structured in the final output.

Best Practices: As a general rule, all relevant fields of a DescribableComponent implementation should be described in this method. However, developers have discretion to include only the fields that make sense in the context. Not every field may be meaningful for description purposes, especially internal implementation details. Furthermore, components might want to expose different information based on their current state. The final decision on what properties to include lies with the person implementing the describeTo method, who should focus on providing information that is useful for understanding the component's configuration and state.

Example implementation:

 public void describeTo(ComponentDescriptor descriptor) {
     descriptor.describeProperty("name", this.name);
     descriptor.describeProperty("enabled", this.enabled);
     descriptor.describeProperty("configuration", this.configuration); // A nested component
     descriptor.describeProperty("handlers", this.eventHandlers);      // A collection
 }
 

Specified by:

describeTo in interface DescribableComponent

Parameters:

descriptor - The component descriptor to describe this DescribableComponentn its properties in.