diff --git a/spring-integration-core/src/main/java/org/springframework/integration/dsl/BaseIntegrationFlowDefinition.java b/spring-integration-core/src/main/java/org/springframework/integration/dsl/BaseIntegrationFlowDefinition.java index e2a2c8a314..7fdd4d1925 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/dsl/BaseIntegrationFlowDefinition.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/dsl/BaseIntegrationFlowDefinition.java @@ -2182,9 +2182,6 @@ public abstract class BaseIntegrationFlowDefinition The full request {@link Message} will be logged. - *

When this operator is used in the end of flow, it is treated - * as one-way handler without any replies to continue. - * The {@link #logAndReply()} should be used for request-reply configuration. * @return the current {@link BaseIntegrationFlowDefinition}. * @see #wireTap(WireTapSpec) */ @@ -2198,9 +2195,6 @@ public abstract class BaseIntegrationFlowDefinition The full request {@link Message} will be logged. - *

When this operator is used in the end of flow, it is treated - * as one-way handler without any replies to continue. - * The {@link #logAndReply()} should be used for request-reply configuration. * @param level the {@link LoggingHandler.Level}. * @return the current {@link BaseIntegrationFlowDefinition}. * @see #wireTap(WireTapSpec) @@ -2214,9 +2208,6 @@ public abstract class BaseIntegrationFlowDefinition The full request {@link Message} will be logged. - *

When this operator is used in the end of flow, it is treated - * as one-way handler without any replies to continue. - * The {@link #logAndReply()} should be used for request-reply configuration. * @param category the logging category to use. * @return the current {@link BaseIntegrationFlowDefinition}. * @see #wireTap(WireTapSpec) @@ -2230,9 +2221,6 @@ public abstract class BaseIntegrationFlowDefinition The full request {@link Message} will be logged. - *

When this operator is used in the end of flow, it is treated - * as one-way handler without any replies to continue. - * The {@link #logAndReply()} should be used for request-reply configuration. * @param level the {@link LoggingHandler.Level}. * @param category the logging category to use. * @return the current {@link BaseIntegrationFlowDefinition}. @@ -2247,9 +2235,6 @@ public abstract class BaseIntegrationFlowDefinition When this operator is used in the end of flow, it is treated - * as one-way handler without any replies to continue. - * The {@link #logAndReply()} should be used for request-reply configuration. * @param level the {@link LoggingHandler.Level}. * @param category the logging category. * @param logExpression the SpEL expression to evaluate logger message at runtime @@ -2267,9 +2252,6 @@ public abstract class BaseIntegrationFlowDefinition When this operator is used in the end of flow, it is treated - * as one-way handler without any replies to continue. - * The {@link #logAndReply()} should be used for request-reply configuration. * @param function the function to evaluate logger message at runtime * @param

the expected payload type. * against the request {@link Message}. @@ -2287,9 +2269,6 @@ public abstract class BaseIntegrationFlowDefinition When this operator is used in the end of flow, it is treated - * as one-way handler without any replies to continue. - * The {@link #logAndReply()} should be used for request-reply configuration. * @param logExpression the {@link Expression} to evaluate logger message at runtime * against the request {@link Message}. * @return the current {@link BaseIntegrationFlowDefinition}. @@ -2306,9 +2285,6 @@ public abstract class BaseIntegrationFlowDefinition When this operator is used in the end of flow, it is treated - * as one-way handler without any replies to continue. - * The {@link #logAndReply()} should be used for request-reply configuration. * @param level the {@link LoggingHandler.Level}. * @param logExpression the {@link Expression} to evaluate logger message at runtime * against the request {@link Message}. @@ -2325,9 +2301,6 @@ public abstract class BaseIntegrationFlowDefinition When this operator is used in the end of flow, it is treated - * as one-way handler without any replies to continue. - * The {@link #logAndReply()} should be used for request-reply configuration. * @param category the logging category. * @param logExpression the {@link Expression} to evaluate logger message at runtime * against the request {@link Message}. @@ -2344,9 +2317,6 @@ public abstract class BaseIntegrationFlowDefinition When this operator is used in the end of flow, it is treated - * as one-way handler without any replies to continue. - * The {@link #logAndReply()} should be used for request-reply configuration. * @param level the {@link LoggingHandler.Level}. * @param function the function to evaluate logger message at runtime * @param

the expected payload type. @@ -2363,9 +2333,6 @@ public abstract class BaseIntegrationFlowDefinition When this operator is used in the end of flow, it is treated - * as one-way handler without any replies to continue. - * The {@link #logAndReply()} should be used for request-reply configuration. * @param category the logging category. * @param function the function to evaluate logger message at runtime * @param

the expected payload type. @@ -2382,9 +2349,6 @@ public abstract class BaseIntegrationFlowDefinition When this operator is used in the end of flow, it is treated - * as one-way handler without any replies to continue. - * The {@link #logAndReply()} should be used for request-reply configuration. * @param level the {@link LoggingHandler.Level}. * @param category the logging category. * @param function the function to evaluate logger message at runtime @@ -2403,9 +2367,6 @@ public abstract class BaseIntegrationFlowDefinition When this operator is used in the end of flow, it is treated - * as one-way handler without any replies to continue. - * The {@link #logAndReply()} should be used for request-reply configuration. * @param level the {@link LoggingHandler.Level}. * @param category the logging category. * @param logExpression the {@link Expression} to evaluate logger message at runtime @@ -2441,9 +2402,11 @@ public abstract class BaseIntegrationFlowDefinition This operator can be used only in the end of flow. * @return an {@link IntegrationFlow} instance based on this builder. + * @deprecated since 6.0 in favor of {@link #log} in the end of flow. * @see #log() * @see #bridge() */ + @Deprecated public IntegrationFlow logAndReply() { return logAndReply(LoggingHandler.Level.INFO); } @@ -2459,9 +2422,11 @@ public abstract class BaseIntegrationFlowDefinition This operator can be used only in the end of flow. * @param level the {@link LoggingHandler.Level}. * @return an {@link IntegrationFlow} instance based on this builder. + * @deprecated since 6.0 in favor of {@link #log} in the end of flow. * @see #log() * @see #bridge() */ + @Deprecated public IntegrationFlow logAndReply(LoggingHandler.Level level) { return logAndReply(level, (String) null); } @@ -2476,9 +2441,11 @@ public abstract class BaseIntegrationFlowDefinition This operator can be used only in the end of flow. * @param category the logging category to use. * @return an {@link IntegrationFlow} instance based on this builder. + * @deprecated since 6.0 in favor of {@link #log} in the end of flow. * @see #log() * @see #bridge() */ + @Deprecated public IntegrationFlow logAndReply(String category) { return logAndReply(LoggingHandler.Level.INFO, category); } @@ -2494,9 +2461,11 @@ public abstract class BaseIntegrationFlowDefinition the expected payload type. * against the request {@link Message}. * @return an {@link IntegrationFlow} instance based on this builder. + * @deprecated since 6.0 in favor of {@link #log} in the end of flow. * @see #log() * @see #bridge() */ + @Deprecated public

IntegrationFlow logAndReply(Function, Object> function) { Assert.notNull(function, FUNCTION_MUST_NOT_BE_NULL); return logAndReply(new FunctionExpression<>(function)); @@ -2554,9 +2527,11 @@ public abstract class BaseIntegrationFlowDefinition the expected payload type. * against the request {@link Message}. * @return an {@link IntegrationFlow} instance based on this builder. + * @deprecated since 6.0 in favor of {@link #log} in the end of flow. * @see #log() * @see #bridge() */ + @Deprecated public

IntegrationFlow logAndReply(LoggingHandler.Level level, Function, Object> function) { return logAndReply(level, null, function); } @@ -2636,9 +2617,11 @@ public abstract class BaseIntegrationFlowDefinition the expected payload type. * against the request {@link Message}. * @return an {@link IntegrationFlow} instance based on this builder. + * @deprecated since 6.0 in favor of {@link #log} in the end of flow. * @see #log() * @see #bridge() */ + @Deprecated public

IntegrationFlow logAndReply(String category, Function, Object> function) { return logAndReply(LoggingHandler.Level.INFO, category, function); } @@ -2657,9 +2640,11 @@ public abstract class BaseIntegrationFlowDefinition the expected payload type. * against the request {@link Message}. * @return an {@link IntegrationFlow} instance based on this builder. + * @deprecated since 6.0 in favor of {@link #log} in the end of flow. * @see #log() * @see #bridge() */ + @Deprecated public

IntegrationFlow logAndReply(LoggingHandler.Level level, String category, Function, Object> function) { @@ -2680,9 +2665,11 @@ public abstract class BaseIntegrationFlowDefinition second); if (lastComponent.get() instanceof WireTapSpec) { - channel(IntegrationContextUtils.NULL_CHANNEL_BEAN_NAME); + bridge(); } } diff --git a/spring-integration-core/src/test/java/org/springframework/integration/dsl/extensions/IntegrationFlowExtensionTests.java b/spring-integration-core/src/test/java/org/springframework/integration/dsl/extensions/IntegrationFlowExtensionTests.java index fb136540fa..12e912c65d 100644 --- a/spring-integration-core/src/test/java/org/springframework/integration/dsl/extensions/IntegrationFlowExtensionTests.java +++ b/spring-integration-core/src/test/java/org/springframework/integration/dsl/extensions/IntegrationFlowExtensionTests.java @@ -1,5 +1,5 @@ /* - * Copyright 2020 the original author or authors. + * Copyright 2020-2022 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. @@ -82,7 +82,8 @@ public class IntegrationFlowExtensionTests { .channel("innerChannel") .customAggregate(customAggregatorSpec -> customAggregatorSpec.expireGroupsUponCompletion(true)) - .logAndReply(); + .log() + .get(); } } diff --git a/spring-integration-core/src/test/java/org/springframework/integration/dsl/flowservices/FlowServiceTests.java b/spring-integration-core/src/test/java/org/springframework/integration/dsl/flowservices/FlowServiceTests.java index 68ab2b657a..5cb727138e 100644 --- a/spring-integration-core/src/test/java/org/springframework/integration/dsl/flowservices/FlowServiceTests.java +++ b/spring-integration-core/src/test/java/org/springframework/integration/dsl/flowservices/FlowServiceTests.java @@ -1,5 +1,5 @@ /* - * Copyright 2016-2020 the original author or authors. + * Copyright 2016-2022 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. @@ -127,7 +127,7 @@ public class FlowServiceTests { @Bean public IntegrationFlow testGateway() { return f -> f.gateway("processChannel", g -> g.replyChannel("replyChannel")) - .logAndReply(); + .log(); } @Bean @@ -152,7 +152,8 @@ public class FlowServiceTests { .log(LoggingHandler.Level.ERROR, m -> { resultOverLoggingHandler.set(m.getPayload()); return m; - }); + }) + .nullChannel(); } @Override diff --git a/spring-integration-core/src/test/java/org/springframework/integration/dsl/transformers/TransformerTests.java b/spring-integration-core/src/test/java/org/springframework/integration/dsl/transformers/TransformerTests.java index 07ed05aaae..722041621b 100644 --- a/spring-integration-core/src/test/java/org/springframework/integration/dsl/transformers/TransformerTests.java +++ b/spring-integration-core/src/test/java/org/springframework/integration/dsl/transformers/TransformerTests.java @@ -1,5 +1,5 @@ /* - * Copyright 2017-2021 the original author or authors. + * Copyright 2017-2022 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. @@ -297,7 +297,8 @@ public class TransformerTests { .propertyFunction("date", m -> new Date()) .headerExpression("foo", "payload['name']") ) - .logAndReply(); + .log() + .get(); } @Bean @@ -463,7 +464,7 @@ public class TransformerTests { throw new RuntimeException("intentional"); }, e -> e.advice(expressionAdvice())) - .logAndReply(); + .log(); } } diff --git a/src/reference/asciidoc/dsl.adoc b/src/reference/asciidoc/dsl.adoc index e852e23ecf..de140496ac 100644 --- a/src/reference/asciidoc/dsl.adoc +++ b/src/reference/asciidoc/dsl.adoc @@ -656,9 +656,9 @@ The following example shows how to use `LoggingHandler`: In the preceding example, an `id` header is logged at the `ERROR` level onto `test.category` only for messages that passed the filter and before routing. -When this operator is used at the end of a flow, it is a one-way handler and the flow ends. -To make it as a reply-producing flow, you can either use a simple `bridge()` after the `log()` or, starting with version 5.1, you can use a `logAndReply()` operator instead. -`logAndReply` can only be used at the end of a flow. +Starting with version 6.0, the behavior of this operator in the end of flow is aligned with its usage in the middle. +In other words the behavior of the flow remains the same even if the `log()` operator is removed. +So, if a reply is not expected to be produced in the end of the flow, the `nullChannel()` is recommended to be used after the last `log()`. [[java-dsl-intercept]] === Operator intercept()