http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-jdbc/src/main/docs/jdbc-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jdbc/src/main/docs/jdbc-component.adoc b/components/camel-jdbc/src/main/docs/jdbc-component.adoc index 1211ace..85188bc 100644 --- a/components/camel-jdbc/src/main/docs/jdbc-component.adoc +++ b/components/camel-jdbc/src/main/docs/jdbc-component.adoc @@ -62,13 +62,26 @@ The JDBC component supports 2 options which are listed below. // endpoint options: START -The JDBC component supports 14 endpoint options which are listed below: +The JDBC component is configured using the URI syntax with the following path and query parameters: + + jdbc:dataSourceName + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| dataSourceName | | String | *Required* Name of DataSource to lookup in the Registry. +|======================================================================= +{% endraw %} + +#### 13 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| dataSourceName | producer | | String | *Required* Name of DataSource to lookup in the Registry. | allowNamedParameters | producer | true | boolean | Whether to allow using named parameters in the queries. | outputClass | producer | | String | Specify the full package and class name to use as conversion when outputType=SelectOne or SelectList. | outputType | producer | SelectList | JdbcOutputType | Determines the output the producer should use.
http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-jetty9/src/main/docs/jetty-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jetty9/src/main/docs/jetty-component.adoc b/components/camel-jetty9/src/main/docs/jetty-component.adoc index b3e766b..387b20e 100644 --- a/components/camel-jetty9/src/main/docs/jetty-component.adoc +++ b/components/camel-jetty9/src/main/docs/jetty-component.adoc @@ -103,13 +103,26 @@ The Jetty 9 component supports 32 options which are listed below. // endpoint options: START -The Jetty 9 component supports 56 endpoint options which are listed below: +The Jetty 9 component is configured using the URI syntax with the following path and query parameters: + + jetty: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 call. +|======================================================================= +{% endraw %} + +#### 55 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| httpUri | producer | | URI | *Required* The url of the HTTP endpoint to call. | chunked | common | true | boolean | If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response | disableStreamCache | common | false | boolean | Determines whether or not the raw input stream from Servlet is cached or not (Camel will read the stream into a in memory/overflow to file Stream caching) cache. By default Camel will cache the Servlet input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream such as streaming it directly to a file or other persistent store. DefaultHttpBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support reading the stream multiple times. If you use Servlet to bridge/proxy an endpoint then consider enabling this option to improve performance in case you do not need to read the message payload multiple times. The http/http4 producer will by default cache the response body stream. If setting this option to true then the producers will not ca che the response body stream but use the response stream as-is as the message body. | enableMultipartFilter | common | false | boolean | Whether Jetty org.eclipse.jetty.servlets.MultiPartFilter is enabled or not. You should set this value to false when bridging endpoints to ensure multipart requests is proxied/bridged as well. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-jgroups/src/main/docs/jgroups-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jgroups/src/main/docs/jgroups-component.adoc b/components/camel-jgroups/src/main/docs/jgroups-component.adoc index d3035d3..8204216 100644 --- a/components/camel-jgroups/src/main/docs/jgroups-component.adoc +++ b/components/camel-jgroups/src/main/docs/jgroups-component.adoc @@ -71,13 +71,26 @@ The JGroups component supports 4 options which are listed below. // endpoint options: START -The JGroups component supports 7 endpoint options which are listed below: +The JGroups component is configured using the URI syntax with the following path and query parameters: + + jgroups:clusterName + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| clusterName | | String | *Required* The name of the JGroups cluster the component should connect to. +|======================================================================= +{% endraw %} + +#### 6 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| clusterName | common | | String | *Required* The name of the JGroups cluster the component should connect to. | channelProperties | common | | String | Specifies configuration properties of the JChannel used by the 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. | enableViewMessages | consumer | false | boolean | If set to true the consumer endpoint will receive org.jgroups.View messages as well (not only org.jgroups.Message instances). By default only regular messages are consumed by the endpoint. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-jing/src/main/docs/jing-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jing/src/main/docs/jing-component.adoc b/components/camel-jing/src/main/docs/jing-component.adoc index 3a2fc62..fb91bf1 100644 --- a/components/camel-jing/src/main/docs/jing-component.adoc +++ b/components/camel-jing/src/main/docs/jing-component.adoc @@ -47,13 +47,26 @@ The Jing component has no options. // endpoint options: START -The Jing component supports 3 endpoint options which are listed below: +The Jing component is configured using the URI syntax with the following path and query parameters: + + jing:resourceUri + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| resourceUri | | String | *Required* URL to a local resource on the classpath or a full URL to a remote resource or resource on the file system which contains the schema to validate against. +|======================================================================= +{% endraw %} + +#### 2 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| resourceUri | producer | | String | *Required* URL to a local resource on the classpath or a full URL to a remote resource or resource on the file system which contains the schema to validate against. | compactSyntax | producer | false | boolean | Whether to validate using RelaxNG compact syntax or not. By default this is false for using RelaxNG XML Syntax (rng) And true is for using RelaxNG Compact Syntax (rnc) | synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-jira/src/main/docs/jira-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jira/src/main/docs/jira-component.adoc b/components/camel-jira/src/main/docs/jira-component.adoc index 5bf480b..75e121f 100644 --- a/components/camel-jira/src/main/docs/jira-component.adoc +++ b/components/camel-jira/src/main/docs/jira-component.adoc @@ -49,13 +49,26 @@ The JIRA component has no options. // endpoint options: START -The JIRA component supports 10 endpoint options which are listed below: +The JIRA component is configured using the URI syntax with the following path and query parameters: + + jira:type + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| type | | JIRAType | *Required* Operation to perform such as create a new issue or a new comment +|======================================================================= +{% endraw %} + +#### 9 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| type | common | | JIRAType | *Required* Operation to perform such as create a new issue or a new comment | password | common | | String | Password for login | serverUrl | common | | String | *Required* URL to the JIRA server | username | common | | String | Username for login http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-jms/src/main/docs/jms-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jms/src/main/docs/jms-component.adoc b/components/camel-jms/src/main/docs/jms-component.adoc index f67a568..d9fd8b0 100644 --- a/components/camel-jms/src/main/docs/jms-component.adoc +++ b/components/camel-jms/src/main/docs/jms-component.adoc @@ -305,14 +305,27 @@ The JMS component supports 76 options which are listed below. // endpoint options: START -The JMS component supports 87 endpoint options which are listed below: +The JMS component is configured using the URI syntax with the following path and query parameters: + + jms:destinationType:destinationName + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| destinationType | queue | String | The kind of destination to use +| destinationName | | String | *Required* Name of the queue or topic to use as destination +|======================================================================= +{% endraw %} + +#### 85 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| destinationType | common | queue | String | The kind of destination to use -| destinationName | common | | String | *Required* Name of the queue or topic to use as destination | clientId | common | | String | Sets the JMS client ID to use. Note that this value if specified must be unique and can only be used by a single JMS connection instance. It is typically only required for durable topic subscriptions. If using Apache ActiveMQ you may prefer to use Virtual Topics instead. | connectionFactory | common | | ConnectionFactory | Sets the default connection factory to be used if a connection factory is not specified for either link setTemplateConnectionFactory(ConnectionFactory) or link setListenerConnectionFactory(ConnectionFactory) | disableReplyTo | common | false | boolean | If true a producer will behave like a InOnly exchange with the exception that JMSReplyTo header is sent out and not be suppressed like in the case of InOnly. Like InOnly the producer will not wait for a reply. A consumer with this flag will behave like InOnly. This feature can be used to bridge InOut requests to another queue so that a route on the other queue will send its response directly back to the original JMSReplyTo. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-jmx/src/main/docs/jmx-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jmx/src/main/docs/jmx-component.adoc b/components/camel-jmx/src/main/docs/jmx-component.adoc index ede3296..cafc04b 100644 --- a/components/camel-jmx/src/main/docs/jmx-component.adoc +++ b/components/camel-jmx/src/main/docs/jmx-component.adoc @@ -26,13 +26,26 @@ The JMX component has no options. // component options: END // endpoint options: START -The JMX component supports 30 endpoint options which are listed below: +The JMX component is configured using the URI syntax with the following path and query parameters: + + jmx:serverURL + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| serverURL | | String | server url comes from the remaining endpoint +|======================================================================= +{% endraw %} + +#### 29 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| serverURL | consumer | | String | server url comes from the remaining 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. | format | consumer | xml | String | URI Property: Format for the message body. Either xml or raw. If xml the notification is serialized to xml. If raw then the raw java object is set as the body. | granularityPeriod | consumer | 10000 | long | URI Property: monitor types only The frequency to poll the bean to check the monitor. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-jolt/src/main/docs/jolt-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jolt/src/main/docs/jolt-component.adoc b/components/camel-jolt/src/main/docs/jolt-component.adoc index fcb7667..0e07025 100644 --- a/components/camel-jolt/src/main/docs/jolt-component.adoc +++ b/components/camel-jolt/src/main/docs/jolt-component.adoc @@ -61,13 +61,26 @@ The JOLT component supports 2 options which are listed below. // endpoint options: START -The JOLT component supports 6 endpoint options which are listed below: +The JOLT component is configured using the URI syntax with the following path and query parameters: + + jolt: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 | inputType | producer | Hydrated | JoltInputOutputType | Specifies if the input is hydrated JSON or a JSON String. | outputType | producer | Hydrated | JoltInputOutputType | Specifies if the output should be hydrated JSON or a JSON String. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-jpa/src/main/docs/jpa-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jpa/src/main/docs/jpa-component.adoc b/components/camel-jpa/src/main/docs/jpa-component.adoc index ac2d720..f736734 100644 --- a/components/camel-jpa/src/main/docs/jpa-component.adoc +++ b/components/camel-jpa/src/main/docs/jpa-component.adoc @@ -109,13 +109,26 @@ The JPA component supports 5 options which are listed below. // endpoint options: START -The JPA component supports 42 endpoint options which are listed below: +The JPA component is configured using the URI syntax with the following path and query parameters: + + jpa:entityType + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| entityType | | Class<?> | *Required* The JPA annotated class to use as entity. +|======================================================================= +{% endraw %} + +#### 41 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| entityType | common | | Class<?> | *Required* The JPA annotated class to use as entity. | joinTransaction | common | true | boolean | The camel-jpa component will join transaction by default. You can use this option to turn this off for example if you use LOCAL_RESOURCE and join transaction doesn't work with your JPA provider. This option can also be set globally on the JpaComponent instead of having to set it on all endpoints. | persistenceUnit | common | camel | String | *Required* The JPA persistence unit used by default. | sharedEntityManager | common | false | boolean | Whether to use Spring's SharedEntityManager for the consumer/producer. Note in most cases joinTransaction should be set to false as this is not an EXTENDED EntityManager. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-jsch/src/main/docs/scp-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jsch/src/main/docs/scp-component.adoc b/components/camel-jsch/src/main/docs/scp-component.adoc index 8d9c093..1e64614 100644 --- a/components/camel-jsch/src/main/docs/scp-component.adoc +++ b/components/camel-jsch/src/main/docs/scp-component.adoc @@ -64,15 +64,28 @@ The SCP component supports 2 options which are listed below. // endpoint options: START -The SCP component supports 22 endpoint options which are listed below: +The SCP component is configured using the URI syntax with the following path and query parameters: + + scp:host:port/directoryName + +#### 3 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| host | | String | *Required* Hostname of the FTP server +| port | | int | Port of the FTP server +| directoryName | | String | The starting directory +|======================================================================= +{% endraw %} + +#### 19 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| host | producer | | String | *Required* Hostname of the FTP server -| port | producer | | int | Port of the FTP server -| directoryName | producer | | String | The starting directory | disconnect | common | false | boolean | Whether or not to disconnect from remote FTP server right after use. Disconnect will only disconnect the current connection to the FTP server. If you have a consumer which you want to stop then you need to stop the consumer/route instead. | chmod | producer | 664 | String | Allows you to set chmod on the stored file. For example chmod=664. | fileName | producer | | String | Use Expression such as File Language to dynamically set the filename. For consumers it's used as a filename filter. For producers it's used to evaluate the filename to write. If an expression is set it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type it is always evaluated using the File Language. If the expression is an Expression type the specified Expression type is used - this allows you for instance to use OGNL expressions. For the consumer you can use it to filter filenames so you can for instance consume today's file using the File Language syntax: mydata-$date:now:yyyyMMdd.txt. The producers support the CamelOverruleFileName header which takes precedence over any existing CamelFileName header; the CamelOverruleFileName is a header that is used only once and makes it easier as this avoids to temporary store CamelFileName and have to restore it afterwards. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-jt400/src/main/docs/jt400-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jt400/src/main/docs/jt400-component.adoc b/components/camel-jt400/src/main/docs/jt400-component.adoc index 4569569..1125afa 100644 --- a/components/camel-jt400/src/main/docs/jt400-component.adoc +++ b/components/camel-jt400/src/main/docs/jt400-component.adoc @@ -54,17 +54,30 @@ The JT400 component supports 2 options which are listed below. // endpoint options: START -The JT400 component supports 34 endpoint options which are listed below: +The JT400 component is configured using the URI syntax with the following path and query parameters: + + jt400:userID:password/systemName/objectPath.type + +#### 5 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| userID | | String | *Required* Returns the ID of the AS/400 user. +| password | | String | *Required* Returns the password of the AS/400 user. +| systemName | | String | *Required* Returns the name of the AS/400 system. +| objectPath | | String | *Required* Returns the fully qualified integrated file system path name of the target object of this endpoint. +| type | | Jt400Type | *Required* Whether to work with data queues or remote program call +|======================================================================= +{% endraw %} + +#### 29 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| userID | common | | String | *Required* Returns the ID of the AS/400 user. -| password | common | | String | *Required* Returns the password of the AS/400 user. -| systemName | common | | String | *Required* Returns the name of the AS/400 system. -| objectPath | common | | String | *Required* Returns the fully qualified integrated file system path name of the target object of this endpoint. -| type | common | | Jt400Type | *Required* Whether to work with data queues or remote program call | ccsid | common | | int | Sets the CCSID to use for the connection with the AS/400 system. | format | common | text | Format | Sets the data format for sending messages. | guiAvailable | common | false | boolean | Sets whether AS/400 prompting is enabled in the environment running Camel. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-kafka/src/main/docs/kafka-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-kafka/src/main/docs/kafka-component.adoc b/components/camel-kafka/src/main/docs/kafka-component.adoc index 92f0ae8..26e0f83 100644 --- a/components/camel-kafka/src/main/docs/kafka-component.adoc +++ b/components/camel-kafka/src/main/docs/kafka-component.adoc @@ -52,13 +52,26 @@ The Kafka component supports 3 options which are listed below. // endpoint options: START -The Kafka component supports 82 endpoint options which are listed below: +The Kafka component is configured using the URI syntax with the following path and query parameters: + + kafka:topic + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| topic | | String | *Required* Name of the topic to use. +|======================================================================= +{% endraw %} + +#### 81 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| topic | common | | String | *Required* Name of the topic to use. | brokers | common | | String | URL of the Kafka brokers to use. The format is host1:port1host2:port2 and the list can be a subset of brokers or a VIP pointing to a subset of brokers. This option is known as bootstrap.servers in the Kafka documentation. | clientId | common | | String | The client id is a user-specified string sent in each request to help trace calls. It should logically identify the application making the request. | groupId | common | | String | A string that uniquely identifies the group of consumer processes to which this consumer belongs. By setting the same group id multiple processes indicate that they are all part of the same consumer group. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-kestrel/src/main/docs/kestrel-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-kestrel/src/main/docs/kestrel-component.adoc b/components/camel-kestrel/src/main/docs/kestrel-component.adoc index 0e3813e..6f34509 100644 --- a/components/camel-kestrel/src/main/docs/kestrel-component.adoc +++ b/components/camel-kestrel/src/main/docs/kestrel-component.adoc @@ -87,14 +87,27 @@ The Kestrel component supports 2 options which are listed below. // endpoint options: START -The Kestrel component supports 8 endpoint options which are listed below: +The Kestrel component is configured using the URI syntax with the following path and query parameters: + + kestrel:addresses/queue + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| addresses | localhost:22133 | String[] | The address(es) on which kestrel is running +| queue | | String | *Required* The queue we are polling +|======================================================================= +{% endraw %} + +#### 6 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| addresses | common | localhost:22133 | String[] | The address(es) on which kestrel is running -| queue | common | | String | *Required* The queue we are polling | concurrentConsumers | common | 1 | int | How many concurrent listeners to schedule for the thread pool | waitTimeMs | common | 100 | int | How long a given wait should block (server side) in 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. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-krati/src/main/docs/krati-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-krati/src/main/docs/krati-component.adoc b/components/camel-krati/src/main/docs/krati-component.adoc index 53c9f42..4e37375 100644 --- a/components/camel-krati/src/main/docs/krati-component.adoc +++ b/components/camel-krati/src/main/docs/krati-component.adoc @@ -51,13 +51,26 @@ The Krati component has no options. // endpoint options: START -The Krati component supports 30 endpoint options which are listed below: +The Krati component is configured using the URI syntax with the following path and query parameters: + + krati:path + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| path | | String | *Required* Path of the datastore is the relative path of the folder that krati will use for its datastore. +|======================================================================= +{% endraw %} + +#### 29 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| path | common | | String | *Required* Path of the datastore is the relative path of the folder that krati will use for its datastore. | hashFunction | common | | HashFunction<byte[]> | The hash function to use. | initialCapacity | common | 100 | int | The inital capcity of the store. | keySerializer | common | | Object> | The serializer that will be used to serialize the key. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-kubernetes/src/main/docs/kubernetes-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-kubernetes/src/main/docs/kubernetes-component.adoc b/components/camel-kubernetes/src/main/docs/kubernetes-component.adoc index 04512c3..4ecde62 100644 --- a/components/camel-kubernetes/src/main/docs/kubernetes-component.adoc +++ b/components/camel-kubernetes/src/main/docs/kubernetes-component.adoc @@ -43,13 +43,26 @@ The Kubernetes component has no options. // endpoint options: START -The Kubernetes component supports 28 endpoint options which are listed below: +The Kubernetes component is configured using the URI syntax with the following path and query parameters: + + kubernetes:masterUrl + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| masterUrl | | String | *Required* Kubernetes Master url +|======================================================================= +{% endraw %} + +#### 27 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| masterUrl | common | | String | *Required* Kubernetes Master url | apiVersion | common | | String | The Kubernetes API Version to use | category | common | | String | *Required* Kubernetes Producer and Consumer category | dnsDomain | common | | String | The dns domain used for ServiceCall EIP http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-ldap/src/main/docs/ldap-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-ldap/src/main/docs/ldap-component.adoc b/components/camel-ldap/src/main/docs/ldap-component.adoc index 8f46484..4ee8391 100644 --- a/components/camel-ldap/src/main/docs/ldap-component.adoc +++ b/components/camel-ldap/src/main/docs/ldap-component.adoc @@ -47,13 +47,26 @@ The LDAP component has no options. // endpoint options: START -The LDAP component supports 6 endpoint options which are listed below: +The LDAP component is configured using the URI syntax with the following path and query parameters: + + ldap:dirContextName + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| dirContextName | | String | *Required* Name of javax.naming.directory.DirContext bean to lookup in the registry. +|======================================================================= +{% endraw %} + +#### 5 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| dirContextName | producer | | String | *Required* Name of javax.naming.directory.DirContext bean to lookup in the registry. | base | producer | ou=system | String | The base DN for searches. | pageSize | producer | | Integer | When specified the ldap module uses paging to retrieve all results (most LDAP Servers throw an exception when trying to retrieve more than 1000 entries in one query). To be able to use this a LdapContext (subclass of DirContext) has to be passed in as ldapServerBean (otherwise an exception is thrown) | returnedAttributes | producer | | String | Comma-separated list of attributes that should be set in each entry of the result http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-linkedin/camel-linkedin-component/src/main/docs/linkedin-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-linkedin/camel-linkedin-component/src/main/docs/linkedin-component.adoc b/components/camel-linkedin/camel-linkedin-component/src/main/docs/linkedin-component.adoc index 5d3a7f1..9b18ad9 100644 --- a/components/camel-linkedin/camel-linkedin-component/src/main/docs/linkedin-component.adoc +++ b/components/camel-linkedin/camel-linkedin-component/src/main/docs/linkedin-component.adoc @@ -71,14 +71,27 @@ The Linkedin component supports 2 options which are listed below. // endpoint options: START -The Linkedin component supports 16 endpoint options which are listed below: +The Linkedin component is configured using the URI syntax with the following path and query parameters: + + linkedin:apiName/methodName + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| apiName | | LinkedInApiName | *Required* What kind of operation to perform +| methodName | | String | *Required* What sub operation to use for the selected operation +|======================================================================= +{% endraw %} + +#### 14 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| apiName | common | | LinkedInApiName | *Required* What kind of operation to perform -| methodName | common | | String | *Required* What sub operation to use for the selected operation | clientId | common | | String | LinkedIn application client ID | clientSecret | common | | String | LinkedIn application client secret | httpParams | common | | Map | Custom HTTP params for example proxy host and port use constants from AllClientPNames http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-lucene/src/main/docs/lucene-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-lucene/src/main/docs/lucene-component.adoc b/components/camel-lucene/src/main/docs/lucene-component.adoc index 8dddb47..330b1ba 100644 --- a/components/camel-lucene/src/main/docs/lucene-component.adoc +++ b/components/camel-lucene/src/main/docs/lucene-component.adoc @@ -72,14 +72,27 @@ The Lucene component supports 2 options which are listed below. // endpoint options: START -The Lucene component supports 7 endpoint options which are listed below: +The Lucene component is configured using the URI syntax with the following path and query parameters: + + lucene:host:operation + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| host | | String | *Required* The URL to the lucene server +| operation | | LuceneOperation | *Required* Operation to do such as insert or query. +|======================================================================= +{% endraw %} + +#### 5 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| host | producer | | String | *Required* The URL to the lucene server -| operation | producer | | LuceneOperation | *Required* Operation to do such as insert or query. | analyzer | producer | | Analyzer | An Analyzer builds TokenStreams which analyze text. It thus represents a policy for extracting index terms from text. The value for analyzer can be any class that extends the abstract class org.apache.lucene.analysis.Analyzer. Lucene also offers a rich set of analyzers out of the box | indexDir | producer | | File | A file system directory in which index files are created upon analysis of the document by the specified analyzer | maxHits | producer | | int | An integer value that limits the result set of the search operation http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-lumberjack/src/main/docs/lumberjack-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-lumberjack/src/main/docs/lumberjack-component.adoc b/components/camel-lumberjack/src/main/docs/lumberjack-component.adoc index efc9a39..292a23d 100644 --- a/components/camel-lumberjack/src/main/docs/lumberjack-component.adoc +++ b/components/camel-lumberjack/src/main/docs/lumberjack-component.adoc @@ -58,14 +58,27 @@ The Lumberjack component supports 2 options which are listed below. // endpoint options: START -The Lumberjack component supports 7 endpoint options which are listed below: +The Lumberjack component is configured using the URI syntax with the following path and query parameters: + + lumberjack:host:port + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| host | | String | *Required* Network interface on which to listen for Lumberjack +| port | 5044 | int | Network port on which to listen for Lumberjack +|======================================================================= +{% endraw %} + +#### 5 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| host | consumer | | String | *Required* Network interface on which to listen for Lumberjack -| port | consumer | 5044 | int | Network port on which to listen for Lumberjack | 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. | sslContextParameters | consumer | | SSLContextParameters | SSL configuration | 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-mail/src/main/docs/mail-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-mail/src/main/docs/mail-component.adoc b/components/camel-mail/src/main/docs/mail-component.adoc index 98aab95..5d7f1bf 100644 --- a/components/camel-mail/src/main/docs/mail-component.adoc +++ b/components/camel-mail/src/main/docs/mail-component.adoc @@ -98,14 +98,27 @@ The Mail component supports 3 options which are listed below. // endpoint options: START -The Mail component supports 63 endpoint options which are listed below: +The Mail component is configured using the URI syntax with the following path and query parameters: + + imap:host:port + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| host | | String | *Required* The mail server host name +| port | | int | The port number of the mail server +|======================================================================= +{% endraw %} + +#### 61 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| host | common | | String | *Required* The mail server host name -| port | common | | int | The port number of the mail server | 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. | closeFolder | consumer | true | boolean | Whether the consumer should close the folder after polling. Setting this option to false and having disconnect=false as well then the consumer keep the folder open between polls. | copyTo | consumer | | String | After processing a mail message it can be copied to a mail folder with the given name. You can override this configuration value with a header with the key copyTo allowing you to copy messages to folder names configured at runtime. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-metrics/src/main/docs/metrics-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-metrics/src/main/docs/metrics-component.adoc b/components/camel-metrics/src/main/docs/metrics-component.adoc index 99a8dd2..5481830 100644 --- a/components/camel-metrics/src/main/docs/metrics-component.adoc +++ b/components/camel-metrics/src/main/docs/metrics-component.adoc @@ -60,14 +60,27 @@ The Metrics component supports 2 options which are listed below. // endpoint options: START -The Metrics component supports 9 endpoint options which are listed below: +The Metrics component is configured using the URI syntax with the following path and query parameters: + + metrics:metricsType:metricsName + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| metricsType | | MetricsType | *Required* Type of metrics +| metricsName | | String | *Required* Name of metrics +|======================================================================= +{% endraw %} + +#### 7 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| metricsType | producer | | MetricsType | *Required* Type of metrics -| metricsName | producer | | String | *Required* Name of metrics | action | producer | | MetricsTimerAction | Action when using timer type | decrement | producer | | Long | Decrement value when using counter type | increment | producer | | Long | Increment value when using counter type http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-mina/src/main/docs/mina-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-mina/src/main/docs/mina-component.adoc b/components/camel-mina/src/main/docs/mina-component.adoc index 95414a1..c9099d3 100644 --- a/components/camel-mina/src/main/docs/mina-component.adoc +++ b/components/camel-mina/src/main/docs/mina-component.adoc @@ -86,15 +86,28 @@ The Mina component supports 2 options which are listed below. // endpoint options: START -The Mina component supports 24 endpoint options which are listed below: +The Mina component is configured using the URI syntax with the following path and query parameters: + + mina:protocol:host:port + +#### 3 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| protocol | | String | *Required* Protocol to use +| host | | String | *Required* Hostname to use. Use localhost or 0.0.0.0 for local server as consumer. For producer use the hostname or ip address of the remote server. +| port | | int | *Required* Port number +|======================================================================= +{% endraw %} + +#### 21 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| protocol | common | | String | *Required* Protocol to use -| host | common | | String | *Required* Hostname to use. Use localhost or 0.0.0.0 for local server as consumer. For producer use the hostname or ip address of the remote server. -| port | common | | int | *Required* Port number | disconnect | common | false | boolean | Whether or not to disconnect(close) from Mina session right after use. Can be used for both consumer and producer. | minaLogger | common | false | boolean | You can enable the Apache MINA logging filter. Apache MINA uses slf4j logging at INFO level to log all input and output. | sync | common | true | boolean | Setting to set endpoint as one-way or request-response. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-mina2/src/main/docs/mina2-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-mina2/src/main/docs/mina2-component.adoc b/components/camel-mina2/src/main/docs/mina2-component.adoc index 8cc8254..0a6527e 100644 --- a/components/camel-mina2/src/main/docs/mina2-component.adoc +++ b/components/camel-mina2/src/main/docs/mina2-component.adoc @@ -85,15 +85,28 @@ The Mina2 component supports 2 options which are listed below. // endpoint options: START -The Mina2 component supports 29 endpoint options which are listed below: +The Mina2 component is configured using the URI syntax with the following path and query parameters: + + mina2:protocol:host:port + +#### 3 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| protocol | | String | *Required* Protocol to use +| host | | String | *Required* Hostname to use. Use localhost or 0.0.0.0 for local server as consumer. For producer use the hostname or ip address of the remote server. +| port | | int | *Required* Port number +|======================================================================= +{% endraw %} + +#### 26 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| protocol | common | | String | *Required* Protocol to use -| host | common | | String | *Required* Hostname to use. Use localhost or 0.0.0.0 for local server as consumer. For producer use the hostname or ip address of the remote server. -| port | common | | int | *Required* Port number | disconnect | common | false | boolean | Whether or not to disconnect(close) from Mina session right after use. Can be used for both consumer and producer. | minaLogger | common | false | boolean | You can enable the Apache MINA logging filter. Apache MINA uses slf4j logging at INFO level to log all input and output. | sync | common | true | boolean | Setting to set endpoint as one-way or request-response. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-mllp/src/main/docs/mllp-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-mllp/src/main/docs/mllp-component.adoc b/components/camel-mllp/src/main/docs/mllp-component.adoc index 75f128e..b1dbbb7 100644 --- a/components/camel-mllp/src/main/docs/mllp-component.adoc +++ b/components/camel-mllp/src/main/docs/mllp-component.adoc @@ -51,14 +51,27 @@ The MLLP component has no options. // endpoint options: START -The MLLP component supports 24 endpoint options which are listed below: +The MLLP component is configured using the URI syntax with the following path and query parameters: + + mllp:hostname:port + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| hostname | | String | *Required* Hostname or IP for connection for the TCP connection. The default value is null which means any local IP address +| port | | int | *Required* Port number for the TCP connection +|======================================================================= +{% endraw %} + +#### 22 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| hostname | common | | String | *Required* Hostname or IP for connection for the TCP connection. The default value is null which means any local IP address -| port | common | | int | *Required* Port number for the TCP connection | autoAck | common | true | boolean | Enable/Disable the automatic generation of a MLLP Acknowledgement MLLP Consumers only | bufferWrites | common | true | boolean | Enable/Disable the validation of HL7 Payloads If enabled MLLP Payloads are buffered and written to the external system in a single write(byte) operation. If disabled the MLLP payload will not be buffered and three write operations will be used. The first operation will write the MLLP start-of-block character 0x0b (ASCII VT) the second operation will write the HL7 payload and the third operation will writh the MLLP end-of-block character and the MLLP end-of-data character 0x1c 0x0d (ASCII FS CR). | hl7Headers | common | true | boolean | Enable/Disable the automatic generation of message headers from the HL7 Message MLLP Consumers only http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-mongodb-gridfs/src/main/docs/mongodb-gridfs-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-mongodb-gridfs/src/main/docs/mongodb-gridfs-component.adoc b/components/camel-mongodb-gridfs/src/main/docs/mongodb-gridfs-component.adoc index 363d81f..37ca5e65 100644 --- a/components/camel-mongodb-gridfs/src/main/docs/mongodb-gridfs-component.adoc +++ b/components/camel-mongodb-gridfs/src/main/docs/mongodb-gridfs-component.adoc @@ -33,13 +33,26 @@ The MongoDB GridFS component has no options. // endpoint options: START -The MongoDB GridFS component supports 18 endpoint options which are listed below: +The MongoDB GridFS component is configured using the URI syntax with the following path and query parameters: + + mongodb-gridfs:connectionBean + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| connectionBean | | String | *Required* Name of com.mongodb.Mongo to use. +|======================================================================= +{% endraw %} + +#### 17 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| connectionBean | common | | String | *Required* Name of com.mongodb.Mongo to use. | bucket | common | fs | String | Sets the name of the GridFS bucket within the database. Default is fs. | database | common | | String | *Required* Sets the name of the MongoDB database to target | readPreference | common | | ReadPreference | Sets a MongoDB ReadPreference on the Mongo connection. Read preferences set directly on the connection will be overridden by this setting. The link com.mongodb.ReadPreferencevalueOf(String) utility method is used to resolve the passed readPreference value. Some examples for the possible values are nearest primary or secondary etc. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-mongodb/src/main/docs/mongodb-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-mongodb/src/main/docs/mongodb-component.adoc b/components/camel-mongodb/src/main/docs/mongodb-component.adoc index 628d4df..62d05e0 100644 --- a/components/camel-mongodb/src/main/docs/mongodb-component.adoc +++ b/components/camel-mongodb/src/main/docs/mongodb-component.adoc @@ -60,13 +60,26 @@ The MongoDB component has no options. // endpoint options: START -The MongoDB component supports 24 endpoint options which are listed below: +The MongoDB component is configured using the URI syntax with the following path and query parameters: + + mongodb:connectionBean + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| connectionBean | | String | *Required* Name of com.mongodb.Mongo to use. +|======================================================================= +{% endraw %} + +#### 23 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| connectionBean | common | | String | *Required* Name of com.mongodb.Mongo to use. | collection | common | | String | Sets the name of the MongoDB collection to bind to this endpoint | collectionIndex | common | | String | Sets the collection index (JSON FORMAT : field1 : order1 field2 : order2) | createCollection | common | true | boolean | Create collection during initialisation if it doesn't exist. Default is true. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-mongodb3/src/main/docs/mongodb3-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-mongodb3/src/main/docs/mongodb3-component.adoc b/components/camel-mongodb3/src/main/docs/mongodb3-component.adoc index 1e3d376..f7a4ea2 100644 --- a/components/camel-mongodb3/src/main/docs/mongodb3-component.adoc +++ b/components/camel-mongodb3/src/main/docs/mongodb3-component.adoc @@ -62,13 +62,26 @@ The MongoDB component has no options. // endpoint options: START -The MongoDB component supports 20 endpoint options which are listed below: +The MongoDB component is configured using the URI syntax with the following path and query parameters: + + mongodb3:connectionBean + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| connectionBean | | String | *Required* Name of com.mongodb.Mongo to use. +|======================================================================= +{% endraw %} + +#### 19 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| connectionBean | common | | String | *Required* Name of com.mongodb.Mongo to use. | collection | common | | String | Sets the name of the MongoDB collection to bind to this endpoint | collectionIndex | common | | String | Sets the collection index (JSON FORMAT : field1 : order1 field2 : order2) | createCollection | common | true | boolean | Create collection during initialisation if it doesn't exist. Default is true. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-mqtt/src/main/docs/mqtt-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-mqtt/src/main/docs/mqtt-component.adoc b/components/camel-mqtt/src/main/docs/mqtt-component.adoc index 6243929..6e749b3 100644 --- a/components/camel-mqtt/src/main/docs/mqtt-component.adoc +++ b/components/camel-mqtt/src/main/docs/mqtt-component.adoc @@ -57,13 +57,26 @@ The MQTT component supports 4 options which are listed below. // endpoint options: START -The MQTT component supports 40 endpoint options which are listed below: +The MQTT component is configured using the URI syntax with the following path and query parameters: + + mqtt:name + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| name | | String | *Required* A logical name to use which is not the topic name. +|======================================================================= +{% endraw %} + +#### 39 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| name | common | | String | *Required* A logical name to use which is not the topic name. | blockingExecutor | common | | Executor | SSL connections perform blocking operations against internal thread pool unless you call the setBlockingExecutor method to configure that executor they will use instead. | byDefaultRetain | common | false | boolean | The default retain policy to be used on messages sent to the MQTT broker | cleanSession | common | false | boolean | Set to false if you want the MQTT server to persist topic subscriptions and ack positions across client sessions. Defaults to true. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-msv/src/main/docs/msv-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-msv/src/main/docs/msv-component.adoc b/components/camel-msv/src/main/docs/msv-component.adoc index bbe2ff4..58bc1c8 100644 --- a/components/camel-msv/src/main/docs/msv-component.adoc +++ b/components/camel-msv/src/main/docs/msv-component.adoc @@ -72,13 +72,26 @@ The MSV component supports 3 options which are listed below. // endpoint options: START -The MSV component supports 12 endpoint options which are listed below: +The MSV component is configured using the URI syntax with the following path and query parameters: + + msv:resourceUri + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| resourceUri | | String | *Required* URL to a local resource on the classpath or a reference to lookup a bean in the Registry or a full URL to a remote resource or resource on the file system which contains the XSD to validate against. +|======================================================================= +{% endraw %} + +#### 11 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| resourceUri | producer | | String | *Required* URL to a local resource on the classpath or a reference to lookup a bean in the Registry or a full URL to a remote resource or resource on the file system which contains the XSD to validate against. | failOnNullBody | producer | true | boolean | Whether to fail if no body exists. | failOnNullHeader | producer | true | boolean | Whether to fail if no header exists when validating against a header. | headerName | producer | | String | To validate against a header instead of the message body. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-mustache/src/main/docs/mustache-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-mustache/src/main/docs/mustache-component.adoc b/components/camel-mustache/src/main/docs/mustache-component.adoc index aecf1e7..00dc851 100644 --- a/components/camel-mustache/src/main/docs/mustache-component.adoc +++ b/components/camel-mustache/src/main/docs/mustache-component.adoc @@ -62,13 +62,26 @@ The Mustache component supports 2 options which are listed below. // endpoint options: START -The Mustache component supports 6 endpoint options which are listed below: +The Mustache component is configured using the URI syntax with the following path and query parameters: + + mustache: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. | endDelimiter | producer | }} | String | Characters used to mark template code end. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-mvel/src/main/docs/mvel-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-mvel/src/main/docs/mvel-component.adoc b/components/camel-mvel/src/main/docs/mvel-component.adoc index 54a78e2..af2e8fe 100644 --- a/components/camel-mvel/src/main/docs/mvel-component.adoc +++ b/components/camel-mvel/src/main/docs/mvel-component.adoc @@ -44,13 +44,26 @@ The MVEL component has no options. // endpoint options: START -The MVEL component supports 4 endpoint options which are listed below: +The MVEL component is configured using the URI syntax with the following path and query parameters: + + mvel: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 %} + +#### 3 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. | synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-mybatis/src/main/docs/mybatis-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-mybatis/src/main/docs/mybatis-component.adoc b/components/camel-mybatis/src/main/docs/mybatis-component.adoc index 217f6ee..f00d502 100644 --- a/components/camel-mybatis/src/main/docs/mybatis-component.adoc +++ b/components/camel-mybatis/src/main/docs/mybatis-component.adoc @@ -65,13 +65,26 @@ The MyBatis component supports 3 options which are listed below. // endpoint options: START -The MyBatis component supports 30 endpoint options which are listed below: +The MyBatis component is configured using the URI syntax with the following path and query parameters: + + mybatis:statement + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| statement | | String | *Required* The statement name in the MyBatis XML mapping file which maps to the query insert update or delete operation you wish to evaluate. +|======================================================================= +{% endraw %} + +#### 29 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| statement | common | | String | *Required* The statement name in the MyBatis XML mapping file which maps to the query insert update or delete operation you wish to evaluate. | outputHeader | common | | String | Store the query result in a header instead of the message body. By default outputHeader == null and the query result is stored in the message body any existing content in the message body is discarded. If outputHeader is set the value is used as the name of the header to store the query result and the original message body is preserved. Setting outputHeader will also omit populating the default CamelMyBatisResult header since it would be the same as outputHeader all the time. | 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. | inputHeader | consumer | | String | User the header value for input parameters instead of the message body. By default inputHeader == null and the input parameters are taken from the message body. If outputHeader is set the value is used and query parameters will be taken from the header instead of the body. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-nagios/src/main/docs/nagios-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-nagios/src/main/docs/nagios-component.adoc b/components/camel-nagios/src/main/docs/nagios-component.adoc index ebd3f18..e7afa7d 100644 --- a/components/camel-nagios/src/main/docs/nagios-component.adoc +++ b/components/camel-nagios/src/main/docs/nagios-component.adoc @@ -59,14 +59,27 @@ The Nagios component supports 2 options which are listed below. // endpoint options: START -The Nagios component supports 8 endpoint options which are listed below: +The Nagios component is configured using the URI syntax with the following path and query parameters: + + nagios:host:port + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| host | | String | *Required* This is the address of the Nagios host where checks should be send. +| port | | int | *Required* The port number of the host. +|======================================================================= +{% endraw %} + +#### 6 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| host | producer | | String | *Required* This is the address of the Nagios host where checks should be send. -| port | producer | | int | *Required* The port number of the host. | connectionTimeout | producer | 5000 | int | Connection timeout in millis. | sendSync | producer | true | boolean | Whether or not to use synchronous when sending a passive check. Setting it to false will allow Camel to continue routing the message and the passive check message will be send asynchronously. | timeout | producer | 5000 | int | Sending timeout in millis. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-nats/src/main/docs/nats-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-nats/src/main/docs/nats-component.adoc b/components/camel-nats/src/main/docs/nats-component.adoc index 3652b44..48713e3 100644 --- a/components/camel-nats/src/main/docs/nats-component.adoc +++ b/components/camel-nats/src/main/docs/nats-component.adoc @@ -38,13 +38,26 @@ The Nats component has no options. // endpoint options: START -The Nats component supports 23 endpoint options which are listed below: +The Nats component is configured using the URI syntax with the following path and query parameters: + + nats:servers + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| servers | | String | *Required* URLs to one or more NAT servers. Use comma to separate URLs when specifying multiple servers. +|======================================================================= +{% endraw %} + +#### 22 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| servers | common | | String | *Required* URLs to one or more NAT servers. Use comma to separate URLs when specifying multiple servers. | flushConnection | common | false | boolean | Define if we want to flush connection or not | flushTimeout | common | 1000 | int | Set the flush timeout | maxReconnectAttempts | common | 3 | int | Max reconnection attempts http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-netty-http/src/main/docs/netty-http-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-netty-http/src/main/docs/netty-http-component.adoc b/components/camel-netty-http/src/main/docs/netty-http-component.adoc index 1c6ff12..9d45f76 100644 --- a/components/camel-netty-http/src/main/docs/netty-http-component.adoc +++ b/components/camel-netty-http/src/main/docs/netty-http-component.adoc @@ -102,16 +102,29 @@ The Netty HTTP component supports 6 options which are listed below. // endpoint options: START -The Netty HTTP component supports 82 endpoint options which are listed below: +The Netty HTTP component is configured using the URI syntax with the following path and query parameters: + + netty-http:protocol:host:port/path + +#### 4 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| protocol | | String | *Required* The protocol to use which is either http or https +| host | | String | *Required* The local hostname such as localhost or 0.0.0.0 when being a consumer. The remote HTTP server hostname when using producer. +| port | | int | The host port number +| path | | String | Resource path +|======================================================================= +{% endraw %} + +#### 78 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| protocol | common | | String | *Required* The protocol to use which is either http or https -| host | common | | String | *Required* The local hostname such as localhost or 0.0.0.0 when being a consumer. The remote HTTP server hostname when using producer. -| port | common | | int | The host port number -| path | common | | String | Resource path | bridgeEndpoint | common | false | boolean | If the option is true the producer will ignore the Exchange.HTTP_URI header and use the endpoint's URI for request. You may also set the throwExceptionOnFailure to be false to let the producer send all the fault response back. The consumer working in the bridge mode will skip the gzip compression and WWW URL form encoding (by adding the Exchange.SKIP_GZIP_ENCODING and Exchange.SKIP_WWW_FORM_URLENCODED headers to the consumed exchange). | disconnect | common | false | boolean | Whether or not to disconnect(close) from Netty Channel right after use. Can be used for both consumer and producer. | keepAlive | common | true | boolean | Setting to ensure socket is not closed due to inactivity http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-netty/src/main/docs/netty-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-netty/src/main/docs/netty-component.adoc b/components/camel-netty/src/main/docs/netty-component.adoc index b7195c2..6e87209 100644 --- a/components/camel-netty/src/main/docs/netty-component.adoc +++ b/components/camel-netty/src/main/docs/netty-component.adoc @@ -79,15 +79,28 @@ The Netty component supports 3 options which are listed below. // endpoint options: START -The Netty component supports 70 endpoint options which are listed below: +The Netty component is configured using the URI syntax with the following path and query parameters: + + netty:protocol:host:port + +#### 3 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| protocol | | String | *Required* The protocol to use which can be tcp or udp. +| host | | String | *Required* The hostname. For the consumer the hostname is localhost or 0.0.0.0 For the producer the hostname is the remote host to connect to +| port | | int | *Required* The host port number +|======================================================================= +{% endraw %} + +#### 67 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| protocol | common | | String | *Required* The protocol to use which can be tcp or udp. -| host | common | | String | *Required* The hostname. For the consumer the hostname is localhost or 0.0.0.0 For the producer the hostname is the remote host to connect to -| port | common | | int | *Required* The host port number | disconnect | common | false | boolean | Whether or not to disconnect(close) from Netty Channel right after use. Can be used for both consumer and producer. | keepAlive | common | true | boolean | Setting to ensure socket is not closed due to inactivity | reuseAddress | common | true | boolean | Setting to facilitate socket multiplexing http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-netty4-http/src/main/docs/netty4-http-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-netty4-http/src/main/docs/netty4-http-component.adoc b/components/camel-netty4-http/src/main/docs/netty4-http-component.adoc index df5ecf4..c519c78 100644 --- a/components/camel-netty4-http/src/main/docs/netty4-http-component.adoc +++ b/components/camel-netty4-http/src/main/docs/netty4-http-component.adoc @@ -104,16 +104,29 @@ The Netty4 HTTP component supports 7 options which are listed below. // endpoint options: START -The Netty4 HTTP component supports 83 endpoint options which are listed below: +The Netty4 HTTP component is configured using the URI syntax with the following path and query parameters: + + netty4-http:protocol:host:port/path + +#### 4 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| protocol | | String | *Required* The protocol to use which is either http or https +| host | | String | *Required* The local hostname such as localhost or 0.0.0.0 when being a consumer. The remote HTTP server hostname when using producer. +| port | | int | The host port number +| path | | String | Resource path +|======================================================================= +{% endraw %} + +#### 79 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| protocol | common | | String | *Required* The protocol to use which is either http or https -| host | common | | String | *Required* The local hostname such as localhost or 0.0.0.0 when being a consumer. The remote HTTP server hostname when using producer. -| port | common | | int | The host port number -| path | common | | String | Resource path | bridgeEndpoint | common | false | boolean | If the option is true the producer will ignore the Exchange.HTTP_URI header and use the endpoint's URI for request. You may also set the throwExceptionOnFailure to be false to let the producer send all the fault response back. The consumer working in the bridge mode will skip the gzip compression and WWW URL form encoding (by adding the Exchange.SKIP_GZIP_ENCODING and Exchange.SKIP_WWW_FORM_URLENCODED headers to the consumed exchange). | disconnect | common | false | boolean | Whether or not to disconnect(close) from Netty Channel right after use. Can be used for both consumer and producer. | keepAlive | common | true | boolean | Setting to ensure socket is not closed due to inactivity http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-netty4/src/main/docs/netty4-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-netty4/src/main/docs/netty4-component.adoc b/components/camel-netty4/src/main/docs/netty4-component.adoc index 8e058d7..0d40c55 100644 --- a/components/camel-netty4/src/main/docs/netty4-component.adoc +++ b/components/camel-netty4/src/main/docs/netty4-component.adoc @@ -80,15 +80,28 @@ The Netty4 component supports 4 options which are listed below. // endpoint options: START -The Netty4 component supports 74 endpoint options which are listed below: +The Netty4 component is configured using the URI syntax with the following path and query parameters: + + netty4:protocol:host:port + +#### 3 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| protocol | | String | *Required* The protocol to use which can be tcp or udp. +| host | | String | *Required* The hostname. For the consumer the hostname is localhost or 0.0.0.0 For the producer the hostname is the remote host to connect to +| port | | int | *Required* The host port number +|======================================================================= +{% endraw %} + +#### 71 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| protocol | common | | String | *Required* The protocol to use which can be tcp or udp. -| host | common | | String | *Required* The hostname. For the consumer the hostname is localhost or 0.0.0.0 For the producer the hostname is the remote host to connect to -| port | common | | int | *Required* The host port number | disconnect | common | false | boolean | Whether or not to disconnect(close) from Netty Channel right after use. Can be used for both consumer and producer. | keepAlive | common | true | boolean | Setting to ensure socket is not closed due to inactivity | reuseAddress | common | true | boolean | Setting to facilitate socket multiplexing http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-olingo2/camel-olingo2-component/src/main/docs/olingo2-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-olingo2/camel-olingo2-component/src/main/docs/olingo2-component.adoc b/components/camel-olingo2/camel-olingo2-component/src/main/docs/olingo2-component.adoc index df07284..4d07f60 100644 --- a/components/camel-olingo2/camel-olingo2-component/src/main/docs/olingo2-component.adoc +++ b/components/camel-olingo2/camel-olingo2-component/src/main/docs/olingo2-component.adoc @@ -63,14 +63,27 @@ The Olingo2 component supports 2 options which are listed below. // endpoint options: START -The Olingo2 component supports 16 endpoint options which are listed below: +The Olingo2 component is configured using the URI syntax with the following path and query parameters: + + olingo2:apiName/methodName + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| apiName | | Olingo2ApiName | *Required* What kind of operation to perform +| methodName | | String | *Required* What sub operation to use for the selected operation +|======================================================================= +{% endraw %} + +#### 14 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| apiName | common | | Olingo2ApiName | *Required* What kind of operation to perform -| methodName | common | | String | *Required* What sub operation to use for the selected operation | connectTimeout | common | 30000 | int | HTTP connection creation timeout in milliseconds defaults to 30000 (30 seconds) | contentType | common | application/json;charset=utf-8 | String | Content-Type header value can be used to specify JSON or XML message format defaults to application/json;charset=utf-8 | httpAsyncClientBuilder | common | | HttpAsyncClientBuilder | Custom HTTP async client builder for more complex HTTP client configuration overrides connectionTimeout socketTimeout proxy and sslContext. Note that a socketTimeout MUST be specified in the builder otherwise OData requests could block indefinitely
