Defines a Message Producing Endpoint for the
'org.springframework.integration.ip.udp.UnicastReceivingChannelAdapter' for receiving incoming udp packets.
If a (synchronous) downstream exception is
thrown and an "error-channel" is specified,
the
MessagingException will be sent to this channel. Otherwise, any
such exception
will simply be logged by the channel adapter.
Configures a Consumer Endpoint for the
'org.springframework.integration.ip.udp.UnicastSendingMessageHandler' to send UDP packets.
A SpEL expression to determine the destination address for the datagram packet
at runtime. The 'requestMessage' is used as a root object for evaluation context.
Must evaluate to 'URI', or 'String' in the URI style or 'SocketAddress'.
The 'IpHeaders.PACKET_ADDRESS' header from the received message throughout
'udp-inbound-channel-adapter' can be used with this expression as well.
Mutually exclusive with 'host'/'port' pair.
A SpEL expression to be evaluated to determine which datagram
socket use for sending outgoing UDP packets (e.g. UDP inbound
packet receiving Channel Adapter socket can be used).
Specifies a specific Executor to be used for handling acknowledgments in
the UDP adapter. If not supplied, an internal
pooled executor will be used. Needed on some platforms that require
the use of specific
task executors such as a WorkManagerTaskExecutor.
Specifies the order for invocation when this
endpoint is connected as a
subscriber to a SubscribableChannel.
Defines a Message Producing Endpoint for the
'org.springframework.integration.ip.tcp.TcpReceivingChannelAdapter' for receiving incoming tcp packets.
A connection factory is needed by an inbound adapter. If the
connection factory has a type 'server',
the factory is 'owned' by this adapter. If it has a type 'client', it
is owned by an outbound channel
adapter and this adapter will receive any incoming messages on the
connection created by the outbound
adapter.
If a (synchronous) downstream exception is thrown and an
"error-channel" is specified,
the MessagingException will be sent to this channel. Otherwise, any
such exception
will simply be logged by the channel adapter.
If set to true, causes the adapter to act as a client with respect
to
establishing the connection, rather than listening for incoming connections.
Requires a type="client" connection factory, with single-use set
to false.
Defaults to false.
Defines a Message Producing Endpoint for the
'org.springframework.integration.ip.tcp.TcpSendingMessageHandler' for sending TCP packets.
A connection factory is needed by an outbound adapter. If the
connection factory has a type 'client',
the factory is 'owned' by this adapter. If it has a type 'server', it
is owned by an inbound channel
adapter and this adapter will attempt to correlate messages to the
connection on which an original
inbound message was received.
Specifies the order for invocation when this endpoint is connected as a
subscriber to a SubscribableChannel.
If set to true, causes the adapter to establish a connection when
started,
rather than when the first message is sent.
Requires a type="client" connection factory, with single-use set to false.
Defaults to false.
Defines a Messaging Gateway Endpoint for the
'org.springframework.integration.ip.tcp.TcpInboundGateway' for receiving incoming TCP packets
and producing replies for them.
A connection factory is needed by an inbound adapter. The
connection factory must be of type 'server'.
If a (synchronous) downstream exception is thrown and an
"error-channel" is specified,
the MessagingException will be sent to this channel and the ultimate
response
of the error flow will be returned as a response by the gateway. If
no
"error-channel" is specified, any such exception
will simply be logged by the gateway. In such a situation, no response
is sent
to the client.
If set to true, causes the gateway to act as a client with respect
to
establishing the connection, rather than listening for incoming connections.
Requires a type="client" connection factory, with single-use set
to false.
Defaults to false.
Defines a Message Producing Endpoint for the
'org.springframework.integration.ip.tcp.TcpOutboundGateway' for sending TCP packets
and waiting for replies.
A connection factory is needed by an outbound adapter. The
connection factory must be of 'client'.
When using a shared socket, specifies the time the gateway will wait
to get access to the socket to send the request.
Specifies the time the gateway will wait for a reply
from the remote system. Prior to 2.2, this was specified
with the reply-timeout attribute. To provide easier migration,
this attribute defaults to the same value of the reply-timeout,
if supplied, or 10 seconds otherwise. Mutually exclusive with
'remote-timeout-expression'.
Specifies an expresssion that is evaluated against the outbound message
to determine the time the gateway will wait for a reply
from the remote system. Mutually exclusive with
'remote-timeout'.
Specifies the order for invocation when this endpoint is connected as a
subscriber to a SubscribableChannel.
Close the output stream after sending the message; this signals
EOF to the server while keeping the connection open to receive
the reply. Requires 'single-use' set to 'true'.
Defines a 'org.springframework.integration.ip.tcp.connection.ConnectionFactory' implementation bean.
Connection factories can be 'client' or 'server'. Client factories
open a connection to a server using a host and port. Server factories
listen on a port and create a separate connection for each
incoming
connection request.
The host to which a client connection factory will connect.
For client factories, the port to which a client connection factory
will connect.
For server factories, the port on which the factory will listen for
incoming
connections.
If true, the factory will use java.nio.channel.SocketChannel for
communication;
for a large number of connections on the server side, this can
provide better
performance and may use fewer threads.
If true, instructs the factory to use direct buffers if possible;
only applies if
using-nio is true. Refer to ByteBuffer javadocs for more information.
If true, a new connection will be created for each use. For inbound
adapters
where there is no outbound adapter sharing the factory, the connection
will
be closed after a message is received. For outbound adapters where
there is
no inbound adapter sharing the factory, or for inbound adapters
where an
outbound adapter shares the factory, the connection will be closed after
so-timeout milliseconds. For outbound adapters where an inbound
adapter shares
the factory, the connection will be closed after a response is
received.
A Serializer that converts message payloads
to/from output streams/input streams
associated with the
connection. Default is ByteArrayCrLfSerializer. Serializer and
Deserializer
would normally be the same but this is not required.
A Deserializer that converts message payloads to/from output
streams/input streams
associated with the connection. Default is ByteArrayCrLfSerializer.
Serializer and Deserializer
would normally be the same but this is not required.
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
listen 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.
A task executor for managing connections; if not specified a
cached thread pool task executor is used.
Specifies the connection backlog for server sockets. Does not
apply to client factories.
Whether or not to do a DNS reverse-lookup on the remote ip address to
insert the host name into the
message headers (ip_connectionId, ip_hostName). Default "true".
When set to "true", adds sequenceNumber and correlationId headers to
messages originating from
connections created by this factory. Facilitates resequencing if necessary.
Default "false".
A reference to a TcpSSLContextSupport strategy implementation.
Providing this reference
enables SSL on connections created by this factory. A
DefaultTcpSSLContextSupport implementation
is provided that takes keystore and trustore names and passwords.
The SSLContext created by
this implementation is used to obtain socket factories (when
using-nio="false") or SSLEngine
instances (when using-nio="true"). When this attribute is omitted, normal
plain text
sockets are used.
The timeout (in seconds) to use while performing handshakes on SSL sockets;
only applies when 'using-nio' is 'true'. Default: 30.
A reference to a TcpSocketSupport strategy implementation. Allows
post-processing Socket
and ServerSocket instances after creation and after configured
attributes are applied.
A reference to a TcpSocketFactorySupport strategy implementation.
Allows customization
of the factories used to create sockets. The default implementation
returns default.
ServerSocketFactory and SocketFactory instances, unless an 'ssl-context-support'
attribute has been supplied, in which case the SSLContext obtained
therefrom is
used to create SSLServerSocketFactory and SSLSocketFactory instances.
A reference to a TcpNioConnectionSupport strategy implementation.
When 'using-nio' is true, this is used to create connection objects.
Two default implementations are provided 'DefaultTcpNioConnectionSupport'
and 'DefaultTcpNioSSLConnectionSupport' depending on whether SSL is in
use of not.
A reference to a TcpNetConnectionSupport strategy implementation.
When 'using-nio' is false, this is used to create connection objects.
A reference to a TcpMessageMapper implementation. Allows
customization of headers in inbound messages by overriding
setCustomHeaders(). Default is TcpMessageMapper.
The delay (in milliseconds) before retrying a read after the previous attempt
failed due to insufficient threads. Default 100.
Only applies when 'using-nio' is true.
For client factories, the amount of time to wait for a connection to
be established.
The number of threads that will be used for socket/channel handling.
Only applies
if an external task-executor is NOT being used. When using an
external task executor,
its configuration specifies the number of threads.
Specifies a specific Executor to be used for socket handling. If not
supplied, an internal
pooled executor will be used (See pool-size). Needed on some platforms
that require the use of specific
task executors such as a WorkManagerTaskExecutor.
Whether or not to do a DNS reverse-lookup on the remote ip address to
insert the host name into the
message headers (ip_hostName). Default "true".
Common configuration for UDP-based adapters.
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
listen 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.
When in client mode, specifies the retry interval, in milliseconds, if
a connection
cannot be established. Defaults to 60000.
When in client mode,
provide a reference to the
TaskScheduler instance to
be used for establishing connections. If
not provided, the default
will use a thread pool of size 1.