Package org.axonframework.messaging.commandhandling.interception

Class InterceptingCommandHandlingComponent

java.lang.Object
org.axonframework.messaging.commandhandling.interception.InterceptingCommandHandlingComponent
All Implemented Interfaces:
DescribableComponent, CommandHandler, CommandHandlingComponent, MessageHandler
@Internal public class InterceptingCommandHandlingComponent extends Object implements CommandHandlingComponent
A CommandHandlingComponent that applies a list of interceptors around every command before delegating to the underlying component.

Interceptors are invoked in registration order. Each interceptor can inspect the command, modify it, short-circuit handling, or proceed to the next interceptor in the chain.

Since:
5.2.0
Author:
Allard Buijze

  • Constructor Details

    • InterceptingCommandHandlingComponent

      public InterceptingCommandHandlingComponent(List<MessageHandlerInterceptor<? super CommandMessage>> interceptors, CommandHandlingComponent delegate)
      Constructs a new InterceptingCommandHandlingComponent wrapping the given delegate with the given interceptors.
      Parameters:
      interceptors - the interceptors to apply, in invocation order
      delegate - the underlying component to delegate to after all interceptors have proceeded

  • Method Details

    • handle

      public MessageStream.Single<CommandResultMessage> handle(CommandMessage command, ProcessingContext processingContext)
      Description copied from interface: CommandHandler
      Handles the given command within the given context.

      The result message in the returned stream may be null. Only a single or empty result message should ever be expected.

      Specified by:
      handle in interface CommandHandler
      Parameters:
      command - The command to handle.
      processingContext - The context to the given command is handled in.
      Returns:
      A MessagesStream.Single of a CommandResultMessage.

    • supportedCommands

      public Set<QualifiedName> supportedCommands()
      Description copied from interface: CommandHandlingComponent
      All supported commands, referenced through a QualifiedName.
      Specified by:
      supportedCommands in interface CommandHandlingComponent
      Returns:
      All supported commands, referenced through a QualifiedName.

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