Package org.axonframework.test.util

Class RecordingMessageMonitor

java.lang.Object

org.axonframework.test.util.RecordingMessageMonitor

All Implemented Interfaces:

MessageMonitor<Message>

public class RecordingMessageMonitor
extends Object
implements MessageMonitor<Message>

A message monitor implementation that records the processing results of messages in the provided MessageMonitorReport instances. It supports logging the processing outcomes if logging is enabled. This monitor tracks whether messages were successfully processed, failed, or ignored and stores this information in the provided reports.

The class provides two constructors: one allows configuring a single report instance while enabling logging, and the other accepts a list of reports, defaulting logging to disabled.

The monitor provides functionality to handle messages as they are ingested and uses a callback to record the processing result for each message.

For further inspection, for example logging, you can overwrite the onReportSuccess(Message), onReportFailure(Message, Throwable) and onReportIgnored(Message) methods.

Nested Class Summary

Nested classes/interfaces inherited from interface org.axonframework.messaging.monitoring.MessageMonitor

MessageMonitor.MonitorCallback

Field Summary

Fields

Modifier and Type	Field	Description
protected final MessageMonitorReport	report

Constructor Summary

Constructors

Constructor	Description
RecordingMessageMonitor()	Constructs a RecordingMessageMonitor that records message processing outcomes in a new MessageMonitorReport.
RecordingMessageMonitor(MessageMonitorReport report)	Constructs a RecordingMessageMonitor that records message processing outcomes in the provided MessageMonitorReport and configures optional logging.

Method Summary

Modifier and Type	Method	Description
final MessageMonitor.MonitorCallback	onMessageIngested(@NotNull Message message)	Takes a message and returns a callback that should be used to inform the message monitor about the result of processing the message
protected void	onReportFailure(Message message, Throwable cause)	Hook for subclasses to perform additional actions when a message is reported as failed.
protected void	onReportIgnored(Message message)	Hook for subclasses to perform additional actions when a message is reported as ignored.
protected void	onReportSuccess(Message message)	Hook for subclasses to perform additional actions when a message is reported as successful.
MessageMonitorReport	report()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.axonframework.messaging.monitoring.MessageMonitor

onMessagesIngested

Field Details

report

protected final MessageMonitorReport report

Constructor Details

RecordingMessageMonitor

public RecordingMessageMonitor()

Constructs a RecordingMessageMonitor that records message processing outcomes in a new MessageMonitorReport.

See Also:

• RecordingMessageMonitor(MessageMonitorReport)

RecordingMessageMonitor

public RecordingMessageMonitor(@Nonnull
 MessageMonitorReport report)

Constructs a RecordingMessageMonitor that records message processing outcomes in the provided MessageMonitorReport and configures optional logging.

Parameters:

report - The MessageMonitorReport instance to record message processing results.

Method Details

onMessageIngested

public final MessageMonitor.MonitorCallback onMessageIngested(@NotNull
 @NotNull Message message)

Description copied from interface: MessageMonitor

Takes a message and returns a callback that should be used to inform the message monitor about the result of processing the message

Specified by:

onMessageIngested in interface MessageMonitor<Message>

Parameters:

message - the message to monitor

Returns:

the callback

report

public MessageMonitorReport report()

Returns:

Returns the report that stores the results of messages processed by this monitor.

onReportSuccess

protected void onReportSuccess(@Nonnull
 Message message)

Hook for subclasses to perform additional actions when a message is reported as successful.

Parameters:

message - The message that was reported as successful.

onReportFailure

protected void onReportFailure(@Nonnull
 Message message,
 @Nonnull
 Throwable cause)

Hook for subclasses to perform additional actions when a message is reported as failed.

Parameters:

message - The message that was reported as failed.

cause - The cause of the failure.

onReportIgnored

protected void onReportIgnored(@Nonnull
 Message message)

Hook for subclasses to perform additional actions when a message is reported as ignored.

Parameters:

message - The message that was reported as ignored.