Skip to content

Commit

Permalink
spring-projectsGH-3661: Fix Javadocs for RetryingMLA
Browse files Browse the repository at this point in the history
Use of the `RetryingMessageListenerAdapter` was removed in
spring-projects@0550380
but the javadocs were not corrected.
  • Loading branch information
garyrussell authored and artembilan committed Sep 21, 2022
1 parent d825ade commit cbfa150
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 30 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,7 @@ public S messageConverter(RecordMessageConverter messageConverter) {
}

/**
* Specify a {@link RetryTemplate} instance to wrap
* {@code KafkaInboundGateway.IntegrationRecordMessageListener} into
* {@link org.springframework.kafka.listener.adapter.RetryingMessageListenerAdapter}.
* Specify a {@link RetryTemplate} instance to use for retrying deliveries.
* @param retryTemplate the {@link RetryTemplate} to use.
* @return the spec
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -118,9 +118,7 @@ public S ackDiscarded(boolean ackDiscarded) {
}

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

/**
* The {@code boolean} flag to specify the order how
* {@link org.springframework.kafka.listener.adapter.RetryingMessageListenerAdapter}
* and
* {@link org.springframework.kafka.listener.adapter.FilteringMessageListenerAdapter}
* are wrapped to each other, if both of them are present. Does not make sense if only
* one of {@link RetryTemplate} or {@link RecordFilterStrategy} is present, or any.
* @param filterInRetry the order for
* {@link org.springframework.kafka.listener.adapter.RetryingMessageListenerAdapter}
* and
* {@link org.springframework.kafka.listener.adapter.FilteringMessageListenerAdapter}
* wrapping. Defaults to {@code false}.
* The {@code boolean} flag to specify the order in which the filter and retry
* operations are performed.
* Does not make sense if only one of {@link RetryTemplate} or
* {@link RecordFilterStrategy} is present, or none.
* When true, the filter is called for each retry; when false, the filter is only
* called once for each delivery from the container.
* @param filterInRetry true to filter for each retry. Defaults to {@code false}.
* @return the spec
*/
public S filterInRetry(boolean filterInRetry) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -140,9 +140,7 @@ public void setPayloadType(Class<?> payloadType) {
}

/**
* Specify a {@link RetryTemplate} instance to wrap
* {@link KafkaInboundGateway.IntegrationRecordMessageListener} into
* {@code RetryingMessageListenerAdapter}.
* Specify a {@link RetryTemplate} instance to use for retrying deliveries.
* <p>
* IMPORTANT: This form of retry is blocking and could cause a rebalance if the
* aggregate retry delays across all polled records might exceed the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -199,9 +199,7 @@ public void setAckDiscarded(boolean ackDiscarded) {
}

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

/**
* The {@code boolean} flag to specify the order how
* {@code RetryingMessageListenerAdapter} and
* {@link FilteringMessageListenerAdapter} are wrapped to each other,
* if both of them are present.
* The {@code boolean} flag to specify the order in which the filter and retry
* operations are performed.
* Does not make sense if only one of {@link RetryTemplate} or
* {@link RecordFilterStrategy} is present, or any.
* {@link RecordFilterStrategy} is present, or none.
* When true, the filter is called for each retry; when false, the filter is only
* called once for each delivery from the container.
* @param filterInRetry the order for {@code RetryingMessageListenerAdapter} and
* {@link FilteringMessageListenerAdapter} wrapping. Defaults to {@code false}.
* @param filterInRetry true to filter for each retry. Defaults to {@code false}.
*/
public void setFilterInRetry(boolean filterInRetry) {
this.filterInRetry = filterInRetry;
Expand Down

0 comments on commit cbfa150

Please sign in to comment.