Package org.axonframework.messaging.eventhandling.gateway

Class ProcessingContextEventAppender

java.lang.Object
org.axonframework.messaging.eventhandling.gateway.ProcessingContextEventAppender
All Implemented Interfaces:
DescribableComponent, EventAppender
@Internal public class ProcessingContextEventAppender extends Object implements EventAppender
Component that publishes events to an EventSink in the context of a ProcessingContext. The events will be published in the context this appender was created for. You can construct one through the
invalid reference 
EventAppender#forContext(ProcessingContext, Configuration)
method.
Since:
5.0.0
Author:
Mitchell Herrijgers

  • Method Details

    • append

      public void append(@Nonnull List<?> events)
      Description copied from interface: EventAppender
      Append a collection of events to the event store in the current ProcessingContext. The events will be published when the context commits.
      Specified by:
      append in interface EventAppender
      Parameters:
      events - The collection of events to publish.

    • 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.