org.axonframework.messaging.correlation

Interface CorrelationDataProvider

All Known Implementing Classes:

MessageOriginProvider, MultiCorrelationDataProvider, SimpleCorrelationDataProvider

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface CorrelationDataProvider

Object defining the data from a Message that should be attached as correlation data to messages generated as result of the processing of that message.

Since:

2.3

Author:

Allard Buijze

Method Summary

Modifier and Type	Method and Description
Map<String,?>	correlationDataFor(Message<?> message) Provides a map with the entries to attach as correlation data to generated messages while processing given message.

Method Detail

correlationDataFor

Map<String,?> correlationDataFor(Message<?> message)

Provides a map with the entries to attach as correlation data to generated messages while processing given message.

This method should not return null. Any exception thrown from this method might interfere with rolling back a transaction. Therefore, by default exceptions are caught, ignoring the correlation data that should have been added.

Parameters:

message - The message to define correlation data for

Returns:

the data to attach as correlation data to generated messages