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 2015/03/01 08:42:38 UTC

[11/11] camel git commit: CAMEL-8320: Component doc to include endpoint syntax.

CAMEL-8320: Component doc to include endpoint syntax.


Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/6560d5bb
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/6560d5bb
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/6560d5bb

Branch: refs/heads/master
Commit: 6560d5bbf2664a7cd6777651b03eb3abcd0925f3
Parents: 00e7095
Author: Claus Ibsen <da...@apache.org>
Authored: Sun Mar 1 08:43:30 2015 +0100
Committer: Claus Ibsen <da...@apache.org>
Committed: Sun Mar 1 08:43:30 2015 +0100

----------------------------------------------------------------------
 .../main/java/org/apache/camel/spi/UriEndpoint.java | 16 ++++++++++++----
 1 file changed, 12 insertions(+), 4 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/6560d5bb/tooling/spi-annotations/src/main/java/org/apache/camel/spi/UriEndpoint.java
----------------------------------------------------------------------
diff --git a/tooling/spi-annotations/src/main/java/org/apache/camel/spi/UriEndpoint.java b/tooling/spi-annotations/src/main/java/org/apache/camel/spi/UriEndpoint.java
index e3b3bb2..f03f3ee 100644
--- a/tooling/spi-annotations/src/main/java/org/apache/camel/spi/UriEndpoint.java
+++ b/tooling/spi-annotations/src/main/java/org/apache/camel/spi/UriEndpoint.java
@@ -45,12 +45,20 @@ public @interface UriEndpoint {
      * <p/>
      * The syntax follows the patterns such as:
      * <ul>
-     *     <li>scheme:path[?options]</li>
-     *     <li>scheme:path:path[?options]</li>
-     *     <li>scheme:path:path/path[?options]</li>
-     *     <li>scheme:path:path/path/path[?options]</li>
+     *     <li>scheme:host:port</li>
+     *     <li>scheme:host:port/path</li>
+     *     <li>scheme:path</li>
+     *     <li>scheme:path/path2</li>
      * </ul>
      * Where each path maps to the name of the endpoint {@link org.apache.camel.spi.UriPath} option.
+     * The query parameters is implied and should not be included in the syntax.
+     * <p/>
+     * Some examples:
+     * <ul>
+     *     <li>file:directoryName</li>
+     *     <li>ftp:host:port/directoryName</li>
+     *     <li>jms:destinationType:destinationName</li>
+     * </ul>
      */
     String syntax();