Package org.axonframework.messaging.monitoring.configuration

Class DefaultMessageMonitorRegistry

java.lang.Object

org.axonframework.messaging.monitoring.configuration.DefaultMessageMonitorRegistry

All Implemented Interfaces:

DescribableComponent, MessageMonitorRegistry

@Internal
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 and factories 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.

When using the ComponentBuilder registration methods, this registry will internally maintain a 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, Class<?> componentType, @Nullable String componentName)	Retrieves a MessageMonitor dedicated for monitoring CommandMessage processing for a specific componentType and componentName.
void	describeTo(ComponentDescriptor descriptor)	Describe the properties of this DescribableComponent with the given descriptor.
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 class java.lang.Object

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

Constructor Details

DefaultMessageMonitorRegistry

public DefaultMessageMonitorRegistry()

Method Details

registerMonitor

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

Description copied from interface: MessageMonitorRegistry

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.

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

registerMonitor

public MessageMonitorRegistry registerMonitor(MessageMonitorFactory<Message> monitorFactory)

Description copied from interface: MessageMonitorRegistry

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

Specified by:

registerMonitor in interface MessageMonitorRegistry

Parameters:

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

Returns:

the updated MessageMonitorRegistry instance for fluent configuration

registerCommandMonitor

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

Description copied from interface: MessageMonitorRegistry

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

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

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

registerCommandMonitor

public MessageMonitorRegistry registerCommandMonitor(MessageMonitorFactory<? super CommandMessage> monitorFactory)

Description copied from interface: MessageMonitorRegistry

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

Specified by:

registerCommandMonitor in interface MessageMonitorRegistry

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

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

Description copied from interface: MessageMonitorRegistry

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.

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 for a fluent configuration approach

registerEventMonitor

public MessageMonitorRegistry registerEventMonitor(MessageMonitorFactory<? super EventMessage> monitorFactory)

Description copied from interface: MessageMonitorRegistry

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

Specified by:

registerEventMonitor in interface MessageMonitorRegistry

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

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

Description copied from interface: MessageMonitorRegistry

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

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

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 a fluent configuration approach

registerQueryMonitor

public MessageMonitorRegistry registerQueryMonitor(MessageMonitorFactory<? super QueryMessage> monitorFactory)

Description copied from interface: MessageMonitorRegistry

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

Specified by:

registerQueryMonitor in interface MessageMonitorRegistry

Parameters:

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

Returns:

the updated MessageMonitorRegistry instance, allowing for a fluent configuration approach

registerSubscriptionQueryUpdateMonitor

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

Description copied from interface: MessageMonitorRegistry

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

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

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 a fluent configuration approach

registerSubscriptionQueryUpdateMonitor

public MessageMonitorRegistry registerSubscriptionQueryUpdateMonitor(MessageMonitorFactory<? super SubscriptionQueryUpdateMessage> monitorFactory)

Description copied from interface: MessageMonitorRegistry

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

Specified by:

registerSubscriptionQueryUpdateMonitor in interface MessageMonitorRegistry

Parameters:

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

Returns:

the updated MessageMonitorRegistry instance, allowing for a fluent configuration approach

commandMonitor

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

Description copied from interface: MessageMonitorRegistry

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.

Specified by:

commandMonitor in interface MessageMonitorRegistry

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

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

Description copied from interface: MessageMonitorRegistry

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.

Specified by:

eventMonitor in interface MessageMonitorRegistry

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

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

Description copied from interface: MessageMonitorRegistry

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.

Specified by:

queryMonitor in interface MessageMonitorRegistry

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

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

Description copied from interface: MessageMonitorRegistry

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.

Specified by:

subscriptionQueryUpdateMonitor in interface MessageMonitorRegistry

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

describeTo

public void describeTo(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.