org.springframework.integration.ip.udp

Class UnicastSendingMessageHandler

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.handler.AbstractMessageHandler

org.springframework.integration.ip.AbstractInternetProtocolSendingMessageHandler

org.springframework.integration.ip.udp.UnicastSendingMessageHandler

All Implemented Interfaces:

java.lang.Runnable, org.reactivestreams.Subscriber<org.springframework.messaging.Message<?>>, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle, org.springframework.core.Ordered, ExpressionCapable, Orderable, CommonSocketOptions, NamedComponent, ConfigurableMetricsAware<AbstractMessageHandlerMetrics>, IntegrationManagement, IntegrationStatsManagement, MessageHandlerMetrics, TrackableComponent, org.springframework.messaging.MessageHandler, reactor.core.CoreSubscriber<org.springframework.messaging.Message<?>>

Direct Known Subclasses:

MulticastSendingMessageHandler

public class UnicastSendingMessageHandler
extends AbstractInternetProtocolSendingMessageHandler
implements java.lang.Runnable

A MessageHandler implementation that maps a Message into a UDP datagram packet and sends that to the specified host and port. Messages can be basic, with no support for reliability, can be prefixed by a length so the receiving end can detect truncation, and can require a UDP acknowledgment to confirm delivery.

Since:

2.0

Author:

Gary Russell, Marcin Pilaczynski, Artem Bilan

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.integration.support.management.IntegrationManagement

IntegrationManagement.ManagementOverrides

Field Summary

Fields inherited from class org.springframework.integration.context.IntegrationObjectSupport

EXPRESSION_PARSER, logger

Fields inherited from interface org.springframework.integration.support.management.IntegrationManagement

METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
UnicastSendingMessageHandler(org.springframework.expression.Expression destinationExpression) Construct UnicastSendingMessageHandler based on the destination SpEL expression to determine the target destination at runtime against requestMessage.
UnicastSendingMessageHandler(java.lang.String destinationExpression) Construct UnicastSendingMessageHandler based on the destination SpEL expression to determine the target destination at runtime against requestMessage.
UnicastSendingMessageHandler(java.lang.String host, int port) Basic constructor; no reliability; no acknowledgment.
UnicastSendingMessageHandler(java.lang.String host, int port, boolean lengthCheck) Can used to add a length to each packet which can be checked at the destination.
UnicastSendingMessageHandler(java.lang.String host, int port, boolean lengthCheck, boolean acknowledge, java.lang.String ackHost, int ackPort, int ackTimeout) Add a length and/or acknowledgment request to packets.
UnicastSendingMessageHandler(java.lang.String host, int port, boolean acknowledge, java.lang.String ackHost, int ackPort, int ackTimeout) Add an acknowledgment request to packets.

Method Summary

Modifier and Type	Method and Description
protected void	convertAndSend(org.springframework.messaging.Message<?> message)
void	doStart()
protected void	doStop()
int	getAckPort()
java.lang.String	getComponentType() Subclasses may implement this method to provide component type information.
protected java.net.DatagramSocket	getSocket()
int	getSoReceiveBufferSize()
protected java.net.DatagramSocket	getTheSocket()
void	handleMessageInternal(org.springframework.messaging.Message<?> message)
boolean	isAcknowledge()
protected void	onInit() Subclasses may implement this for initialization logic.
void	restartAckThread() If exposed as an MBean, can be used to restart the ack thread if a fatal (bind) error occurred, without bouncing the JVM.
void	run() Process acknowledgments, if requested.
void	setAckCounter(int ackCounter)
void	setLengthCheck(boolean lengthCheck)
void	setLocalAddress(java.lang.String localAddress) On a multi-homed system, specifies the ip address of the network interface used to communicate.
protected void	setReliabilityAttributes(boolean lengthCheck, boolean acknowledge, java.lang.String ackHost, int ackPort, int ackTimeout)
protected void	setSocket(java.net.DatagramSocket socket)
protected void	setSocketAttributes(java.net.DatagramSocket socket)
void	setSocketExpression(org.springframework.expression.Expression socketExpression)
void	setSocketExpressionString(java.lang.String socketExpression)
void	setSoReceiveBufferSize(int size)
void	setTaskExecutor(java.util.concurrent.Executor taskExecutor)
void	startAckThread()
protected void	updateAckAddress()

