Spring/spring-integration
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

GH-8586: Deprecate IntegrationComponentSpec.get() (#8594)

Browse Source 
* GH-8586: Deprecate IntegrationComponentSpec.get()

Fixes https://github.com/spring-projects/spring-integration/issues/8586

The `IntegrationComponentSpec` is not a plain wrapper around single component.
Sometimes it comes with several components where all of them must be registered
as beans.
If `IntegrationComponentSpec.get()` is called from end-user code, we may lose
other related components, for example filters in the `FileInboundChannelAdapterSpec`.

* Deprecate `IntegrationComponentSpec.get()` with no-op for end-user,
rather encourage to leave it as is and let the framework take care about its lifecycle
and related components registration
* Fix `IntegrationComponentSpec` logic to deal as a simple `FactoryBean` instead of
extra overhead via `AbstractFactoryBean`
* Use `IntegrationComponentSpec.getObject()` in the framework code where `get()` was called
* Fix tests to expose `IntegrationComponentSpec` as beans instead of previously called `get()`
* Some other clean up and typos fixes in the affected classes
* Document the change

* * Revert `ObjectStringMapBuilder` in the `KafkaInboundGatewaySpec.getComponentsToRegister()`

* Fix language in docs

Co-authored-by: Gary Russell <grussell@vmware.com>

* * Remove trailing whitespace in the `ScriptMessageSourceSpec`

---------

Co-authored-by: Gary Russell <grussell@vmware.com>
This commit is contained in:
Artem Bilan
2023-04-13 09:16:42 -04:00
committed by GitHub
parent bbaffb22bf
commit b99729544d
46 changed files with 401 additions and 369 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
spring-integration-ip/src/test/java/org/springframework/integration/ip/dsl/ConnectionFacforyTests.java → spring-integration-ip/src/test/java/org/springframework/integration/ip/dsl/ConnectionFactoryTests.java
View File

@@ -45,16 +45,18 @@ import static org.mockito.Mockito.mock;
/**
* @author Gary Russell
* @author Tim Ysewyn
* @author Artem Bilan
*
* @since 5.0
*
*/
public class ConnectionFacforyTests {
public class ConnectionFactoryTests {
@Test
public void test() throws Exception {
ApplicationEventPublisher publisher = e -> {
};
AbstractServerConnectionFactory server = Tcp.netServer(0).backlog(2).soTimeout(5000).get();
AbstractServerConnectionFactory server = Tcp.netServer(0).backlog(2).soTimeout(5000).getObject();
final AtomicReference<Message<?>> received = new AtomicReference<>();
final CountDownLatch latch = new CountDownLatch(1);
server.registerListener(m -> {
@@ -66,7 +68,7 @@ public class ConnectionFacforyTests {
server.afterPropertiesSet();
server.start();
TestingUtilities.waitListening(server, null);
AbstractClientConnectionFactory client = Tcp.netClient("localhost", server.getPort()).get();
AbstractClientConnectionFactory client = Tcp.netClient("localhost", server.getPort()).getObject();
client.setApplicationEventPublisher(publisher);
client.afterPropertiesSet();
client.start();
@@ -78,20 +80,20 @@ public class ConnectionFacforyTests {
}
@Test
public void shouldReturnNioFlavor() throws Exception {
AbstractServerConnectionFactory server = Tcp.nioServer(0).get();
public void shouldReturnNioFlavor() {
AbstractServerConnectionFactory server = Tcp.nioServer(0).getObject();
assertThat(server instanceof TcpNioServerConnectionFactory).isTrue();
AbstractClientConnectionFactory client = Tcp.nioClient("localhost", server.getPort()).get();
AbstractClientConnectionFactory client = Tcp.nioClient("localhost", server.getPort()).getObject();
assertThat(client instanceof TcpNioClientConnectionFactory).isTrue();
}
@Test
public void shouldReturnNetFlavor() throws Exception {
AbstractServerConnectionFactory server = Tcp.netServer(0).get();
public void shouldReturnNetFlavor() {
AbstractServerConnectionFactory server = Tcp.netServer(0).getObject();
assertThat(server instanceof TcpNetServerConnectionFactory).isTrue();
AbstractClientConnectionFactory client = Tcp.netClient("localhost", server.getPort()).get();
AbstractClientConnectionFactory client = Tcp.netClient("localhost", server.getPort()).getObject();
assertThat(client instanceof TcpNetClientConnectionFactory).isTrue();
}
@@ -104,7 +106,7 @@ public class ConnectionFacforyTests {
.socketSupport(sockSupp)
.connectionSupport(conSupp)
.socketFactorySupport(factSupp)
.get();
.getObject();
assertThat(TestUtils.getPropertyValue(server, "tcpSocketSupport")).isSameAs(sockSupp);
assertThat(TestUtils.getPropertyValue(server, "tcpNetConnectionSupport")).isSameAs(conSupp);
assertThat(TestUtils.getPropertyValue(server, "tcpSocketFactorySupport")).isSameAs(factSupp);
@@ -118,7 +120,7 @@ public class ConnectionFacforyTests {
.socketSupport(sockSupp)
.directBuffers(true)
.connectionSupport(conSupp)
.get();
.getObject();
assertThat(TestUtils.getPropertyValue(server, "tcpSocketSupport")).isSameAs(sockSupp);
assertThat(TestUtils.getPropertyValue(server, "usingDirectBuffers", Boolean.class)).isTrue();
assertThat(TestUtils.getPropertyValue(server, "tcpNioConnectionSupport")).isSameAs(conSupp);
@@ -133,7 +135,7 @@ public class ConnectionFacforyTests {
.socketSupport(sockSupp)
.connectionSupport(conSupp)
.socketFactorySupport(factSupp)
.get();
.getObject();
assertThat(TestUtils.getPropertyValue(client, "tcpSocketSupport")).isSameAs(sockSupp);
assertThat(TestUtils.getPropertyValue(client, "tcpNetConnectionSupport")).isSameAs(conSupp);
assertThat(TestUtils.getPropertyValue(client, "tcpSocketFactorySupport")).isSameAs(factSupp);
@@ -147,7 +149,7 @@ public class ConnectionFacforyTests {
.socketSupport(sockSupp)
.directBuffers(true)
.connectionSupport(conSupp)
.get();
.getObject();
assertThat(TestUtils.getPropertyValue(client, "tcpSocketSupport")).isSameAs(sockSupp);
assertThat(TestUtils.getPropertyValue(client, "usingDirectBuffers", Boolean.class)).isTrue();
assertThat(TestUtils.getPropertyValue(client, "tcpNioConnectionSupport")).isSameAs(conSupp);

60
spring-integration-ip/src/test/java/org/springframework/integration/ip/dsl/IpIntegrationTests.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2016-2022 the original author or authors.
* Copyright 2016-2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -48,6 +48,8 @@ import org.springframework.integration.ip.tcp.TcpSendingMessageHandler;
import org.springframework.integration.ip.tcp.connection.AbstractClientConnectionFactory;
import org.springframework.integration.ip.tcp.connection.AbstractServerConnectionFactory;
import org.springframework.integration.ip.tcp.connection.TcpConnectionServerListeningEvent;
import org.springframework.integration.ip.tcp.connection.TcpNetClientConnectionFactory;
import org.springframework.integration.ip.tcp.connection.TcpNetServerConnectionFactory;
import org.springframework.integration.ip.tcp.serializer.ByteArrayRawSerializer;
import org.springframework.integration.ip.tcp.serializer.TcpCodecs;
import org.springframework.integration.ip.udp.MulticastSendingMessageHandler;
@@ -126,21 +128,21 @@ public class IpIntegrationTests {
void testTcpAdapters() {
ApplicationEventPublisher publisher = e -> {
};
AbstractServerConnectionFactory server = Tcp.netServer(0).backlog(2).soTimeout(5000).id("server").get();
AbstractServerConnectionFactory server = Tcp.netServer(0).backlog(2).soTimeout(5000).id("server").getObject();
assertThat(server.getComponentName()).isEqualTo("server");
server.setApplicationEventPublisher(publisher);
server.afterPropertiesSet();
TcpReceivingChannelAdapter inbound = Tcp.inboundAdapter(server).get();
TcpReceivingChannelAdapter inbound = Tcp.inboundAdapter(server).getObject();
QueueChannel received = new QueueChannel();
inbound.setOutputChannel(received);
inbound.afterPropertiesSet();
inbound.start();
TestingUtilities.waitListening(server, null);
AbstractClientConnectionFactory client = Tcp.netClient("localhost", server.getPort()).id("client").get();
AbstractClientConnectionFactory client = Tcp.netClient("localhost", server.getPort()).id("client").getObject();
assertThat(client.getComponentName()).isEqualTo("client");
client.setApplicationEventPublisher(publisher);
client.afterPropertiesSet();
TcpSendingMessageHandler handler = Tcp.outboundAdapter(client).get();
TcpSendingMessageHandler handler = Tcp.outboundAdapter(client).getObject();
handler.start();
handler.handleMessage(new GenericMessage<>("foo"));
Message<?> receivedMessage = received.receive(10000);
@@ -193,7 +195,8 @@ public class IpIntegrationTests {
UdpMulticastOutboundChannelAdapterSpec udpMulticastOutboundChannelAdapterSpec2 =
udpMulticastOutboundChannelAdapterSpec1.timeToLive(10);
assertThat(udpMulticastOutboundChannelAdapterSpec2.get()).isInstanceOf(MulticastSendingMessageHandler.class);
assertThat(udpMulticastOutboundChannelAdapterSpec2.getObject())
.isInstanceOf(MulticastSendingMessageHandler.class);
}
@Test
@@ -249,17 +252,16 @@ public class IpIntegrationTests {
private volatile String connectionId;
@Bean
public AbstractServerConnectionFactory server1() {
public TcpNetServerConnectionFactorySpec server1() {
return Tcp.netServer(0)
.serializer(TcpCodecs.lengthHeader1())
.deserializer(TcpCodecs.crlf())
.get();
.deserializer(TcpCodecs.crlf());
}
@Bean
public IntegrationFlow inTcpGateway() {
public IntegrationFlow inTcpGateway(TcpNetServerConnectionFactory server1) {
return IntegrationFlow.from(
Tcp.inboundGateway(server1())
Tcp.inboundGateway(server1)
.replyTimeout(1)
.errorOnTimeout(true)
.errorChannel("inTcpGatewayErrorFlow.input"))
@@ -276,8 +278,8 @@ public class IpIntegrationTests {
}
@Bean
public IntegrationFlow unsolicitedServerSide() {
return f -> f.handle(Tcp.outboundAdapter(server1()));
public IntegrationFlow unsolicitedServerSide(TcpNetServerConnectionFactory server1) {
return f -> f.handle(Tcp.outboundAdapter(server1));
}
@Bean
@@ -321,19 +323,17 @@ public class IpIntegrationTests {
}
@Bean
public AbstractClientConnectionFactory client1() {
return Tcp.netClient("localhost", server1().getPort())
public TcpNetClientConnectionFactorySpec client1(TcpNetServerConnectionFactory server1) {
return Tcp.netClient("localhost", server1.getPort())
.serializer(TcpCodecs.crlf())
.deserializer(TcpCodecs.lengthHeader1())
.get();
.deserializer(TcpCodecs.lengthHeader1());
}
@Bean
public TcpOutboundGateway tcpOut() {
return Tcp.outboundGateway(client1())
public TcpOutboundGatewaySpec tcpOut(TcpNetClientConnectionFactory client1) {
return Tcp.outboundGateway(client1)
.remoteTimeout(m -> 5000)
.unsolictedMessageChannelName("unsolicited")
.get();
.unsolicitedMessageChannelName("unsolicited");
}
@Bean
@@ -342,19 +342,17 @@ public class IpIntegrationTests {
}
@Bean
public AbstractClientConnectionFactory client2() {
return Tcp.netClient("localhost", server1().getPort())
public TcpNetClientConnectionFactorySpec client2(TcpNetServerConnectionFactory server1) {
return Tcp.netClient("localhost", server1.getPort())
.serializer(TcpCodecs.crlf())
.deserializer(TcpCodecs.lengthHeader1())
.get();
.deserializer(TcpCodecs.lengthHeader1());
}
@Bean
public TcpOutboundGateway tcpOutAsync() {
return Tcp.outboundGateway(client2())
public TcpOutboundGatewaySpec tcpOutAsync(TcpNetClientConnectionFactory client2) {
return Tcp.outboundGateway(client2)
.async(true)
.remoteTimeout(m -> 5000)
.get();
.remoteTimeout(m -> 5000);
}
@Bean
@@ -371,9 +369,9 @@ public class IpIntegrationTests {
}
@Bean
public IntegrationFlow clientTcpFlow() {
public IntegrationFlow clientTcpFlow(TcpOutboundGateway tcpOut) {
return f -> f
.handle(tcpOut(), e -> e.advice(testAdvice()))
.handle(tcpOut, e -> e.advice(testAdvice()))
.transform(Transformers.objectToString());
}