Repository: camel Updated Branches: refs/heads/master 01a0daa46 -> c776464da
http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-spring-redis/src/main/docs/spring-redis-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-spring-redis/src/main/docs/spring-redis-component.adoc b/components/camel-spring-redis/src/main/docs/spring-redis-component.adoc index 7f972d5..94d60b9 100644 --- a/components/camel-spring-redis/src/main/docs/spring-redis-component.adoc +++ b/components/camel-spring-redis/src/main/docs/spring-redis-component.adoc @@ -35,14 +35,27 @@ The Spring Redis component has no options. // endpoint options: START -The Spring Redis component supports 12 endpoint options which are listed below: +The Spring Redis component is configured using the URI syntax with the following path and query parameters: + + spring-redis:host:port + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| host | | String | *Required* The host where Redis server is running. +| port | | Integer | *Required* Redis server port number +|======================================================================= +{% endraw %} + +#### 10 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| host | common | | String | *Required* The host where Redis server is running. -| port | common | | Integer | *Required* Redis server port number | channels | common | | String | List of topic names or name patterns to subscribe to. Multiple names can be separated by comma. | command | common | SET | Command | Default command which can be overridden by message header. Notice the consumer only supports the following commands: PSUBSCRIBE and SUBSCRIBE | connectionFactory | common | | RedisConnectionFactory | Reference to a pre-configured RedisConnectionFactory instance to use. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-spring-ws/src/main/docs/spring-ws-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-spring-ws/src/main/docs/spring-ws-component.adoc b/components/camel-spring-ws/src/main/docs/spring-ws-component.adoc index a118533..2404786 100644 --- a/components/camel-spring-ws/src/main/docs/spring-ws-component.adoc +++ b/components/camel-spring-ws/src/main/docs/spring-ws-component.adoc @@ -87,15 +87,28 @@ The Spring WebService component has no options. // endpoint options: START -The Spring WebService component supports 25 endpoint options which are listed below: +The Spring WebService component is configured using the URI syntax with the following path and query parameters: + + spring-ws:type:lookupKey:webServiceEndpointUri + +#### 3 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| type | | EndpointMappingType | Endpoint mapping type if endpoint mapping is used. rootqname - Offers the option to map web service requests based on the qualified name of the root element contained in the message. soapaction - Used to map web service requests based on the SOAP action specified in the header of the message. uri - In order to map web service requests that target a specific URI. xpathresult - Used to map web service requests based on the evaluation of an XPath expression against the incoming message. The result of the evaluation should match the XPath result specified in the endpoint URI. beanname - Allows you to reference an org.apache.camel.component.spring.ws.bean.CamelEndpointDispatcher object in order to integrate with existing (legacy) endpoint mappings like PayloadRootQNameEndpointMapping SoapActionEndpointMapping etc +| lookupKey | | String | Endpoint mapping key if endpoint mapping is used +| webServiceEndpointUri | | String | The default Web Service endpoint uri to use for the producer. +|======================================================================= +{% endraw %} + +#### 22 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| type | consumer | | EndpointMappingType | Endpoint mapping type if endpoint mapping is used. rootqname - Offers the option to map web service requests based on the qualified name of the root element contained in the message. soapaction - Used to map web service requests based on the SOAP action specified in the header of the message. uri - In order to map web service requests that target a specific URI. xpathresult - Used to map web service requests based on the evaluation of an XPath expression against the incoming message. The result of the evaluation should match the XPath result specified in the endpoint URI. beanname - Allows you to reference an org.apache.camel.component.spring.ws.bean.CamelEndpointDispatcher object in order to integrate with existing (legacy) endpoint mappings like PayloadRootQNameEndpointMapping SoapActionEndpointMapping etc -| lookupKey | consumer | | String | Endpoint mapping key if endpoint mapping is used -| webServiceEndpointUri | producer | | String | The default Web Service endpoint uri to use for the producer. | messageFilter | common | | MessageFilter | Option to provide a custom MessageFilter. For example when you want to process your headers or attachments by your own. | bridgeErrorHandler | consumer | false | boolean | 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. | endpointDispatcher | consumer | | CamelEndpointDispatcher | Spring org.springframework.ws.server.endpoint.MessageEndpoint for dispatching messages received by Spring-WS to a Camel endpoint to integrate with existing (legacy) endpoint mappings like PayloadRootQNameEndpointMapping SoapActionEndpointMapping etc. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-spring/src/main/docs/spring-event-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-spring/src/main/docs/spring-event-component.adoc b/components/camel-spring/src/main/docs/spring-event-component.adoc index 71345b2..859483c 100644 --- a/components/camel-spring/src/main/docs/spring-event-component.adoc +++ b/components/camel-spring/src/main/docs/spring-event-component.adoc @@ -43,13 +43,26 @@ The Spring Event component supports 2 options which are listed below. // endpoint options: START -The Spring Event component supports 5 endpoint options which are listed below: +The Spring Event component is configured using the URI syntax with the following path and query parameters: + + spring-event:name + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| name | | String | Name of endpoint +|======================================================================= +{% endraw %} + +#### 4 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| name | common | | String | Name of endpoint | bridgeErrorHandler | consumer | false | boolean | 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. | exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | exchangePattern | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-sql/src/main/docs/sql-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-sql/src/main/docs/sql-component.adoc b/components/camel-sql/src/main/docs/sql-component.adoc index 2589d10..a15ad9d 100644 --- a/components/camel-sql/src/main/docs/sql-component.adoc +++ b/components/camel-sql/src/main/docs/sql-component.adoc @@ -126,13 +126,26 @@ The SQL component supports 3 options which are listed below. // endpoint options: START -The SQL component supports 46 endpoint options which are listed below: +The SQL component is configured using the URI syntax with the following path and query parameters: + + sql:query + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| query | | String | *Required* Sets the SQL query to perform. You can externalize the query by using file: or classpath: as prefix and specify the location of the file. +|======================================================================= +{% endraw %} + +#### 45 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| query | common | | String | *Required* Sets the SQL query to perform. You can externalize the query by using file: or classpath: as prefix and specify the location of the file. | allowNamedParameters | common | true | boolean | Whether to allow using named parameters in the queries. | dataSource | common | | DataSource | Sets the DataSource to use to communicate with the database. | dataSourceRef | common | | String | Sets the reference to a DataSource to lookup from the registry to use for communicating with the database. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-sql/src/main/docs/sql-stored-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-sql/src/main/docs/sql-stored-component.adoc b/components/camel-sql/src/main/docs/sql-stored-component.adoc index dac9898..6f2e09f 100644 --- a/components/camel-sql/src/main/docs/sql-stored-component.adoc +++ b/components/camel-sql/src/main/docs/sql-stored-component.adoc @@ -81,13 +81,26 @@ The SQL StoredProcedure component supports 2 options which are listed below. // endpoint options: START -The SQL StoredProcedure component supports 7 endpoint options which are listed below: +The SQL StoredProcedure component is configured using the URI syntax with the following path and query parameters: + + sql-stored:template + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| template | | String | *Required* Sets the StoredProcedure template to perform +|======================================================================= +{% endraw %} + +#### 6 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| template | producer | | String | *Required* Sets the StoredProcedure template to perform | batch | producer | false | boolean | Enables or disables batch mode | dataSource | producer | | DataSource | Sets the DataSource to use to communicate with the database. | noop | producer | false | boolean | If set will ignore the results of the template and use the existing IN message as the OUT message for the continuation of processing http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-ssh/src/main/docs/ssh-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-ssh/src/main/docs/ssh-component.adoc b/components/camel-ssh/src/main/docs/ssh-component.adoc index a1f9d96..fc888a2 100644 --- a/components/camel-ssh/src/main/docs/ssh-component.adoc +++ b/components/camel-ssh/src/main/docs/ssh-component.adoc @@ -58,14 +58,27 @@ The SSH component supports 12 options which are listed below. // endpoint options: START -The SSH component supports 28 endpoint options which are listed below: +The SSH component is configured using the URI syntax with the following path and query parameters: + + ssh:host:port + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| host | | String | *Required* Sets the hostname of the remote SSH server. +| port | 22 | int | Sets the port number for the remote SSH server. +|======================================================================= +{% endraw %} + +#### 26 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| host | common | | String | *Required* Sets the hostname of the remote SSH server. -| port | common | 22 | int | Sets the port number for the remote SSH server. | timeout | common | 30000 | long | Sets the timeout in milliseconds to wait in establishing the remote SSH server connection. Defaults to 30000 milliseconds. | bridgeErrorHandler | consumer | false | boolean | 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. | pollCommand | consumer | | String | Sets the command string to send to the remote SSH server during every poll cycle. Only works with camel-ssh component being used as a consumer i.e. from(ssh://...) You may need to end your command with a newline and that must be URL encoded 0A http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-stax/src/main/docs/stax-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-stax/src/main/docs/stax-component.adoc b/components/camel-stax/src/main/docs/stax-component.adoc index 452f5fa..3161b83 100644 --- a/components/camel-stax/src/main/docs/stax-component.adoc +++ b/components/camel-stax/src/main/docs/stax-component.adoc @@ -54,13 +54,26 @@ The StAX component has no options. // endpoint options: START -The StAX component supports 2 endpoint options which are listed below: +The StAX component is configured using the URI syntax with the following path and query parameters: + + stax:contentHandlerClass + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| contentHandlerClass | | String | *Required* The FQN class name for the ContentHandler implementation to use. +|======================================================================= +{% endraw %} + +#### 1 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| contentHandlerClass | producer | | String | *Required* The FQN class name for the ContentHandler implementation to use. | synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= {% endraw %} http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-stomp/src/main/docs/stomp-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-stomp/src/main/docs/stomp-component.adoc b/components/camel-stomp/src/main/docs/stomp-component.adoc index 6fc00fd..48c32a4 100644 --- a/components/camel-stomp/src/main/docs/stomp-component.adoc +++ b/components/camel-stomp/src/main/docs/stomp-component.adoc @@ -57,13 +57,26 @@ The Stomp component supports 6 options which are listed below. // endpoint options: START -The Stomp component supports 10 endpoint options which are listed below: +The Stomp component is configured using the URI syntax with the following path and query parameters: + + stomp:destination + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| destination | | String | *Required* Name of the queue +|======================================================================= +{% endraw %} + +#### 9 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| destination | common | | String | *Required* Name of the queue | brokerURL | common | tcp://localhost:61613 | String | *Required* The URI of the Stomp broker to connect to | host | common | | String | The virtual host name | bridgeErrorHandler | consumer | false | boolean | 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. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-stream/src/main/docs/stream-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-stream/src/main/docs/stream-component.adoc b/components/camel-stream/src/main/docs/stream-component.adoc index 65f7e9e..f2d8ce9 100644 --- a/components/camel-stream/src/main/docs/stream-component.adoc +++ b/components/camel-stream/src/main/docs/stream-component.adoc @@ -53,13 +53,26 @@ The Stream component has no options. // endpoint options: START -The Stream component supports 19 endpoint options which are listed below: +The Stream component is configured using the URI syntax with the following path and query parameters: + + stream:kind + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| kind | | String | *Required* Kind of stream to use such as System.in or System.out. +|======================================================================= +{% endraw %} + +#### 18 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| kind | common | | String | *Required* Kind of stream to use such as System.in or System.out. | encoding | common | | String | You can configure the encoding (is a charset name) to use text-based streams (for example message body is a String object). If not provided Camel uses the JVM default Charset. | fileName | common | | String | When using the stream:file URI format this option specifies the filename to stream to/from. | url | common | | String | When using the stream:url URI format this option specifies the URL to stream to/from. The input/output stream will be opened using the JDK URLConnection facility. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-stringtemplate/src/main/docs/string-template-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-stringtemplate/src/main/docs/string-template-component.adoc b/components/camel-stringtemplate/src/main/docs/string-template-component.adoc index a845ab0..908f4e3 100644 --- a/components/camel-stringtemplate/src/main/docs/string-template-component.adoc +++ b/components/camel-stringtemplate/src/main/docs/string-template-component.adoc @@ -43,13 +43,26 @@ The String Template component has no options. // endpoint options: START -The String Template component supports 5 endpoint options which are listed below: +The String Template component is configured using the URI syntax with the following path and query parameters: + + string-template:resourceUri + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| resourceUri | | String | *Required* Path to the resource. You can prefix with: classpath file http ref or bean. classpath file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot eg bean:myBean.myMethod. +|======================================================================= +{% endraw %} + +#### 4 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| resourceUri | producer | | String | *Required* Path to the resource. You can prefix with: classpath file http ref or bean. classpath file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot eg bean:myBean.myMethod. | contentCache | producer | false | boolean | Sets whether to use resource content cache or not | delimiterStart | producer | < | char | The variable start delimiter | delimiterStop | producer | > | char | The variable end delimiter http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-telegram/src/main/docs/telegram-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-telegram/src/main/docs/telegram-component.adoc b/components/camel-telegram/src/main/docs/telegram-component.adoc index 9a50501..768d208 100644 --- a/components/camel-telegram/src/main/docs/telegram-component.adoc +++ b/components/camel-telegram/src/main/docs/telegram-component.adoc @@ -60,14 +60,27 @@ The Telegram component supports 2 options which are listed below. // endpoint options: START -The Telegram component supports 24 endpoint options which are listed below: +The Telegram component is configured using the URI syntax with the following path and query parameters: + + telegram:type/authorizationToken + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| type | | String | *Required* The endpoint type. Currently only the 'bots' type is supported. +| authorizationToken | | String | *Required* The authorization token for using the bot (ask the BotFather) eg. 654321531:HGF_dTra456323dHuOedsE343211fqr3t-H. +|======================================================================= +{% endraw %} + +#### 22 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| type | common | | String | *Required* The endpoint type. Currently only the 'bots' type is supported. -| authorizationToken | security | | String | *Required* The authorization token for using the bot (ask the BotFather) eg. 654321531:HGF_dTra456323dHuOedsE343211fqr3t-H. | bridgeErrorHandler | consumer | false | boolean | 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. | limit | consumer | 100 | Integer | Limit on the number of updates that can be received in a single polling request. | sendEmptyMessageWhenIdle | consumer | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-tika/src/main/docs/tika-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-tika/src/main/docs/tika-component.adoc b/components/camel-tika/src/main/docs/tika-component.adoc index cb5a6e8..fa50539 100644 --- a/components/camel-tika/src/main/docs/tika-component.adoc +++ b/components/camel-tika/src/main/docs/tika-component.adoc @@ -40,13 +40,26 @@ The Tika component has no options. // endpoint options: START -The Tika component supports 6 endpoint options which are listed below: +The Tika component is configured using the URI syntax with the following path and query parameters: + + tika:operation + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| operation | | TikaOperation | *Required* Tika Operation. parse or detect +|======================================================================= +{% endraw %} + +#### 5 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| operation | producer | | TikaOperation | *Required* Tika Operation. parse or detect | tikaConfig | producer | | TikaConfig | Tika Config | tikaConfigUri | producer | | String | Tika Config Uri: The URI of tika-config.xml | tikaParseOutputEncoding | producer | | String | Tika Parse Output Encoding - Used to specify the character encoding of the parsed output. Defaults to Charset.defaultCharset() . http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-twitter/src/main/docs/twitter-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-twitter/src/main/docs/twitter-component.adoc b/components/camel-twitter/src/main/docs/twitter-component.adoc index dbddbc4..14a41a3 100644 --- a/components/camel-twitter/src/main/docs/twitter-component.adoc +++ b/components/camel-twitter/src/main/docs/twitter-component.adoc @@ -132,13 +132,26 @@ Removed from Camel 2.11 onwards.* // endpoint options: START -The Twitter component supports 43 endpoint options which are listed below: +The Twitter component is configured using the URI syntax with the following path and query parameters: + + twitter:kind + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| kind | | String | *Required* What polling mode to use direct polling or event based. The event mode is only supported when the endpoint kind is event based. +|======================================================================= +{% endraw %} + +#### 42 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| kind | common | | String | *Required* What polling mode to use direct polling or event based. The event mode is only supported when the endpoint kind is event based. | user | common | | String | Username used for user timeline consumption direct message production etc. | bridgeErrorHandler | consumer | false | boolean | 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. | sendEmptyMessageWhenIdle | consumer | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-undertow/src/main/docs/undertow-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-undertow/src/main/docs/undertow-component.adoc b/components/camel-undertow/src/main/docs/undertow-component.adoc index 35f8ac2..236b9d5 100644 --- a/components/camel-undertow/src/main/docs/undertow-component.adoc +++ b/components/camel-undertow/src/main/docs/undertow-component.adoc @@ -60,13 +60,26 @@ The Undertow component supports 3 options which are listed below. // endpoint options: START -The Undertow component supports 18 endpoint options which are listed below: +The Undertow component is configured using the URI syntax with the following path and query parameters: + + undertow:httpURI + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| httpURI | | URI | *Required* The url of the HTTP endpoint to use. +|======================================================================= +{% endraw %} + +#### 17 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| httpURI | common | | URI | *Required* The url of the HTTP endpoint to use. | bridgeErrorHandler | consumer | false | boolean | 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. | httpMethodRestrict | consumer | | String | Used to only allow consuming if the HttpMethod matches such as GET/POST/PUT etc. Multiple methods can be specified separated by comma. | matchOnUriPrefix | consumer | true | Boolean | Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-velocity/src/main/docs/velocity-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-velocity/src/main/docs/velocity-component.adoc b/components/camel-velocity/src/main/docs/velocity-component.adoc index 50ed03d..67d9a9c 100644 --- a/components/camel-velocity/src/main/docs/velocity-component.adoc +++ b/components/camel-velocity/src/main/docs/velocity-component.adoc @@ -57,13 +57,26 @@ The Velocity component supports 2 options which are listed below. // endpoint options: START -The Velocity component supports 6 endpoint options which are listed below: +The Velocity component is configured using the URI syntax with the following path and query parameters: + + velocity:resourceUri + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| resourceUri | | String | *Required* Path to the resource. You can prefix with: classpath file http ref or bean. classpath file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot eg bean:myBean.myMethod. +|======================================================================= +{% endraw %} + +#### 5 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| resourceUri | producer | | String | *Required* Path to the resource. You can prefix with: classpath file http ref or bean. classpath file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot eg bean:myBean.myMethod. | contentCache | producer | false | boolean | Sets whether to use resource content cache or not | encoding | producer | | String | Character encoding of the resource content. | loaderCache | producer | true | boolean | Enables / disables the velocity resource loader cache which is enabled by default http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-vertx/src/main/docs/vertx-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-vertx/src/main/docs/vertx-component.adoc b/components/camel-vertx/src/main/docs/vertx-component.adoc index ac20aa1..74bc6ef 100644 --- a/components/camel-vertx/src/main/docs/vertx-component.adoc +++ b/components/camel-vertx/src/main/docs/vertx-component.adoc @@ -59,13 +59,26 @@ The Vert.x component supports 7 options which are listed below. // endpoint options: START -The Vert.x component supports 6 endpoint options which are listed below: +The Vert.x component is configured using the URI syntax with the following path and query parameters: + + vertx:address + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| address | | String | *Required* Sets the event bus address used to communicate +|======================================================================= +{% endraw %} + +#### 5 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| address | common | | String | *Required* Sets the event bus address used to communicate | pubSub | common | | Boolean | Whether to use publish/subscribe instead of point to point when sending to a vertx endpoint. | bridgeErrorHandler | consumer | false | boolean | 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. | exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-weather/src/main/docs/weather-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-weather/src/main/docs/weather-component.adoc b/components/camel-weather/src/main/docs/weather-component.adoc index 54e72da..fd65e40 100644 --- a/components/camel-weather/src/main/docs/weather-component.adoc +++ b/components/camel-weather/src/main/docs/weather-component.adoc @@ -47,13 +47,26 @@ The Weather component has no options. // endpoint options: START -The Weather component supports 44 endpoint options which are listed below: +The Weather component is configured using the URI syntax with the following path and query parameters: + + weather:name + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| name | | String | *Required* The name value is not used. +|======================================================================= +{% endraw %} + +#### 43 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| name | common | | String | *Required* The name value is not used. | appid | common | | String | *Required* APPID ID used to authenticate the user connected to the API Server | headerName | common | | String | To store the weather result in this header instead of the message body. This is useable if you want to keep current message body as-is. | language | common | en | WeatherLanguage | Language of the response. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-websocket/src/main/docs/websocket-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-websocket/src/main/docs/websocket-component.adoc b/components/camel-websocket/src/main/docs/websocket-component.adoc index b2d81b3..52af4d0 100644 --- a/components/camel-websocket/src/main/docs/websocket-component.adoc +++ b/components/camel-websocket/src/main/docs/websocket-component.adoc @@ -67,15 +67,28 @@ The Jetty Websocket component supports 13 options which are listed below. // endpoint options: START -The Jetty Websocket component supports 21 endpoint options which are listed below: +The Jetty Websocket component is configured using the URI syntax with the following path and query parameters: + + websocket:host:port/resourceUri + +#### 3 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| host | 0.0.0.0 | String | The hostname. The default value is 0.0.0.0. Setting this option on the component will use the component configured value as default. +| port | 9292 | Integer | The port number. The default value is 9292. Setting this option on the component will use the component configured value as default. +| resourceUri | | String | *Required* Name of the websocket channel to use +|======================================================================= +{% endraw %} + +#### 18 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| host | common | 0.0.0.0 | String | The hostname. The default value is 0.0.0.0. Setting this option on the component will use the component configured value as default. -| port | common | 9292 | Integer | The port number. The default value is 9292. Setting this option on the component will use the component configured value as default. -| resourceUri | common | | String | *Required* Name of the websocket channel to use | maxBinaryMessageSize | common | 1 | Integer | Can be used to set the size in bytes that the websocket created by the websocketServlet may be accept before closing. (Default is -1 - or unlimited) | bridgeErrorHandler | consumer | false | boolean | 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. | sessionSupport | consumer | false | boolean | Whether to enable session support which enables HttpSession for each http request. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-xmlrpc/src/main/docs/xmlrpc-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-xmlrpc/src/main/docs/xmlrpc-component.adoc b/components/camel-xmlrpc/src/main/docs/xmlrpc-component.adoc index aecf5ad..04da8c1 100644 --- a/components/camel-xmlrpc/src/main/docs/xmlrpc-component.adoc +++ b/components/camel-xmlrpc/src/main/docs/xmlrpc-component.adoc @@ -101,13 +101,26 @@ The XML RPC component has no options. // endpoint options: START -The XML RPC component supports 19 endpoint options which are listed below: +The XML RPC component is configured using the URI syntax with the following path and query parameters: + + xmlrpc:address + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| address | | String | *Required* The server url +|======================================================================= +{% endraw %} + +#### 18 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| address | producer | | String | *Required* The server url | basicEncoding | producer | | String | Sets the encoding for basic authentication null means UTF-8 is chosen. | connectionTimeout | producer | | int | Set the connection timeout in milliseconds 0 is to disable it | contentLengthOptional | producer | false | boolean | Whether a Content-Length header may be omitted. The XML-RPC specification demands that such a header be present. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-xmlsecurity/src/main/docs/xmlsecurity-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-xmlsecurity/src/main/docs/xmlsecurity-component.adoc b/components/camel-xmlsecurity/src/main/docs/xmlsecurity-component.adoc index 3c4f588..b8a1ecf 100644 --- a/components/camel-xmlsecurity/src/main/docs/xmlsecurity-component.adoc +++ b/components/camel-xmlsecurity/src/main/docs/xmlsecurity-component.adoc @@ -249,14 +249,27 @@ The XML Security component supports 3 options which are listed below. // endpoint options: START -The XML Security component supports 37 endpoint options which are listed below: +The XML Security component is configured using the URI syntax with the following path and query parameters: + + xmlsecurity:command:name + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| command | | XmlCommand | *Required* Whether to sign or verify. +| name | | String | *Required* The name part in the URI can be chosen by the user to distinguish between different signer/verifier endpoints within the camel context. +|======================================================================= +{% endraw %} + +#### 35 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| command | producer | | XmlCommand | *Required* Whether to sign or verify. -| name | producer | | String | *Required* The name part in the URI can be chosen by the user to distinguish between different signer/verifier endpoints within the camel context. | baseUri | common | | String | You can set a base URI which is used in the URI dereferencing. Relative URIs are then concatenated with the base URI. | clearHeaders | common | true | Boolean | Determines if the XML signature specific headers be cleared after signing and verification. Defaults to true. | cryptoContextProperties | common | | Map | Sets the crypto context properties. See link XMLCryptoContextsetProperty(String Object). Possible properties are defined in XMLSignContext an XMLValidateContext (see Supported Properties). The following properties are set by default to the value link BooleanTRUE for the XML validation. If you want to switch these features off you must set the property value to link BooleanFALSE. org.jcp.xml.dsig.validateManifests javax.xml.crypto.dsig.cacheReference http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-xmpp/src/main/docs/xmpp-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-xmpp/src/main/docs/xmpp-component.adoc b/components/camel-xmpp/src/main/docs/xmpp-component.adoc index dea7cde..2013922 100644 --- a/components/camel-xmpp/src/main/docs/xmpp-component.adoc +++ b/components/camel-xmpp/src/main/docs/xmpp-component.adoc @@ -43,15 +43,28 @@ The XMPP component has no options. // endpoint options: START -The XMPP component supports 21 endpoint options which are listed below: +The XMPP component is configured using the URI syntax with the following path and query parameters: + + xmpp:host:port/participant + +#### 3 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| host | | String | *Required* Hostname for the chat server +| port | | int | *Required* Port number for the chat server +| participant | | String | JID (Jabber ID) of person to receive messages. room parameter has precedence over participant. +|======================================================================= +{% endraw %} + +#### 18 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| host | common | | String | *Required* Hostname for the chat server -| port | common | | int | *Required* Port number for the chat server -| participant | common | | String | JID (Jabber ID) of person to receive messages. room parameter has precedence over participant. | login | common | true | boolean | Whether to login the user. | nickname | common | | String | Use nickname when joining room. If room is specified and nickname is not user will be used for the nickname. | pubsub | common | false | boolean | Accept pubsub packets on input default is false http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-yammer/src/main/docs/yammer-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-yammer/src/main/docs/yammer-component.adoc b/components/camel-yammer/src/main/docs/yammer-component.adoc index dc32e54..9f9c60a 100644 --- a/components/camel-yammer/src/main/docs/yammer-component.adoc +++ b/components/camel-yammer/src/main/docs/yammer-component.adoc @@ -68,13 +68,26 @@ You can also configure these options directly in the endpoint. // endpoint options: START -The Yammer component supports 29 endpoint options which are listed below: +The Yammer component is configured using the URI syntax with the following path and query parameters: + + yammer:function + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| function | | YammerFunctionType | *Required* The function to use +|======================================================================= +{% endraw %} + +#### 28 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| function | common | | YammerFunctionType | *Required* The function to use | useJson | common | false | boolean | Set to true if you want to use raw JSON rather than converting to POJOs. | bridgeErrorHandler | consumer | false | boolean | 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. | delay | consumer | 5000 | long | Delay between polling in millis http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-zookeeper/src/main/docs/zookeeper-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-zookeeper/src/main/docs/zookeeper-component.adoc b/components/camel-zookeeper/src/main/docs/zookeeper-component.adoc index 2a97d59..fcf8d49 100644 --- a/components/camel-zookeeper/src/main/docs/zookeeper-component.adoc +++ b/components/camel-zookeeper/src/main/docs/zookeeper-component.adoc @@ -56,14 +56,27 @@ The ZooKeeper component supports 2 options which are listed below. // component options: END // endpoint options: START -The ZooKeeper component supports 14 endpoint options which are listed below: +The ZooKeeper component is configured using the URI syntax with the following path and query parameters: + + zookeeper:serverUrls/path + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| serverUrls | | String | *Required* The zookeeper server hosts (multiple servers can be separated by comma) +| path | | String | *Required* The node in the ZooKeeper server (aka znode) +|======================================================================= +{% endraw %} + +#### 12 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| serverUrls | common | | String | *Required* The zookeeper server hosts (multiple servers can be separated by comma) -| path | common | | String | *Required* The node in the ZooKeeper server (aka znode) | awaitExistence | common | true | boolean | Not in use | listChildren | common | false | boolean | Whether the children of the node should be listed | timeout | common | 5000 | int | The time interval to wait on connection before timing out. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/UpdateReadmeMojo.java ---------------------------------------------------------------------- diff --git a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/UpdateReadmeMojo.java b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/UpdateReadmeMojo.java index 7112e88..3a4fad1 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/UpdateReadmeMojo.java +++ b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/UpdateReadmeMojo.java @@ -799,7 +799,12 @@ public class UpdateReadmeMojo extends AbstractMojo { String desc = "*Required* " + option.getDescription(); option.setDescription(desc); } - component.addEndpointOption(option); + // separate the options in path vs parameter so we can generate two different tables + if ("path".equals(option.getKind())) { + component.addEndpointPathOption(option); + } else { + component.addEndpointOption(option); + } } return component; http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/model/ComponentModel.java ---------------------------------------------------------------------- diff --git a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/model/ComponentModel.java b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/model/ComponentModel.java index f117ca8..0832bc1 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/model/ComponentModel.java +++ b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/model/ComponentModel.java @@ -42,6 +42,7 @@ public class ComponentModel { private String artifactId; private String version; private final List<ComponentOptionModel> componentOptions = new ArrayList<ComponentOptionModel>(); + private final List<EndpointOptionModel> endpointPathOptions = new ArrayList<EndpointOptionModel>(); private final List<EndpointOptionModel> endpointOptions = new ArrayList<EndpointOptionModel>(); public ComponentModel(boolean coreOnly) { @@ -188,10 +189,18 @@ public class ComponentModel { return endpointOptions; } + public List<EndpointOptionModel> getEndpointPathOptions() { + return endpointPathOptions; + } + public void addEndpointOption(EndpointOptionModel option) { endpointOptions.add(option); } + public void addEndpointPathOption(EndpointOptionModel option) { + endpointPathOptions.add(option); + } + public String getShortJavaType() { if (javaType.startsWith("java.util.Map")) { return "Map"; http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel ---------------------------------------------------------------------- diff --git a/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel b/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel index d153109..a6b359b 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel +++ b/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel @@ -1,4 +1,18 @@ -The @{title} component supports @{endpointOptions.size()} endpoint options which are listed below: +The @{title} component is configured using the URI syntax with the following path and query parameters: + + @{syntax} + +#### @{endpointPathOptions.size()} path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +@foreach{row : endpointPathOptions}| @{row.name} | @{row.defaultValue} | @{row.shortJavaType} | @{row.description} +@end{}|======================================================================= +{% endraw %} + +#### @{endpointOptions.size()} query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"]
