Package org.springframework.integration.dispatcher

Class UnicastingDispatcher

java.lang.Object

org.springframework.integration.dispatcher.AbstractDispatcher

org.springframework.integration.dispatcher.UnicastingDispatcher

All Implemented Interfaces:

MessageDispatcher

public class UnicastingDispatcher
extends AbstractDispatcher

Implementation of MessageDispatcher that will attempt to send a Message to at most one of its handlers. The handlers will be tried as determined by the LoadBalancingStrategy if one is configured. As soon as one of the handlers accepts the Message, the dispatcher will return true and ignore the rest of its handlers.

If the dispatcher has no handlers, a MessageDispatchingException will be thrown. If all handlers throw Exceptions, the dispatcher will throw an AggregateMessageDeliveryException.

A load-balancing strategy may be provided to this class to control the order in which the handlers will be tried.

Since:

1.0.2

Author:

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

Field Summary

Fields inherited from class org.springframework.integration.dispatcher.AbstractDispatcher

logger

Constructor Summary

Constructors

Constructor	Description
UnicastingDispatcher()
UnicastingDispatcher(Executor executor)

Method Summary

Modifier and Type	Method	Description
boolean	dispatch(Message<?> message)	Dispatch the message.
void	setFailover(boolean failover)	Specify whether this dispatcher should failover when a single MessageHandler throws an Exception.
void	setLoadBalancingStrategy(LoadBalancingStrategy loadBalancingStrategy)	Provide a LoadBalancingStrategy for this dispatcher.
void	setMessageHandlingTaskDecorator(MessageHandlingTaskDecorator messageHandlingTaskDecorator)

Methods inherited from class org.springframework.integration.dispatcher.AbstractDispatcher

addHandler, getHandlerCount, getHandlers, removeHandler, setMaxSubscribers, toString, tryOptimizedDispatch

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

UnicastingDispatcher

public UnicastingDispatcher()

UnicastingDispatcher

public UnicastingDispatcher(@Nullable Executor executor)

Method Details

setFailover

public void setFailover(boolean failover)

Specify whether this dispatcher should failover when a single MessageHandler throws an Exception. The default value is true.

Parameters:

failover - The failover boolean.

setLoadBalancingStrategy

public void setLoadBalancingStrategy(@Nullable LoadBalancingStrategy loadBalancingStrategy)

Provide a LoadBalancingStrategy for this dispatcher.

Parameters:

loadBalancingStrategy - The load balancing strategy implementation.

setMessageHandlingTaskDecorator

public void setMessageHandlingTaskDecorator(MessageHandlingTaskDecorator messageHandlingTaskDecorator)

dispatch

public final boolean dispatch(Message<?> message)

Description copied from interface: MessageDispatcher

Dispatch the message.

Parameters:

message - the message.

Returns:

true if dispatched.