Methods inherited from class org.springframework.integration.ip.AbstractInternetProtocolSendingMessageHandler

getDestinationAddress, getHost, getPort, getSoSendBufferSize, getSoTimeout, isRunning, setSoSendBufferSize, setSoTimeout, start, stop

Methods inherited from class org.springframework.integration.handler.AbstractMessageHandler

configureMetrics, destroy, getActiveCount, getActiveCountLong, getDuration, getErrorCount, getErrorCountLong, getHandleCount, getHandleCountLong, getManagedName, getManagedType, getMaxDuration, getMeanDuration, getMinDuration, getOrder, getOverrides, getStandardDeviationDuration, handleMessage, isCountsEnabled, isLoggingEnabled, isStatsEnabled, onComplete, onError, onNext, onSubscribe, registerMetricsCaptor, reset, setCountsEnabled, setLoggingEnabled, setManagedName, setManagedType, setOrder, setShouldTrack, setStatsEnabled

Methods inherited from class org.springframework.integration.context.IntegrationObjectSupport

afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanFactory, getChannelResolver, getComponentName, getConversionService, getExpression, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentName, setConversionService, setMessageBuilderFactory, setPrimaryExpression, setTaskScheduler, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.integration.support.context.NamedComponent

getComponentName

Methods inherited from interface reactor.core.CoreSubscriber

currentContext

Constructor Detail

UnicastSendingMessageHandler

public UnicastSendingMessageHandler(java.lang.String host,
                                    int port)

Basic constructor; no reliability; no acknowledgment.

Parameters:

host - Destination host.

port - Destination port.

UnicastSendingMessageHandler

public UnicastSendingMessageHandler(java.lang.String destinationExpression)

Construct UnicastSendingMessageHandler based on the destination SpEL expression to determine the target destination at runtime against requestMessage.

Parameters:

destinationExpression - the SpEL expression to evaluate the target destination at runtime. Must evaluate to String, URI or SocketAddress.

Since:

4.3

UnicastSendingMessageHandler

public UnicastSendingMessageHandler(org.springframework.expression.Expression destinationExpression)

Construct UnicastSendingMessageHandler based on the destination SpEL expression to determine the target destination at runtime against requestMessage.

Parameters:

destinationExpression - the SpEL expression to evaluate the target destination at runtime. Must evaluate to String, URI or SocketAddress.

Since:

4.3

UnicastSendingMessageHandler

public UnicastSendingMessageHandler(java.lang.String host,
                                    int port,
                                    boolean lengthCheck)

Can used to add a length to each packet which can be checked at the destination.

Parameters:

host - Destination Host.

port - Destination Port.

lengthCheck - If true, packets will contain a length.

UnicastSendingMessageHandler

public UnicastSendingMessageHandler(java.lang.String host,
                                    int port,
                                    boolean acknowledge,
                                    java.lang.String ackHost,
                                    int ackPort,
                                    int ackTimeout)

Add an acknowledgment request to packets.

Parameters:

host - Destination Host.

port - Destination Port.

acknowledge - If true, packets will request acknowledgment.

ackHost - The host to which acks should be sent. Required if ack true.

ackPort - The port to which acks should be sent.

ackTimeout - How long we will wait (milliseconds) for the ack.

UnicastSendingMessageHandler

public UnicastSendingMessageHandler(java.lang.String host,
                                    int port,
                                    boolean lengthCheck,
                                    boolean acknowledge,
                                    java.lang.String ackHost,
                                    int ackPort,
                                    int ackTimeout)

Add a length and/or acknowledgment request to packets.

Parameters:

host - Destination Host.

port - Destination Port.

lengthCheck - If true, packets will contain a length.

acknowledge - If true, packets will request acknowledgment.

ackHost - The host to which acks should be sent. Required if ack true.

ackPort - The port to which acks should be sent.

ackTimeout - How long we will wait (milliseconds) for the ack.

Method Detail

setReliabilityAttributes

