[camel] 08/15: CAMEL-12954 - Added endpoint doc

[ac...@apache.org]

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

acosentino pushed a commit to branch sandbox/camel-3.x
in repository https://gitbox.apache.org/repos/asf/camel.git

commit 9fa7fa5db8d79094b1f025c0864f7621b0e964c0
Author: Andrea Cosentino <an...@gmail.com>
AuthorDate: Thu Dec 13 08:35:20 2018 +0100

    CAMEL-12954 - Added endpoint doc
---
 .../src/main/docs/websocket-jsr356-component.adoc  | 39 +++++++++++++++++++---
 1 file changed, 35 insertions(+), 4 deletions(-)

diff --git a/components/camel-websocket-jsr356/src/main/docs/websocket-jsr356-component.adoc b/components/camel-websocket-jsr356/src/main/docs/websocket-jsr356-component.adoc
index 796f0f2..b30f1a9 100644
--- a/components/camel-websocket-jsr356/src/main/docs/websocket-jsr356-component.adoc
+++ b/components/camel-websocket-jsr356/src/main/docs/websocket-jsr356-component.adoc
@@ -1,9 +1,6 @@
-[[websocket-jsr356-component]]
 == Javax Websocket Component
-== Websocket JSR356 Component
 *Available as of Camel version 2.23*
 
-
 *Available as of Camel version 2.23*
 
 The *jsr356* component provides websocket
@@ -35,4 +32,38 @@ You can append query options to the URI in the following format,
 
 // component options: START
 The Javax Websocket component has no options.
-// component options: END
\ No newline at end of file
+// component options: END
+
+// endpoint options: START
+The Javax Websocket endpoint is configured using URI syntax:
+
+----
+websocket-jsr356:/resourceUri
+----
+
+with the following path and query parameters:
+
+==== Path Parameters (1 parameters):
+
+
+[width="100%",cols="2,5,^1,2",options="header"]
+|===
+| Name | Description | Default | Type
+| *websocketPathOrUri* | If a path (/foo) it will deploy locally the endpoint, if an uri it will connect to the corresponding server |  | String
+|===
+
+
+==== Query Parameters (6 parameters):
+
+
+[width="100%",cols="2,5,^1,2",options="header"]
+|===
+| Name | Description | Default | Type
+| *context* (common) | the servlet context to use (represented by its path) |  | String
+| *sessionCount* (common) | Used when the endpoint is in client mode to populate a pool of sessions |  | int
+| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | false | boolean
+| *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. |  | ExceptionHandler
+| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. |  | ExchangePattern
+| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+|===
+// endpoint options: END