[camel] branch main updated: Update javadoc about danger of doing custom UoW factory

[da...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git


The following commit(s) were added to refs/heads/main by this push:
     new a4310e95254 Update javadoc about danger of doing custom UoW factory
a4310e95254 is described below

commit a4310e9525477267c2dd8e24b029462c86a40b97
Author: Claus Ibsen <cl...@gmail.com>
AuthorDate: Wed Aug 9 14:55:39 2023 +0200

    Update javadoc about danger of doing custom UoW factory
---
 .../src/main/java/org/apache/camel/spi/UnitOfWorkFactory.java        | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/core/camel-api/src/main/java/org/apache/camel/spi/UnitOfWorkFactory.java b/core/camel-api/src/main/java/org/apache/camel/spi/UnitOfWorkFactory.java
index 12f116aabf7..51d2651a204 100644
--- a/core/camel-api/src/main/java/org/apache/camel/spi/UnitOfWorkFactory.java
+++ b/core/camel-api/src/main/java/org/apache/camel/spi/UnitOfWorkFactory.java
@@ -22,6 +22,11 @@ import org.apache.camel.Exchange;
 
 /**
  * Factory to create {@link org.apache.camel.spi.UnitOfWork}.
+ *
+ * <b>IMPORTANT:</b> Implementing a custom {@link UnitOfWorkFactory} is only intended for very rare and special
+ * use-cases. The created {@link UnitOfWork} is highly recommended to extend
+ * org.apache.camel.impl.engine.DefaultUnitOfWork to ensure Camel functionality works correctly during routing of
+ * {@link Exchange}s.
  */
 public interface UnitOfWorkFactory extends AfterPropertiesConfigured {