This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/master by this push:
new 0a1a0d0 CAMEL-15245: Add note in javadoc about shutdown strategy is
not for end users.
0a1a0d0 is described below
commit 0a1a0d084628b6b2a74de7f67c98666fd6cbea53
Author: Claus Ibsen <[email protected]>
AuthorDate: Fri Jul 3 14:56:28 2020 +0200
CAMEL-15245: Add note in javadoc about shutdown strategy is not for end
users.
---
core/camel-api/src/main/java/org/apache/camel/CamelContext.java | 5 ++++-
.../src/main/java/org/apache/camel/spi/ShutdownStrategy.java | 6 +++++-
2 files changed, 9 insertions(+), 2 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 334c530..e0bf982 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
@@ -1014,7 +1014,10 @@ public interface CamelContext extends
CamelContextLifecycle, RuntimeConfiguratio
void setApplicationContextClassLoader(ClassLoader classLoader);
/**
- * Gets the current shutdown strategy
+ * Gets the current shutdown strategy.
+ * <p/>
+ * The shutdown strategy is <b>not</b> intended for Camel end users to use
for stopping routes.
+ * Instead use {@link RouteController} via {@link CamelContext}.
*
* @return the strategy
*/
diff --git
a/core/camel-api/src/main/java/org/apache/camel/spi/ShutdownStrategy.java
b/core/camel-api/src/main/java/org/apache/camel/spi/ShutdownStrategy.java
index d871154..1b41716 100644
--- a/core/camel-api/src/main/java/org/apache/camel/spi/ShutdownStrategy.java
+++ b/core/camel-api/src/main/java/org/apache/camel/spi/ShutdownStrategy.java
@@ -24,11 +24,14 @@ import org.apache.camel.Service;
import org.apache.camel.StaticService;
/**
- * Pluggable shutdown strategy executed during shutdown of routes.
+ * Pluggable shutdown strategy executed during shutdown of Camel and the
active routes.
* <p/>
* Shutting down routes in a reliable and graceful manner is not a trivial
task. Therefore Camel provides a pluggable
* strategy allowing 3rd party to use their own strategy if needed.
* <p/>
+ * The shutdown strategy is <b>not</b> intended for Camel end users to use for
stopping routes.
+ * Instead use {@link RouteController} via {@link CamelContext}.
+ * <p/>
* The key problem is to stop the input consumers for the routes such that no
new messages is coming into Camel.
* But at the same time still keep the routes running so the existing in
flight exchanges can still be run to
* completion. On top of that there are some in memory components (such as
SEDA) which may have pending messages
@@ -36,6 +39,7 @@ import org.apache.camel.StaticService;
* <p/>
* Camel provides a default strategy which supports all that that can be used
as inspiration for your own strategy.
* @see org.apache.camel.spi.ShutdownAware
+ * @see RouteController
*/
public interface ShutdownStrategy extends StaticService {
