Package org.axonframework.messaging.core.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 the given message.
Since:
2.3.0
Author:
Allard Buijze

  • Method Summary

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

  • Method Details

    • correlationDataFor

      @Nonnull Map<String,String> correlationDataFor(@Nonnull 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.