Class BroadcastingDispatcher

java.lang.Object
org.springframework.integration.dispatcher.AbstractDispatcher
org.springframework.integration.dispatcher.BroadcastingDispatcher
All Implemented Interfaces:
Aware, BeanFactoryAware, MessageDispatcher
public class BroadcastingDispatcher extends AbstractDispatcher implements BeanFactoryAware
A broadcasting dispatcher implementation. If the 'ignoreFailures' property is set to false (the default), it will fail fast such that any Exception thrown by a MessageHandler may prevent subsequent handlers from receiving the Message. However, when an Executor is provided, the Messages may be dispatched in separate Threads so that other handlers are invoked even when the 'ignoreFailures' flag is false.

If the 'ignoreFailures' flag is set to true on the other hand, it will make a best effort to send the message to each of its handlers. In other words, when 'ignoreFailures' is true, if it fails to send to any one handler, it will simply log a warn-level message but continue to send the Message to any other handlers.

If the 'requireSubscribers' flag is set to true, the sent message is considered as non-dispatched and rejected to the caller with the "Dispatcher has no subscribers" MessageDispatchingException.

Author:
Mark Fisher, Iwein Fuld, Gary Russell, Oleg Zhurakousky, Artem Bilan

  • Constructor Details

    • BroadcastingDispatcher

      public BroadcastingDispatcher()

    • BroadcastingDispatcher

      public BroadcastingDispatcher(Executor executor)

    • BroadcastingDispatcher

      public BroadcastingDispatcher(boolean requireSubscribers)

    • BroadcastingDispatcher

      public BroadcastingDispatcher(Executor executor, boolean requireSubscribers)

  • Method Details

    • setIgnoreFailures

      public void setIgnoreFailures(boolean ignoreFailures)
      Specify whether failures for one or more of the handlers should be ignored. By default this is false meaning that an Exception will be thrown when a handler fails. To override this and suppress Exceptions, set the value to true.

      Keep in mind that when using an Executor, even without ignoring the failures, other handlers may be invoked after one throws an Exception. Since the Executor is most likely using a different thread, this flag would only affect whether an error Message is sent to the error channel or not in the case that such an Executor has been configured.

      Parameters:
      ignoreFailures - true when failures are to be ignored.

    • setApplySequence

      public void setApplySequence(boolean applySequence)
      Specify whether to apply sequence numbers to the messages prior to sending to the handlers. By default, sequence numbers will not be applied.
      Parameters:
      applySequence - true when sequence information should be applied.

    • setMinSubscribers

      public void setMinSubscribers(int minSubscribers)
      If at least this number of subscribers receive the message, dispatch(Message) will return true. Default: 0.
      Parameters:
      minSubscribers - The minimum number of subscribers.

    • setMessageHandlingTaskDecorator

      public void setMessageHandlingTaskDecorator(MessageHandlingTaskDecorator messageHandlingTaskDecorator)

    • setBeanFactory

      public void setBeanFactory(BeanFactory beanFactory) throws BeansException
      Specified by:
      setBeanFactory in interface BeanFactoryAware
      Throws:
      BeansException

    • getMessageBuilderFactory

      protected MessageBuilderFactory getMessageBuilderFactory()

    • dispatch

      public boolean dispatch(Message<?> message)
      Description copied from interface: MessageDispatcher
      Dispatch the message.
      Specified by:
      dispatch in interface MessageDispatcher
      Parameters:
      message - the message.
      Returns:
      true if dispatched.