Class UnicastSendingMessageHandler

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.handler.MessageHandlerSupport

org.springframework.integration.handler.AbstractMessageHandler

org.springframework.integration.ip.udp.outbound.AbstractInternetProtocolSendingMessageHandler

org.springframework.integration.ip.udp.outbound.UnicastSendingMessageHandler

org.springframework.integration.ip.udp.UnicastSendingMessageHandler

All Implemented Interfaces:

Runnable, org.reactivestreams.Subscriber<Message<?>>, Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, Lifecycle, Ordered, ComponentSourceAware, ExpressionCapable, Orderable, IntegrationPattern, CommonSocketOptions, NamedComponent, IntegrationManagement, ManageableLifecycle, TrackableComponent, MessageHandler, reactor.core.CoreSubscriber<Message<?>>

@Deprecated(forRemoval=true,
            since="7.0")
public class UnicastSendingMessageHandler
extends UnicastSendingMessageHandler

Deprecated, for removal: This API element is subject to removal in a future version.

since 7.0 in favor or UnicastSendingMessageHandler

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, Christian Tzolov, Ngoc Nhan

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.ip.udp.outbound.UnicastSendingMessageHandler

lock

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	Description
UnicastSendingMessageHandler(String destinationExpression)	Deprecated, for removal: This API element is subject to removal in a future version. Construct UnicastSendingMessageHandler based on the destination SpEL expression to determine the target destination at runtime against requestMessage.
UnicastSendingMessageHandler(String host, int port)	Deprecated, for removal: This API element is subject to removal in a future version. Basic constructor; no reliability; no acknowledgment.
UnicastSendingMessageHandler(String host, int port, boolean lengthCheck)	Deprecated, for removal: This API element is subject to removal in a future version. Can be used to add a length to each packet which can be checked at the destination.
UnicastSendingMessageHandler(String host, int port, boolean lengthCheck, boolean acknowledge, String ackHost, int ackPort, int ackTimeout)	Deprecated, for removal: This API element is subject to removal in a future version. Add a length and/or acknowledgment request to packets.
UnicastSendingMessageHandler(String host, int port, boolean acknowledge, String ackHost, int ackPort, int ackTimeout)	Deprecated, for removal: This API element is subject to removal in a future version. Add an acknowledgment request to packets.
UnicastSendingMessageHandler(Expression destinationExpression)	Deprecated, for removal: This API element is subject to removal in a future version. Construct UnicastSendingMessageHandler based on the destination SpEL expression to determine the target destination at runtime against requestMessage.

Method Summary

Methods inherited from class org.springframework.integration.ip.udp.outbound.UnicastSendingMessageHandler

convertAndSend, doStart, doStop, getAckPort, getComponentType, getSocket, getSoReceiveBufferSize, getTheSocket, handleMessageInternal, isAcknowledge, onInit, restartAckThread, run, setAckCounter, setLengthCheck, setLocalAddress, setReliabilityAttributes, setSocket, setSocketAttributes, setSocketCustomizer, setSocketExpression, setSocketExpressionString, setSoReceiveBufferSize, setTaskExecutor, startAckThread, updateAckAddress

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

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

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

handleMessage, onComplete, onError, onNext, onSubscribe, setObservationConvention

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

buildSendTimer, destroy, getIntegrationPatternType, getManagedName, getManagedType, getMetricsCaptor, getObservationRegistry, getOrder, getOverrides, isLoggingEnabled, isObserved, registerMetricsCaptor, registerObservationRegistry, sendTimer, setLoggingEnabled, setManagedName, setManagedType, setOrder, setShouldTrack, shouldTrack

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

afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentDescription, getComponentName, getComponentSource, getConversionService, getExpression, getIntegrationProperties, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentDescription, setComponentName, setComponentSource, 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 reactor.core.CoreSubscriber

currentContext

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

getThisAs

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

getBeanName, getComponentName

Constructor Details

UnicastSendingMessageHandler

public UnicastSendingMessageHandler(String host,
 int port)

Deprecated, for removal: This API element is subject to removal in a future version.

Basic constructor; no reliability; no acknowledgment.

Parameters:

host - Destination host.

port - Destination port.

UnicastSendingMessageHandler

public UnicastSendingMessageHandler(String destinationExpression)

Deprecated, for removal: This API element is subject to removal in a future version.

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(Expression destinationExpression)

Deprecated, for removal: This API element is subject to removal in a future version.

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(String host,
 int port,
 boolean lengthCheck)

Deprecated, for removal: This API element is subject to removal in a future version.

Can be 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(String host,
 int port,
 boolean acknowledge,
 String ackHost,
 int ackPort,
 int ackTimeout)

Deprecated, for removal: This API element is subject to removal in a future version.

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(String host,
 int port,
 boolean lengthCheck,
 boolean acknowledge,
 String ackHost,
 int ackPort,
 int ackTimeout)

Deprecated, for removal: This API element is subject to removal in a future version.

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.