Package org.springframework.integration.ip.dsl

Class TcpOutboundGatewaySpec

java.lang.Object

org.springframework.integration.dsl.IntegrationComponentSpec<S,H>

org.springframework.integration.dsl.MessageHandlerSpec<TcpOutboundGatewaySpec,TcpOutboundGateway>

org.springframework.integration.ip.dsl.TcpOutboundGatewaySpec

All Implemented Interfaces:

DisposableBean, FactoryBean<TcpOutboundGateway>, InitializingBean, Lifecycle, Phased, SmartLifecycle, ComponentsRegistration

public class TcpOutboundGatewaySpec
extends MessageHandlerSpec<TcpOutboundGatewaySpec,TcpOutboundGateway>
implements ComponentsRegistration

A MessageHandlerSpec for TcpOutboundGateways.

Since:

5.0

Author:

Gary Russell, Artem Bilan

Field Summary

Fields

Modifier and Type	Field	Description
protected final AbstractClientConnectionFactory	connectionFactory

Fields inherited from class org.springframework.integration.dsl.IntegrationComponentSpec

logger, PARSER, target

Fields inherited from interface org.springframework.beans.factory.FactoryBean

OBJECT_TYPE_ATTRIBUTE

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor	Description
TcpOutboundGatewaySpec(TcpClientConnectionFactorySpec<?,?> connectionFactorySpec)	Construct an instance using the supplied connection factory spec.
TcpOutboundGatewaySpec(AbstractClientConnectionFactory connectionFactoryBean)	Construct an instance using an existing spring-managed connection factory.

Method Summary

Modifier and Type	Method	Description
TcpOutboundGatewaySpec	async(boolean async)	Set to true to release the sending thread and receive the reply asynchronously.
TcpOutboundGatewaySpec	closeStreamAfterSend(boolean closeStreamAfterSend)	Set to true to close the connection output stream after sending without closing the connection.
Map<Object,String>	getComponentsToRegister()
TcpOutboundGatewaySpec	remoteTimeout(long remoteTimeout)
<P> TcpOutboundGatewaySpec	remoteTimeout(Function<Message<P>,?> remoteTimeoutFunction)	Configure a Function that will be invoked at runtime to determine the destination to which a message will be sent.
TcpOutboundGatewaySpec	unsolicitedMessageChannel(MessageChannel channel)	Set the unsolicited message channel.
TcpOutboundGatewaySpec	unsolicitedMessageChannelName(String channelName)	Set the unsolicited message channel name.
TcpOutboundGatewaySpec	unsolictedMessageChannelName(String channelName)	Deprecated, for removal: This API element is subject to removal in a future version. in favor of unsolicitedMessageChannelName(String) due to the typo in method name.
TcpOutboundGatewaySpec	unsolictedMessageChannelName(MessageChannel channel)	Deprecated, for removal: This API element is subject to removal in a future version. in favor of unsolicitedMessageChannel(MessageChannel) due to the typo in method name.

Methods inherited from class org.springframework.integration.dsl.IntegrationComponentSpec

_this, afterPropertiesSet, destroy, doGet, get, getId, getObject, getObjectType, getPhase, id, isAutoStartup, isRunning, start, stop, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.beans.factory.FactoryBean

isSingleton

Field Details

connectionFactory

protected final AbstractClientConnectionFactory connectionFactory

Constructor Details

TcpOutboundGatewaySpec

public TcpOutboundGatewaySpec(AbstractClientConnectionFactory connectionFactoryBean)

Construct an instance using an existing spring-managed connection factory.

Parameters:

connectionFactoryBean - the spring-managed bean.

TcpOutboundGatewaySpec

public TcpOutboundGatewaySpec(TcpClientConnectionFactorySpec<?,?> connectionFactorySpec)

Construct an instance using the supplied connection factory spec.

Parameters:

connectionFactorySpec - the spec.

Method Details

remoteTimeout

public TcpOutboundGatewaySpec remoteTimeout(long remoteTimeout)

Parameters:

remoteTimeout - the remote timeout to set.

Returns:

the spec.

See Also:

• TcpOutboundGateway.setRemoteTimeout(long)

remoteTimeout

public <P> TcpOutboundGatewaySpec remoteTimeout(Function<Message<P>,?> remoteTimeoutFunction)

Configure a Function that will be invoked at runtime to determine the destination to which a message will be sent. Typically used with a Java 8 Lambda expression:

 
 .remoteTimeout(m -> m.getHeaders().get('rto'))
 
 

Type Parameters:

P - the message payload type.

Parameters:

remoteTimeoutFunction - the function.

Returns:

the spec.

See Also:

• TcpOutboundGateway.setRemoteTimeoutExpression(org.springframework.expression.Expression)

closeStreamAfterSend

public TcpOutboundGatewaySpec closeStreamAfterSend(boolean closeStreamAfterSend)

Set to true to close the connection output stream after sending without closing the connection. Use to signal EOF to the server, such as when using a ByteArrayRawSerializer. Requires a single-use connection factory.

Parameters:

closeStreamAfterSend - true to close.

Returns:

the spec.

Since:

5.2

async

public TcpOutboundGatewaySpec async(boolean async)

Set to true to release the sending thread and receive the reply asynchronously.

Parameters:

async - true for asynchronous request/reply.

Returns:

the spec.

Since:

5.3

unsolictedMessageChannelName

@Deprecated(since="6.1",
            forRemoval=true)
public TcpOutboundGatewaySpec unsolictedMessageChannelName(String channelName)

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

in favor of unsolicitedMessageChannelName(String) due to the typo in method name.

Set the unsolicited message channel name.

Parameters:

channelName - the name.

Returns:

the spec.

Since:

5.4

unsolicitedMessageChannelName

public TcpOutboundGatewaySpec unsolicitedMessageChannelName(String channelName)

Set the unsolicited message channel name.

Parameters:

channelName - the name.

Returns:

the spec.

Since:

6.1

unsolictedMessageChannelName

@Deprecated(since="6.1",
            forRemoval=true)
public TcpOutboundGatewaySpec unsolictedMessageChannelName(MessageChannel channel)

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

in favor of unsolicitedMessageChannel(MessageChannel) due to the typo in method name.

Set the unsolicited message channel.

Parameters:

channel - the channel.

Returns:

the spec.

Since:

5.4

unsolicitedMessageChannel

public TcpOutboundGatewaySpec unsolicitedMessageChannel(MessageChannel channel)

Set the unsolicited message channel.

Parameters:

channel - the channel.

Returns:

the spec.

Since:

6.1

getComponentsToRegister

public Map<Object,String> getComponentsToRegister()

Specified by:

getComponentsToRegister in interface ComponentsRegistration