[camel] 02/04: CAMEL-15105: documented CamelContext API changes on the API documentation and migration guide

[or...@apache.org]

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

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

commit 5a3f67164dc00345d4512d26da093d09a55ad74a
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Mon Feb 27 10:59:02 2023 +0100

    CAMEL-15105: documented CamelContext API changes on the API documentation and migration guide
---
 core/camel-api/src/main/java/org/apache/camel/CamelContext.java  | 9 +++++----
 docs/user-manual/modules/ROOT/pages/camel-4-migration-guide.adoc | 3 +++
 2 files changed, 8 insertions(+), 4 deletions(-)

diff --git a/core/camel-api/src/main/java/org/apache/camel/CamelContext.java b/core/camel-api/src/main/java/org/apache/camel/CamelContext.java
index f5757855757..0205cfd4026 100644
--- a/core/camel-api/src/main/java/org/apache/camel/CamelContext.java
+++ b/core/camel-api/src/main/java/org/apache/camel/CamelContext.java
@@ -77,15 +77,16 @@ import org.apache.camel.vault.VaultConfiguration;
  * End users are advised to use suspend/resume. Using stop is for shutting down Camel and it's not guaranteed that when
  * it's being started again using the start method that Camel will operate consistently.
  * <p/>
- * For more advanced APIs with {@link CamelContext} see {@link ExtendedCamelContext}, which you can obtain via the adapt
- * method.
+ * You can use the {@link CamelContext#getCamelContextExtension()} to obtain the extension point for the {@link CamelContext}.
+ * This extension point exposes internal APIs via {@link ExtendedCamelContext}.
  */
 public interface CamelContext extends CamelContextLifecycle, RuntimeConfiguration {
 
     /**
-     * Gets the {@link ExtendedCamelContext} that contains the extension points for internal context APIs.
+     * Gets the {@link ExtendedCamelContext} that contains the extension points for internal context APIs. These APIs
+     * are intended for internal usage within Camel and end-users should avoid using them.
      *
-     * @return this {@link ExtendedCamelContext}
+     * @return this {@link ExtendedCamelContext} extension point for this context.
      */
     ExtendedCamelContext getCamelContextExtension();
 
diff --git a/docs/user-manual/modules/ROOT/pages/camel-4-migration-guide.adoc b/docs/user-manual/modules/ROOT/pages/camel-4-migration-guide.adoc
index a8933c541fe..a958989dd31 100644
--- a/docs/user-manual/modules/ROOT/pages/camel-4-migration-guide.adoc
+++ b/docs/user-manual/modules/ROOT/pages/camel-4-migration-guide.adoc
@@ -72,6 +72,9 @@ We have removed deprecated APIs such as the following:
 - Removed all `asyncCallback` methods on `ProducerTemplate`. Use `asyncSend` or `asyncRequest` instead.
 - Removed `org.apache.camel.spi.OnCamelContextStart`. Use `org.apache.camel.spi.OnCamelContextStarting` instead.
 - Removed `org.apache.camel.spi.OnCamelContextStop`. Use `org.apache.camel.spi.OnCamelContextStopping` instead.
+- Decoupled the `org.apache.camel.ExtendedCamelContext` from the `org.apache.camel.CamelContext`.
+-- Replaced `adapt()` from `org.apache.camel.CamelContext` with `getCamelContextExtension`
+
 
 == EIP Changes