You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2013/08/14 13:01:05 UTC
[3/4] git commit: Improved javadoc on CamelContext about start stop
methods
Improved javadoc on CamelContext about start stop methods
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/58a636b7
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/58a636b7
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/58a636b7
Branch: refs/heads/master
Commit: 58a636b7c39e132c88e2296a5367561627310cda
Parents: 0fb7812
Author: Claus Ibsen <da...@apache.org>
Authored: Wed Aug 14 12:12:59 2013 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Wed Aug 14 12:12:59 2013 +0200
----------------------------------------------------------------------
.../java/org/apache/camel/CamelContext.java | 22 +++++++++++++++++++-
1 file changed, 21 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/58a636b7/camel-core/src/main/java/org/apache/camel/CamelContext.java
----------------------------------------------------------------------
diff --git a/camel-core/src/main/java/org/apache/camel/CamelContext.java b/camel-core/src/main/java/org/apache/camel/CamelContext.java
index 839b00d..64f4d7a 100644
--- a/camel-core/src/main/java/org/apache/camel/CamelContext.java
+++ b/camel-core/src/main/java/org/apache/camel/CamelContext.java
@@ -64,7 +64,8 @@ import org.apache.camel.util.LoadPropertiesException;
* <p/>
* The context offers the following methods to control the lifecycle:
* <ul>
- * <li>{@link #start()} - to start</li>
+ * <li>{@link #start()} - to start (<b>important:</b> the start method is not blocked, see more details
+ * <a href="http://camel.apache.org/running-camel-standalone-and-have-it-keep-running.html">here</a>)</li>
* <li>{@link #stop()} - to shutdown (will stop all routes/components/endpoints etc and clear internal state/cache)</li>
* <li>{@link #suspend()} - to pause routing messages</li>
* <li>{@link #resume()} - to resume after a suspend</li>
@@ -85,6 +86,25 @@ import org.apache.camel.util.LoadPropertiesException;
public interface CamelContext extends SuspendableService, RuntimeConfiguration {
/**
+ * Starts the {@link CamelContext} (<b>important:</b> the start method is not blocked, see more details
+ * <a href="http://camel.apache.org/running-camel-standalone-and-have-it-keep-running.html">here</a>)</li>.
+ * <p/>
+ * See more details at the class-level javadoc of this class.
+ *
+ * @throws Exception is thrown if starting failed
+ */
+ void start() throws Exception;
+
+ /**
+ * Stop and shutdown the {@link CamelContext} (will stop all routes/components/endpoints etc and clear internal state/cache).
+ * <p/>
+ * See more details at the class-level javadoc of this class.
+ *
+ * @throws Exception is thrown if stopping failed
+ */
+ void stop() throws Exception;
+
+ /**
* Gets the name (id) of the this context.
*
* @return the name