protected final void setReliabilityAttributes(boolean lengthCheck,
                                              boolean acknowledge,
                                              java.lang.String ackHost,
                                              int ackPort,
                                              int ackTimeout)

setLengthCheck

public void setLengthCheck(boolean lengthCheck)

Parameters:

lengthCheck - if true, a four byte binary length header is added to the packet, allowing the receiver to check for data truncation.

Since:

5.0

doStart

public void doStart()

Specified by:

doStart in class AbstractInternetProtocolSendingMessageHandler

doStop

protected void doStop()

Specified by:

doStop in class AbstractInternetProtocolSendingMessageHandler

handleMessageInternal

public void handleMessageInternal(org.springframework.messaging.Message<?> message)
                           throws org.springframework.messaging.MessageHandlingException,
                                  org.springframework.messaging.MessageDeliveryException

Specified by:

handleMessageInternal in class AbstractMessageHandler

Throws:

org.springframework.messaging.MessageHandlingException

org.springframework.messaging.MessageDeliveryException

startAckThread

public void startAckThread()

convertAndSend

protected void convertAndSend(org.springframework.messaging.Message<?> message)
                       throws java.lang.Exception

Throws:

java.lang.Exception

setSocket

protected void setSocket(java.net.DatagramSocket socket)

getTheSocket

@Nullable
protected java.net.DatagramSocket getTheSocket()

getSocket

protected java.net.DatagramSocket getSocket()
                                     throws java.io.IOException

Throws:

java.io.IOException

updateAckAddress

protected void updateAckAddress()

setSoReceiveBufferSize

public void setSoReceiveBufferSize(int size)

Specified by:

setSoReceiveBufferSize in interface CommonSocketOptions

Overrides:

setSoReceiveBufferSize in class AbstractInternetProtocolSendingMessageHandler

Parameters:

size - The receive buffer size.

See Also:

Socket.setReceiveBufferSize(int), DatagramSocket.setReceiveBufferSize(int)

setLocalAddress

public void setLocalAddress(java.lang.String localAddress)

Description copied from interface: CommonSocketOptions

On a multi-homed system, specifies the ip address of the network interface used to communicate. For inbound adapters and gateways, specifies the interface used to listed for incoming connections. If omitted, the endpoint will listen on all available adapters. For the UDP multicast outbound adapter specifies the interface to which multicast packets will be sent. For UDP unicast and multicast adapters, specifies which interface to which the acknowledgment socket will be bound. Does not apply to TCP outbound adapters and gateways.

Specified by:

setLocalAddress in interface CommonSocketOptions

Parameters:

localAddress - The local address.

setTaskExecutor

public void setTaskExecutor(java.util.concurrent.Executor taskExecutor)

setAckCounter

public void setAckCounter(int ackCounter)

Parameters:

ackCounter - the ackCounter to set

setSocketExpression

public void setSocketExpression(org.springframework.expression.Expression socketExpression)

Parameters:

socketExpression - the socket expression to determine the target socket at runtime.

Since:

4.3

setSocketExpressionString

public void setSocketExpressionString(java.lang.String socketExpression)

Parameters:

socketExpression - the socket SpEL expression to determine the target socket at runtime.

Since:

4.3

getComponentType

public java.lang.String getComponentType()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this method to provide component type information.

Specified by:

getComponentType in interface NamedComponent

Overrides:

getComponentType in class AbstractMessageHandler

isAcknowledge

public boolean isAcknowledge()

Returns:

the acknowledge

getAckPort

public int getAckPort()

Returns:

the ackPort

getSoReceiveBufferSize

public int getSoReceiveBufferSize()

Returns:

the soReceiveBufferSize

onInit

protected void onInit()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this for initialization logic.

Overrides:

onInit in class AbstractMessageHandler

setSocketAttributes

protected void setSocketAttributes(java.net.DatagramSocket socket)
                            throws java.net.SocketException

Throws:

java.net.SocketException

run

public void run()

Process acknowledgments, if requested.

Specified by:

run in interface java.lang.Runnable

restartAckThread

public void restartAckThread()

If exposed as an MBean, can be used to restart the ack thread if a fatal (bind) error occurred, without bouncing the JVM.