GH-249 Added Javadoc for KplBackpressureException in the KplMessageHa…

…ndler class level.
spring-projects · Dec 29, 2024 · 3c442c7 · 3c442c7
1 parent 186314e
commit 3c442c7
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/src/main/java/org/springframework/integration/aws/outbound/KplMessageHandler.java b/src/main/java/org/springframework/integration/aws/outbound/KplMessageHandler.java
@@ -65,9 +65,9 @@
 
 /**
  * The {@link AbstractMessageHandler} implementation for the Amazon Kinesis Producer
- * Library {@code putRecord(s)}.
- *
- * @exception KplBackpressureException When backpressure handling is enabled and buffer is at max capacity.
+ * Library {@code putRecord(s)}. {@link KplBackpressureException} is thrown When backpressure handling is enabled and
+ * buffer is at max capacity. The exceptions can be used with
+ * {@link org.springframework.integration.handler.advice.AbstractRequestHandlerAdvice}.
  *
  * @author Arnaud Lecollaire
  * @author Artem Bilan
@@ -78,6 +78,7 @@
  * @see KinesisAsyncClient#putRecord(PutRecordRequest)
  * @see KinesisAsyncClient#putRecords(PutRecordsRequest)
  * @see com.amazonaws.handlers.AsyncHandler
+ * @see org.springframework.integration.handler.advice.AbstractRequestHandlerAdvice
  */
 public class KplMessageHandler extends AbstractAwsMessageHandler<Void> implements Lifecycle {