Skip to content

Commit cbfa150

Browse files
garyrussellartembilan
authored andcommitted
GH-3661: Fix Javadocs for RetryingMLA
Use of the `RetryingMessageListenerAdapter` was removed in 0550380 but the javadocs were not corrected.
1 parent d825ade commit cbfa150

File tree

4 files changed

+15
-30
lines changed

4 files changed

+15
-30
lines changed

Diff for: spring-integration-kafka/src/main/java/org/springframework/integration/kafka/dsl/KafkaInboundGatewaySpec.java

+1-3
Original file line numberDiff line numberDiff line change
@@ -72,9 +72,7 @@ public S messageConverter(RecordMessageConverter messageConverter) {
7272
}
7373

7474
/**
75-
* Specify a {@link RetryTemplate} instance to wrap
76-
* {@code KafkaInboundGateway.IntegrationRecordMessageListener} into
77-
* {@link org.springframework.kafka.listener.adapter.RetryingMessageListenerAdapter}.
75+
* Specify a {@link RetryTemplate} instance to use for retrying deliveries.
7876
* @param retryTemplate the {@link RetryTemplate} to use.
7977
* @return the spec
8078
*/

Diff for: spring-integration-kafka/src/main/java/org/springframework/integration/kafka/dsl/KafkaMessageDrivenChannelAdapterSpec.java

+8-14
Original file line numberDiff line numberDiff line change
@@ -118,9 +118,7 @@ public S ackDiscarded(boolean ackDiscarded) {
118118
}
119119

120120
/**
121-
* Specify a {@link RetryTemplate} instance to wrap
122-
* {@code KafkaMessageDrivenChannelAdapter.IntegrationRecordMessageListener} into
123-
* {@link org.springframework.kafka.listener.adapter.RetryingMessageListenerAdapter}.
121+
* Specify a {@link RetryTemplate} instance to use for retrying deliveries.
124122
* @param retryTemplate the {@link RetryTemplate} to use.
125123
* @return the spec
126124
*/
@@ -153,17 +151,13 @@ public S payloadType(Class<?> payloadType) {
153151
}
154152

155153
/**
156-
* The {@code boolean} flag to specify the order how
157-
* {@link org.springframework.kafka.listener.adapter.RetryingMessageListenerAdapter}
158-
* and
159-
* {@link org.springframework.kafka.listener.adapter.FilteringMessageListenerAdapter}
160-
* are wrapped to each other, if both of them are present. Does not make sense if only
161-
* one of {@link RetryTemplate} or {@link RecordFilterStrategy} is present, or any.
162-
* @param filterInRetry the order for
163-
* {@link org.springframework.kafka.listener.adapter.RetryingMessageListenerAdapter}
164-
* and
165-
* {@link org.springframework.kafka.listener.adapter.FilteringMessageListenerAdapter}
166-
* wrapping. Defaults to {@code false}.
154+
* The {@code boolean} flag to specify the order in which the filter and retry
155+
* operations are performed.
156+
* Does not make sense if only one of {@link RetryTemplate} or
157+
* {@link RecordFilterStrategy} is present, or none.
158+
* When true, the filter is called for each retry; when false, the filter is only
159+
* called once for each delivery from the container.
160+
* @param filterInRetry true to filter for each retry. Defaults to {@code false}.
167161
* @return the spec
168162
*/
169163
public S filterInRetry(boolean filterInRetry) {

Diff for: spring-integration-kafka/src/main/java/org/springframework/integration/kafka/inbound/KafkaInboundGateway.java

+1-3
Original file line numberDiff line numberDiff line change
@@ -140,9 +140,7 @@ public void setPayloadType(Class<?> payloadType) {
140140
}
141141

142142
/**
143-
* Specify a {@link RetryTemplate} instance to wrap
144-
* {@link KafkaInboundGateway.IntegrationRecordMessageListener} into
145-
* {@code RetryingMessageListenerAdapter}.
143+
* Specify a {@link RetryTemplate} instance to use for retrying deliveries.
146144
* <p>
147145
* IMPORTANT: This form of retry is blocking and could cause a rebalance if the
148146
* aggregate retry delays across all polled records might exceed the

Diff for: spring-integration-kafka/src/main/java/org/springframework/integration/kafka/inbound/KafkaMessageDrivenChannelAdapter.java

+5-10
Original file line numberDiff line numberDiff line change
@@ -199,9 +199,7 @@ public void setAckDiscarded(boolean ackDiscarded) {
199199
}
200200

201201
/**
202-
* Specify a {@link RetryTemplate} instance to wrap
203-
* {@link KafkaMessageDrivenChannelAdapter.IntegrationRecordMessageListener} into
204-
* {@code RetryingMessageListenerAdapter}.
202+
* Specify a {@link RetryTemplate} instance to use for retrying deliveries.
205203
* <p>
206204
* IMPORTANT: This form of retry is blocking and could cause a rebalance if the
207205
* aggregate retry delays across all polled records might exceed the
@@ -231,16 +229,13 @@ public void setRecoveryCallback(RecoveryCallback<?> recoveryCallback) {
231229
}
232230

233231
/**
234-
* The {@code boolean} flag to specify the order how
235-
* {@code RetryingMessageListenerAdapter} and
236-
* {@link FilteringMessageListenerAdapter} are wrapped to each other,
237-
* if both of them are present.
232+
* The {@code boolean} flag to specify the order in which the filter and retry
233+
* operations are performed.
238234
* Does not make sense if only one of {@link RetryTemplate} or
239-
* {@link RecordFilterStrategy} is present, or any.
235+
* {@link RecordFilterStrategy} is present, or none.
240236
* When true, the filter is called for each retry; when false, the filter is only
241237
* called once for each delivery from the container.
242-
* @param filterInRetry the order for {@code RetryingMessageListenerAdapter} and
243-
* {@link FilteringMessageListenerAdapter} wrapping. Defaults to {@code false}.
238+
* @param filterInRetry true to filter for each retry. Defaults to {@code false}.
244239
*/
245240
public void setFilterInRetry(boolean filterInRetry) {
246241
this.filterInRetry = filterInRetry;

0 commit comments

Comments
 (0)