http://git-wip-us.apache.org/repos/asf/camel/blob/2ada6795/components/camel-jgroups/src/main/docs/jgroups.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jgroups/src/main/docs/jgroups.adoc b/components/camel-jgroups/src/main/docs/jgroups.adoc index 1374936..d6628fe 100644 --- a/components/camel-jgroups/src/main/docs/jgroups.adoc +++ b/components/camel-jgroups/src/main/docs/jgroups.adoc @@ -52,11 +52,13 @@ Options ^^^^^^^ + // component options: START The JGroups component supports 3 options which are listed below. +{% raw %} [width="100%",cols="2s,1m,8",options="header"] |======================================================================= | Name | Java Type | Description @@ -64,13 +66,17 @@ The JGroups component supports 3 options which are listed below. | channelProperties | String | Specifies configuration properties of the JChannel used by the endpoint. | enableViewMessages | 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. |======================================================================= +{% endraw %} // component options: END + + // endpoint options: START The JGroups component supports 7 endpoint options which are listed below: +{% raw %} [width="100%",cols="2s,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description @@ -82,9 +88,11 @@ The JGroups component supports 7 endpoint options which are listed below: | exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange | synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= +{% endraw %} // endpoint options: END + [[JGroups-Headers]] Headers ^^^^^^^
http://git-wip-us.apache.org/repos/asf/camel/blob/2ada6795/components/camel-jing/src/main/docs/jing.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jing/src/main/docs/jing.adoc b/components/camel-jing/src/main/docs/jing.adoc index 5e96985..a9ee5d3 100644 --- a/components/camel-jing/src/main/docs/jing.adoc +++ b/components/camel-jing/src/main/docs/jing.adoc @@ -49,9 +49,11 @@ The Jing component has no options. + // endpoint options: START The Jing component supports 4 endpoint options which are listed below: +{% raw %} [width="100%",cols="2s,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description @@ -60,9 +62,11 @@ The Jing component supports 4 endpoint options which are listed below: | exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange | synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= +{% endraw %} // endpoint options: END + [[Jing-Example]] Example ^^^^^^^ http://git-wip-us.apache.org/repos/asf/camel/blob/2ada6795/components/camel-jira/src/main/docs/jira.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jira/src/main/docs/jira.adoc b/components/camel-jira/src/main/docs/jira.adoc index 4706cf5..eaa5fe7 100644 --- a/components/camel-jira/src/main/docs/jira.adoc +++ b/components/camel-jira/src/main/docs/jira.adoc @@ -53,9 +53,11 @@ The JIRA component has no options. + // endpoint options: START The JIRA component supports 10 endpoint options which are listed below: +{% raw %} [width="100%",cols="2s,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description @@ -70,9 +72,11 @@ The JIRA component supports 10 endpoint options which are listed below: | exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange | synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= +{% endraw %} // endpoint options: END + [[JIRA-JQL:]] JQL: ^^^^ http://git-wip-us.apache.org/repos/asf/camel/blob/2ada6795/components/camel-jms/src/main/docs/jms.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jms/src/main/docs/jms.adoc b/components/camel-jms/src/main/docs/jms.adoc index 8efed5c..590d3a4 100644 --- a/components/camel-jms/src/main/docs/jms.adoc +++ b/components/camel-jms/src/main/docs/jms.adoc @@ -209,11 +209,13 @@ Component options + // component options: START The JMS component supports 71 options which are listed below. +{% raw %} [width="100%",cols="2s,1m,8",options="header"] |======================================================================= | Name | Java Type | Description @@ -289,11 +291,13 @@ The JMS component supports 71 options which are listed below. | waitForProvisionCorrelationToBeUpdatedCounter | int | Number of times to wait for provisional correlation id to be updated to the actual correlation id when doing request/reply over JMS and when the option useMessageIDAsCorrelationID is enabled. | waitForProvisionCorrelationToBeUpdatedThreadSleepingTime | long | Interval in millis to sleep each time while waiting for provisional correlation id to be updated. |======================================================================= +{% endraw %} // component options: END + [[JMS-Endpointoptions]] Endpoint options ++++++++++++++++ @@ -302,9 +306,11 @@ Endpoint options + // endpoint options: START The JMS component supports 78 endpoint options which are listed below: +{% raw %} [width="100%",cols="2s,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description @@ -387,12 +393,14 @@ The JMS component supports 78 endpoint options which are listed below: | transactionName | transaction (advanced) | | String | The name of the transaction to use. | transactionTimeout | transaction (advanced) | -1 | int | The timeout value of the transaction (in seconds) if using transacted mode. |======================================================================= +{% endraw %} // endpoint options: END + [[JMS-MessageMappingbetweenJMSandCamel]] Message Mapping between JMS and Camel ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ http://git-wip-us.apache.org/repos/asf/camel/blob/2ada6795/components/camel-jolt/src/main/docs/jolt.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jolt/src/main/docs/jolt.adoc b/components/camel-jolt/src/main/docs/jolt.adoc index 68cc1d2..42d5808 100644 --- a/components/camel-jolt/src/main/docs/jolt.adoc +++ b/components/camel-jolt/src/main/docs/jolt.adoc @@ -44,23 +44,29 @@ Options ^^^^^^^ + // component options: START The JOLT component supports 1 options which are listed below. +{% raw %} [width="100%",cols="2s,1m,8",options="header"] |======================================================================= | Name | Java Type | Description | transform | Transform | Explicitly sets the Transform to use. If not set a Transform specified by the transformDsl will be created |======================================================================= +{% endraw %} // component options: END + + // endpoint options: START The JOLT component supports 7 endpoint options which are listed below: +{% raw %} [width="100%",cols="2s,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description @@ -72,9 +78,11 @@ The JOLT component supports 7 endpoint options which are listed below: | exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange | synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= +{% endraw %} // endpoint options: END + [[JOLT-Samples]] Samples ^^^^^^^ http://git-wip-us.apache.org/repos/asf/camel/blob/2ada6795/components/camel-jpa/src/main/docs/jpa.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jpa/src/main/docs/jpa.adoc b/components/camel-jpa/src/main/docs/jpa.adoc index b3155dd..5b94672 100644 --- a/components/camel-jpa/src/main/docs/jpa.adoc +++ b/components/camel-jpa/src/main/docs/jpa.adoc @@ -89,11 +89,13 @@ Options ^^^^^^^ + // component options: START The JPA component supports 4 options which are listed below. +{% raw %} [width="100%",cols="2s,1m,8",options="header"] |======================================================================= | Name | Java Type | Description @@ -102,15 +104,19 @@ The JPA component supports 4 options which are listed below. | joinTransaction | 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. | sharedEntityManager | 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. |======================================================================= +{% endraw %} // component options: END + + // endpoint options: START The JPA component supports 42 endpoint options which are listed below: +{% raw %} [width="100%",cols="2s,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description @@ -157,11 +163,13 @@ The JPA component supports 42 endpoint options which are listed below: | timeUnit | scheduler | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options. | useFixedDelay | scheduler | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. |======================================================================= +{% endraw %} // endpoint options: END + [[JPA-MessageHeaders]] Message Headers ^^^^^^^^^^^^^^^ http://git-wip-us.apache.org/repos/asf/camel/blob/2ada6795/components/camel-jsch/src/main/docs/scp.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jsch/src/main/docs/scp.adoc b/components/camel-jsch/src/main/docs/scp.adoc index ce604f2..649d2a1 100644 --- a/components/camel-jsch/src/main/docs/scp.adoc +++ b/components/camel-jsch/src/main/docs/scp.adoc @@ -42,23 +42,29 @@ Options ^^^^^^^ + // component options: START The SCP component supports 1 options which are listed below. +{% raw %} [width="100%",cols="2s,1m,8",options="header"] |======================================================================= | Name | Java Type | Description | verboseLogging | boolean | JSCH is verbose logging out of the box. Therefore we turn the logging down to DEBUG logging by default. But setting this option to true turns on the verbose logging again. |======================================================================= +{% endraw %} // component options: END + + // endpoint options: START The SCP component supports 42 endpoint options which are listed below: +{% raw %} [width="100%",cols="2s,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description @@ -105,9 +111,11 @@ The SCP component supports 42 endpoint options which are listed below: | password | security | | String | Password to use for login | username | security | | String | Username to use for login |======================================================================= +{% endraw %} // endpoint options: END + [[Jsch-Limitations]] Limitations ^^^^^^^^^^^ http://git-wip-us.apache.org/repos/asf/camel/blob/2ada6795/components/camel-jt400/src/main/docs/jt400.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jt400/src/main/docs/jt400.adoc b/components/camel-jt400/src/main/docs/jt400.adoc index c3fd3e1..1b7fbd7 100644 --- a/components/camel-jt400/src/main/docs/jt400.adoc +++ b/components/camel-jt400/src/main/docs/jt400.adoc @@ -42,25 +42,31 @@ JT400 options ^^^^^^^^^^^^^ + // component options: START The JT400 component supports 1 options which are listed below. +{% raw %} [width="100%",cols="2s,1m,8",options="header"] |======================================================================= | Name | Java Type | Description | connectionPool | AS400ConnectionPool | Returns the default connection pool used by this component. |======================================================================= +{% endraw %} // component options: END + + // endpoint options: START The JT400 component supports 33 endpoint options which are listed below: +{% raw %} [width="100%",cols="2s,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description @@ -98,11 +104,13 @@ The JT400 component supports 33 endpoint options which are listed below: | timeUnit | scheduler | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options. | useFixedDelay | scheduler | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. |======================================================================= +{% endraw %} // endpoint options: END + [[JT400-Usage]] Usage ^^^^^ http://git-wip-us.apache.org/repos/asf/camel/blob/2ada6795/components/camel-kafka/src/main/docs/kafka.adoc ---------------------------------------------------------------------- diff --git a/components/camel-kafka/src/main/docs/kafka.adoc b/components/camel-kafka/src/main/docs/kafka.adoc index 0f23849..7fdec49 100644 --- a/components/camel-kafka/src/main/docs/kafka.adoc +++ b/components/camel-kafka/src/main/docs/kafka.adoc @@ -66,9 +66,11 @@ The Kafka component has no options. + // endpoint options: START The Kafka component supports 71 endpoint options which are listed below: +{% raw %} [width="100%",cols="2s,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description @@ -144,10 +146,12 @@ The Kafka component supports 71 endpoint options which are listed below: | exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange | synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= +{% endraw %} // endpoint options: END + For more information about Producer/Consumer configuration: http://kafka.apache.org/documentation.html#newconsumerconfigs[http://kafka.apache.org/documentation.html#newconsumerconfigs] http://git-wip-us.apache.org/repos/asf/camel/blob/2ada6795/components/camel-kestrel/src/main/docs/kestrel.adoc ---------------------------------------------------------------------- diff --git a/components/camel-kestrel/src/main/docs/kestrel.adoc b/components/camel-kestrel/src/main/docs/kestrel.adoc index a4932df..5ee1134 100644 --- a/components/camel-kestrel/src/main/docs/kestrel.adoc +++ b/components/camel-kestrel/src/main/docs/kestrel.adoc @@ -66,23 +66,29 @@ Options ^^^^^^^ + // component options: START The Kestrel component supports 1 options which are listed below. +{% raw %} [width="100%",cols="2s,1m,8",options="header"] |======================================================================= | Name | Java Type | Description | configuration | KestrelConfiguration | To use a shared configured configuration as base for creating new endpoints. |======================================================================= +{% endraw %} // component options: END + + // endpoint options: START The Kestrel component supports 8 endpoint options which are listed below: +{% raw %} [width="100%",cols="2s,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description @@ -95,9 +101,11 @@ The Kestrel component supports 8 endpoint options which are listed below: | exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange | synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= +{% endraw %} // endpoint options: END + [[Kestrel-ConfiguringtheKestrelcomponentusingSpringXML]] Configuring the Kestrel component using Spring XML ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ http://git-wip-us.apache.org/repos/asf/camel/blob/2ada6795/components/camel-krati/src/main/docs/krati.adoc ---------------------------------------------------------------------- diff --git a/components/camel-krati/src/main/docs/krati.adoc b/components/camel-krati/src/main/docs/krati.adoc index 08cf357..f78db11 100644 --- a/components/camel-krati/src/main/docs/krati.adoc +++ b/components/camel-krati/src/main/docs/krati.adoc @@ -55,9 +55,11 @@ The Krati component has no options. + // endpoint options: START The Krati component supports 30 endpoint options which are listed below: +{% raw %} [width="100%",cols="2s,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description @@ -92,11 +94,13 @@ The Krati component supports 30 endpoint options which are listed below: | timeUnit | scheduler | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options. | useFixedDelay | scheduler | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. |======================================================================= +{% endraw %} // endpoint options: END + [source,java] ------------------------------------------------------------------------------------------------ krati:/tmp/krati?operation=CamelKratiGet&initialCapacity=10000&keySerializer=#myCustomSerializer http://git-wip-us.apache.org/repos/asf/camel/blob/2ada6795/components/camel-kubernetes/src/main/docs/kubernetes.adoc ---------------------------------------------------------------------- diff --git a/components/camel-kubernetes/src/main/docs/kubernetes.adoc b/components/camel-kubernetes/src/main/docs/kubernetes.adoc index 56a08cd..93ed8f8 100644 --- a/components/camel-kubernetes/src/main/docs/kubernetes.adoc +++ b/components/camel-kubernetes/src/main/docs/kubernetes.adoc @@ -43,9 +43,11 @@ The Kubernetes component has no options. + // endpoint options: START The Kubernetes component supports 23 endpoint options which are listed below: +{% raw %} [width="100%",cols="2s,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description @@ -73,9 +75,11 @@ The Kubernetes component supports 23 endpoint options which are listed below: | trustCerts | security | | Boolean | Define if the certs we used are trusted anyway or not | username | security | | String | Username to connect to Kubernetes |======================================================================= +{% endraw %} // endpoint options: END + [[Kubernetes-Headers]] Headers ^^^^^^^ http://git-wip-us.apache.org/repos/asf/camel/blob/2ada6795/components/camel-ldap/src/main/docs/ldap.adoc ---------------------------------------------------------------------- diff --git a/components/camel-ldap/src/main/docs/ldap.adoc b/components/camel-ldap/src/main/docs/ldap.adoc index 09a21c5..e98074f 100644 --- a/components/camel-ldap/src/main/docs/ldap.adoc +++ b/components/camel-ldap/src/main/docs/ldap.adoc @@ -49,9 +49,11 @@ The LDAP component has no options. + // endpoint options: START The LDAP component supports 7 endpoint options which are listed below: +{% raw %} [width="100%",cols="2s,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description @@ -63,9 +65,11 @@ The LDAP component supports 7 endpoint options which are listed below: | exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange | synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= +{% endraw %} // endpoint options: END + [[LDAP-Result]] Result ^^^^^^ http://git-wip-us.apache.org/repos/asf/camel/blob/2ada6795/components/camel-lucene/src/main/docs/lucene.adoc ---------------------------------------------------------------------- diff --git a/components/camel-lucene/src/main/docs/lucene.adoc b/components/camel-lucene/src/main/docs/lucene.adoc index f27e07e..d796599 100644 --- a/components/camel-lucene/src/main/docs/lucene.adoc +++ b/components/camel-lucene/src/main/docs/lucene.adoc @@ -53,23 +53,29 @@ Insert Options ^^^^^^^^^^^^^^ + // component options: START The Lucene component supports 1 options which are listed below. +{% raw %} [width="100%",cols="2s,1m,8",options="header"] |======================================================================= | Name | Java Type | Description | config | LuceneConfiguration | To use a shared lucene configuration |======================================================================= +{% endraw %} // component options: END + + // endpoint options: START The Lucene component supports 8 endpoint options which are listed below: +{% raw %} [width="100%",cols="2s,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description @@ -82,9 +88,11 @@ The Lucene component supports 8 endpoint options which are listed below: | exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange | synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= +{% endraw %} // endpoint options: END + [[Lucene-Sending/ReceivingMessagestoFromthecache]] Sending/Receiving Messages to/from the cache ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ http://git-wip-us.apache.org/repos/asf/camel/blob/2ada6795/components/camel-mail/src/main/docs/imap.adoc ---------------------------------------------------------------------- diff --git a/components/camel-mail/src/main/docs/imap.adoc b/components/camel-mail/src/main/docs/imap.adoc index d4078d4..a4597c9 100644 --- a/components/camel-mail/src/main/docs/imap.adoc +++ b/components/camel-mail/src/main/docs/imap.adoc @@ -3,25 +3,31 @@ Mail Component IMAP ~~~~~~~~~~~~~~~~~~~ + // component options: START The IMAP component supports 2 options which are listed below. +{% raw %} [width="100%",cols="2s,1m,8",options="header"] |======================================================================= | Name | Java Type | Description | configuration | MailConfiguration | Sets the Mail configuration | contentTypeResolver | ContentTypeResolver | Resolver to determine Content-Type for file attachments. |======================================================================= +{% endraw %} // component options: END + + // endpoint options: START The IMAP component supports 63 endpoint options which are listed below: +{% raw %} [width="100%",cols="2s,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description @@ -89,6 +95,8 @@ The IMAP component supports 63 endpoint options which are listed below: | sslContextParameters | security | | SSLContextParameters | To configure security using SSLContextParameters. | username | security | | String | The username for login |======================================================================= +{% endraw %} // endpoint options: END + http://git-wip-us.apache.org/repos/asf/camel/blob/2ada6795/components/camel-mail/src/main/docs/imaps.adoc ---------------------------------------------------------------------- diff --git a/components/camel-mail/src/main/docs/imaps.adoc b/components/camel-mail/src/main/docs/imaps.adoc index 373bf47..7ff7df3 100644 --- a/components/camel-mail/src/main/docs/imaps.adoc +++ b/components/camel-mail/src/main/docs/imaps.adoc @@ -3,25 +3,31 @@ Mail Component IMAPs ~~~~~~~~~~~~~~~~~~~~ + // component options: START The IMAPS component supports 2 options which are listed below. +{% raw %} [width="100%",cols="2s,1m,8",options="header"] |======================================================================= | Name | Java Type | Description | configuration | MailConfiguration | Sets the Mail configuration | contentTypeResolver | ContentTypeResolver | Resolver to determine Content-Type for file attachments. |======================================================================= +{% endraw %} // component options: END + + // endpoint options: START The IMAPS component supports 63 endpoint options which are listed below: +{% raw %} [width="100%",cols="2s,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description @@ -89,6 +95,8 @@ The IMAPS component supports 63 endpoint options which are listed below: | sslContextParameters | security | | SSLContextParameters | To configure security using SSLContextParameters. | username | security | | String | The username for login |======================================================================= +{% endraw %} // endpoint options: END + http://git-wip-us.apache.org/repos/asf/camel/blob/2ada6795/components/camel-mail/src/main/docs/pop3.adoc ---------------------------------------------------------------------- diff --git a/components/camel-mail/src/main/docs/pop3.adoc b/components/camel-mail/src/main/docs/pop3.adoc index 29c5c1d..17ae7a0 100644 --- a/components/camel-mail/src/main/docs/pop3.adoc +++ b/components/camel-mail/src/main/docs/pop3.adoc @@ -3,25 +3,31 @@ Mail Component POP3 ~~~~~~~~~~~~~~~~~~~ + // component options: START The POP3 component supports 2 options which are listed below. +{% raw %} [width="100%",cols="2s,1m,8",options="header"] |======================================================================= | Name | Java Type | Description | configuration | MailConfiguration | Sets the Mail configuration | contentTypeResolver | ContentTypeResolver | Resolver to determine Content-Type for file attachments. |======================================================================= +{% endraw %} // component options: END + + // endpoint options: START The POP3 component supports 63 endpoint options which are listed below: +{% raw %} [width="100%",cols="2s,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description @@ -89,6 +95,8 @@ The POP3 component supports 63 endpoint options which are listed below: | sslContextParameters | security | | SSLContextParameters | To configure security using SSLContextParameters. | username | security | | String | The username for login |======================================================================= +{% endraw %} // endpoint options: END + http://git-wip-us.apache.org/repos/asf/camel/blob/2ada6795/components/camel-mail/src/main/docs/pop3s.adoc ---------------------------------------------------------------------- diff --git a/components/camel-mail/src/main/docs/pop3s.adoc b/components/camel-mail/src/main/docs/pop3s.adoc index 7b9269a..c0666de 100644 --- a/components/camel-mail/src/main/docs/pop3s.adoc +++ b/components/camel-mail/src/main/docs/pop3s.adoc @@ -3,25 +3,31 @@ Mail Component POP3s ~~~~~~~~~~~~~~~~~~~~ + // component options: START The POP3S component supports 2 options which are listed below. +{% raw %} [width="100%",cols="2s,1m,8",options="header"] |======================================================================= | Name | Java Type | Description | configuration | MailConfiguration | Sets the Mail configuration | contentTypeResolver | ContentTypeResolver | Resolver to determine Content-Type for file attachments. |======================================================================= +{% endraw %} // component options: END + + // endpoint options: START The POP3S component supports 63 endpoint options which are listed below: +{% raw %} [width="100%",cols="2s,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description @@ -89,6 +95,8 @@ The POP3S component supports 63 endpoint options which are listed below: | sslContextParameters | security | | SSLContextParameters | To configure security using SSLContextParameters. | username | security | | String | The username for login |======================================================================= +{% endraw %} // endpoint options: END + http://git-wip-us.apache.org/repos/asf/camel/blob/2ada6795/components/camel-mail/src/main/docs/smtp.adoc ---------------------------------------------------------------------- diff --git a/components/camel-mail/src/main/docs/smtp.adoc b/components/camel-mail/src/main/docs/smtp.adoc index a457122..55d6d0f 100644 --- a/components/camel-mail/src/main/docs/smtp.adoc +++ b/components/camel-mail/src/main/docs/smtp.adoc @@ -3,25 +3,31 @@ Mail Component SMTP ~~~~~~~~~~~~~~~~~~~ + // component options: START The SMTP component supports 2 options which are listed below. +{% raw %} [width="100%",cols="2s,1m,8",options="header"] |======================================================================= | Name | Java Type | Description | configuration | MailConfiguration | Sets the Mail configuration | contentTypeResolver | ContentTypeResolver | Resolver to determine Content-Type for file attachments. |======================================================================= +{% endraw %} // component options: END + + // endpoint options: START The SMTP component supports 63 endpoint options which are listed below: +{% raw %} [width="100%",cols="2s,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description @@ -89,6 +95,8 @@ The SMTP component supports 63 endpoint options which are listed below: | sslContextParameters | security | | SSLContextParameters | To configure security using SSLContextParameters. | username | security | | String | The username for login |======================================================================= +{% endraw %} // endpoint options: END + http://git-wip-us.apache.org/repos/asf/camel/blob/2ada6795/components/camel-mail/src/main/docs/smtps.adoc ---------------------------------------------------------------------- diff --git a/components/camel-mail/src/main/docs/smtps.adoc b/components/camel-mail/src/main/docs/smtps.adoc index b26575b..dc80cde 100644 --- a/components/camel-mail/src/main/docs/smtps.adoc +++ b/components/camel-mail/src/main/docs/smtps.adoc @@ -3,25 +3,31 @@ Mail Component SMTPs ~~~~~~~~~~~~~~~~~~~~ + // component options: START The SMTPS component supports 2 options which are listed below. +{% raw %} [width="100%",cols="2s,1m,8",options="header"] |======================================================================= | Name | Java Type | Description | configuration | MailConfiguration | Sets the Mail configuration | contentTypeResolver | ContentTypeResolver | Resolver to determine Content-Type for file attachments. |======================================================================= +{% endraw %} // component options: END + + // endpoint options: START The SMTPS component supports 63 endpoint options which are listed below: +{% raw %} [width="100%",cols="2s,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description @@ -89,6 +95,8 @@ The SMTPS component supports 63 endpoint options which are listed below: | sslContextParameters | security | | SSLContextParameters | To configure security using SSLContextParameters. | username | security | | String | The username for login |======================================================================= +{% endraw %} // endpoint options: END + http://git-wip-us.apache.org/repos/asf/camel/blob/2ada6795/components/camel-mina/src/main/docs/mina.adoc ---------------------------------------------------------------------- diff --git a/components/camel-mina/src/main/docs/mina.adoc b/components/camel-mina/src/main/docs/mina.adoc index c2d2b33..0ea538a 100644 --- a/components/camel-mina/src/main/docs/mina.adoc +++ b/components/camel-mina/src/main/docs/mina.adoc @@ -64,23 +64,29 @@ Options ^^^^^^^ + // component options: START The Mina component supports 1 options which are listed below. +{% raw %} [width="100%",cols="2s,1m,8",options="header"] |======================================================================= | Name | Java Type | Description | configuration | MinaConfiguration | To use the shared mina configuration. |======================================================================= +{% endraw %} // component options: END + + // endpoint options: START The Mina component supports 24 endpoint options which are listed below: +{% raw %} [width="100%",cols="2s,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description @@ -109,9 +115,11 @@ The Mina component supports 24 endpoint options which are listed below: | exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange | synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= +{% endraw %} // endpoint options: END + [[MINA-Usingacustomcodec]] Using a custom codec ^^^^^^^^^^^^^^^^^^^^ http://git-wip-us.apache.org/repos/asf/camel/blob/2ada6795/components/camel-mina2/src/main/docs/mina2.adoc ---------------------------------------------------------------------- diff --git a/components/camel-mina2/src/main/docs/mina2.adoc b/components/camel-mina2/src/main/docs/mina2.adoc index d6c2485..960749f 100644 --- a/components/camel-mina2/src/main/docs/mina2.adoc +++ b/components/camel-mina2/src/main/docs/mina2.adoc @@ -65,23 +65,29 @@ Options ^^^^^^^ + // component options: START The Mina2 component supports 1 options which are listed below. +{% raw %} [width="100%",cols="2s,1m,8",options="header"] |======================================================================= | Name | Java Type | Description | configuration | Mina2Configuration | To use the shared mina configuration. |======================================================================= +{% endraw %} // component options: END + + // endpoint options: START The Mina2 component supports 29 endpoint options which are listed below: +{% raw %} [width="100%",cols="2s,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description @@ -115,9 +121,11 @@ The Mina2 component supports 29 endpoint options which are listed below: | exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange | synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= +{% endraw %} // endpoint options: END + [[MINA2-Usingacustomcodec]] Using a custom codec ^^^^^^^^^^^^^^^^^^^^ http://git-wip-us.apache.org/repos/asf/camel/blob/2ada6795/components/camel-mllp/src/main/docs/mllp.adoc ---------------------------------------------------------------------- diff --git a/components/camel-mllp/src/main/docs/mllp.adoc b/components/camel-mllp/src/main/docs/mllp.adoc index ef1c855..a59c026 100644 --- a/components/camel-mllp/src/main/docs/mllp.adoc +++ b/components/camel-mllp/src/main/docs/mllp.adoc @@ -48,9 +48,11 @@ The mllp component has no options. + // endpoint options: START The mllp component supports 19 endpoint options which are listed below: +{% raw %} [width="100%",cols="2s,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description @@ -74,10 +76,12 @@ The mllp component supports 19 endpoint options which are listed below: | exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange | synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= +{% endraw %} // endpoint options: END + [[MLLP-MLLPConsumer]] MLLP Consumer ~~~~~~~~~~~~~ http://git-wip-us.apache.org/repos/asf/camel/blob/2ada6795/components/camel-mongodb-gridfs/src/main/docs/gridfs.adoc ---------------------------------------------------------------------- diff --git a/components/camel-mongodb-gridfs/src/main/docs/gridfs.adoc b/components/camel-mongodb-gridfs/src/main/docs/gridfs.adoc index 51128c8..5e1ced1 100644 --- a/components/camel-mongodb-gridfs/src/main/docs/gridfs.adoc +++ b/components/camel-mongodb-gridfs/src/main/docs/gridfs.adoc @@ -37,9 +37,11 @@ The MongoDBGridFS component has no options. + // endpoint options: START The MongoDBGridFS component supports 18 endpoint options which are listed below: +{% raw %} [width="100%",cols="2s,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description @@ -62,9 +64,11 @@ The MongoDBGridFS component supports 18 endpoint options which are listed below: | exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange | synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= +{% endraw %} // endpoint options: END + [[MongoDBGridFS-ConfigurationofdatabaseinSpringXML]] Configuration of database in Spring XML ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ http://git-wip-us.apache.org/repos/asf/camel/blob/2ada6795/components/camel-mongodb/src/main/docs/mongodb.adoc ---------------------------------------------------------------------- diff --git a/components/camel-mongodb/src/main/docs/mongodb.adoc b/components/camel-mongodb/src/main/docs/mongodb.adoc index a6032a0..8a4b54c 100644 --- a/components/camel-mongodb/src/main/docs/mongodb.adoc +++ b/components/camel-mongodb/src/main/docs/mongodb.adoc @@ -62,9 +62,11 @@ The MongoDB component has no options. + // endpoint options: START The MongoDB component supports 22 endpoint options which are listed below: +{% raw %} [width="100%",cols="2s,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description @@ -91,10 +93,12 @@ The MongoDB component supports 22 endpoint options which are listed below: | exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange | synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= +{% endraw %} // endpoint options: END + [[MongoDB-ConfigurationofdatabaseinSpringXML]] Configuration of database in Spring XML ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ http://git-wip-us.apache.org/repos/asf/camel/blob/2ada6795/components/camel-mqtt/src/main/docs/mqtt.adoc ---------------------------------------------------------------------- diff --git a/components/camel-mqtt/src/main/docs/mqtt.adoc b/components/camel-mqtt/src/main/docs/mqtt.adoc index a0ca38c..83bcadb 100644 --- a/components/camel-mqtt/src/main/docs/mqtt.adoc +++ b/components/camel-mqtt/src/main/docs/mqtt.adoc @@ -38,11 +38,13 @@ Options ^^^^^^^ + // component options: START The MQTT component supports 3 options which are listed below. +{% raw %} [width="100%",cols="2s,1m,8",options="header"] |======================================================================= | Name | Java Type | Description @@ -50,13 +52,17 @@ The MQTT component supports 3 options which are listed below. | userName | String | Username to be used for authentication against the MQTT broker | password | String | Password to be used for authentication against the MQTT broker |======================================================================= +{% endraw %} // component options: END + + // endpoint options: START The MQTT component supports 39 endpoint options which are listed below: +{% raw %} [width="100%",cols="2s,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description @@ -100,9 +106,11 @@ The MQTT component supports 39 endpoint options which are listed below: | exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange | synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= +{% endraw %} // endpoint options: END + [[MQTT-Samples]] Samples ^^^^^^^ http://git-wip-us.apache.org/repos/asf/camel/blob/2ada6795/components/camel-msv/src/main/docs/msv.adoc ---------------------------------------------------------------------- diff --git a/components/camel-msv/src/main/docs/msv.adoc b/components/camel-msv/src/main/docs/msv.adoc index c09c338..b241cfe 100644 --- a/components/camel-msv/src/main/docs/msv.adoc +++ b/components/camel-msv/src/main/docs/msv.adoc @@ -52,24 +52,30 @@ Options ^^^^^^^ + // component options: START The MSV component supports 2 options which are listed below. +{% raw %} [width="100%",cols="2s,1m,8",options="header"] |======================================================================= | Name | Java Type | Description | schemaFactory | SchemaFactory | To use the javax.xml.validation.SchemaFactory. | resourceResolverFactory | ValidatorResourceResolverFactory | To use a custom LSResourceResolver which depends on a dynamic endpoint resource URI |======================================================================= +{% endraw %} // component options: END + + // endpoint options: START The MSV component supports 13 endpoint options which are listed below: +{% raw %} [width="100%",cols="2s,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description @@ -87,9 +93,11 @@ The MSV component supports 13 endpoint options which are listed below: | useDom | advanced | false | boolean | Whether DOMSource/DOMResult or SaxSource/SaxResult should be used by the validator. | useSharedSchema | advanced | true | boolean | Whether the Schema instance should be shared or not. This option is introduced to work around a JDK 1.6.x bug. Xerces should not have this issue. |======================================================================= +{% endraw %} // endpoint options: END + [[MSV-Example]] Example ^^^^^^^ http://git-wip-us.apache.org/repos/asf/camel/blob/2ada6795/components/camel-mustache/src/main/docs/mustache.adoc ---------------------------------------------------------------------- diff --git a/components/camel-mustache/src/main/docs/mustache.adoc b/components/camel-mustache/src/main/docs/mustache.adoc index c28a668..77266d9 100644 --- a/components/camel-mustache/src/main/docs/mustache.adoc +++ b/components/camel-mustache/src/main/docs/mustache.adoc @@ -43,25 +43,31 @@ Options {% raw %} + // component options: START The Mustache component supports 1 options which are listed below. +{% raw %} [width="100%",cols="2s,1m,8",options="header"] |======================================================================= | Name | Java Type | Description | mustacheFactory | MustacheFactory | To use a custom MustacheFactory |======================================================================= +{% endraw %} // component options: END + + // endpoint options: START The Mustache component supports 7 endpoint options which are listed below: +{% raw %} [width="100%",cols="2s,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description @@ -73,7 +79,9 @@ The Mustache component supports 7 endpoint options which are listed below: | exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange | synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= +{% endraw %} // endpoint options: END + {% endraw %} http://git-wip-us.apache.org/repos/asf/camel/blob/2ada6795/components/camel-mvel/src/main/docs/mvel.adoc ---------------------------------------------------------------------- diff --git a/components/camel-mvel/src/main/docs/mvel.adoc b/components/camel-mvel/src/main/docs/mvel.adoc index 4f62b55..d4b44f8 100644 --- a/components/camel-mvel/src/main/docs/mvel.adoc +++ b/components/camel-mvel/src/main/docs/mvel.adoc @@ -48,9 +48,11 @@ The MVEL component has no options. + // endpoint options: START The MVEL component supports 5 endpoint options which are listed below: +{% raw %} [width="100%",cols="2s,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description @@ -60,9 +62,11 @@ The MVEL component supports 5 endpoint options which are listed below: | exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange | synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= +{% endraw %} // endpoint options: END + [[MVELComponent-MessageHeaders]] Message Headers ^^^^^^^^^^^^^^^ http://git-wip-us.apache.org/repos/asf/camel/blob/2ada6795/components/camel-mybatis/src/main/docs/mybatis.adoc ---------------------------------------------------------------------- diff --git a/components/camel-mybatis/src/main/docs/mybatis.adoc b/components/camel-mybatis/src/main/docs/mybatis.adoc index c3c6e10..613c87f 100644 --- a/components/camel-mybatis/src/main/docs/mybatis.adoc +++ b/components/camel-mybatis/src/main/docs/mybatis.adoc @@ -47,24 +47,30 @@ Options ^^^^^^^ + // component options: START The MyBatis component supports 2 options which are listed below. +{% raw %} [width="100%",cols="2s,1m,8",options="header"] |======================================================================= | Name | Java Type | Description | sqlSessionFactory | SqlSessionFactory | To use the SqlSessionFactory | configurationUri | String | Location of MyBatis xml configuration file. The default value is: SqlMapConfig.xml loaded from the classpath |======================================================================= +{% endraw %} // component options: END + + // endpoint options: START The MyBatis component supports 29 endpoint options which are listed below: +{% raw %} [width="100%",cols="2s,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description @@ -98,9 +104,11 @@ The MyBatis component supports 29 endpoint options which are listed below: | timeUnit | scheduler | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options. | useFixedDelay | scheduler | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. |======================================================================= +{% endraw %} // endpoint options: END + [[MyBatis-MessageHeaders]] Message Headers ^^^^^^^^^^^^^^^ http://git-wip-us.apache.org/repos/asf/camel/blob/2ada6795/components/camel-nagios/src/main/docs/nagios.adoc ---------------------------------------------------------------------- diff --git a/components/camel-nagios/src/main/docs/nagios.adoc b/components/camel-nagios/src/main/docs/nagios.adoc index 6df6382..1ea8837 100644 --- a/components/camel-nagios/src/main/docs/nagios.adoc +++ b/components/camel-nagios/src/main/docs/nagios.adoc @@ -40,23 +40,29 @@ Options ^^^^^^^ + // component options: START The Nagios component supports 1 options which are listed below. +{% raw %} [width="100%",cols="2s,1m,8",options="header"] |======================================================================= | Name | Java Type | Description | configuration | NagiosConfiguration | To use a shared NagiosConfiguration |======================================================================= +{% endraw %} // component options: END + + // endpoint options: START The Nagios component supports 9 endpoint options which are listed below: +{% raw %} [width="100%",cols="2s,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description @@ -70,9 +76,11 @@ The Nagios component supports 9 endpoint options which are listed below: | exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange | synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= +{% endraw %} // endpoint options: END + [[Nagios-Sendingmessageexamples]] Sending message examples ^^^^^^^^^^^^^^^^^^^^^^^^ http://git-wip-us.apache.org/repos/asf/camel/blob/2ada6795/components/camel-netty-http/src/main/docs/netty-http.adoc ---------------------------------------------------------------------- diff --git a/components/camel-netty-http/src/main/docs/netty-http.adoc b/components/camel-netty-http/src/main/docs/netty-http.adoc index f1c750e..9521d9c 100644 --- a/components/camel-netty-http/src/main/docs/netty-http.adoc +++ b/components/camel-netty-http/src/main/docs/netty-http.adoc @@ -78,11 +78,13 @@ when using this link:netty-http.html[Netty HTTP] component, such as options related to UDP transport. + // component options: START The Netty HTTP component supports 5 options which are listed below. +{% raw %} [width="100%",cols="2s,1m,8",options="header"] |======================================================================= | Name | Java Type | Description @@ -92,13 +94,17 @@ The Netty HTTP component supports 5 options which are listed below. | configuration | NettyConfiguration | To use the NettyConfiguration as configuration when creating endpoints. | maximumPoolSize | int | The core pool size for the ordered thread pool if its in use. The default value is 16. |======================================================================= +{% endraw %} // component options: END + + // endpoint options: START The Netty HTTP component supports 82 endpoint options which are listed below: +{% raw %} [width="100%",cols="2s,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description @@ -185,9 +191,11 @@ The Netty HTTP component supports 82 endpoint options which are listed below: | trustStoreFile | security | | File | Server side certificate keystore to be used for encryption | trustStoreResource | security | | String | Server side certificate keystore to be used for encryption. Is loaded by default from classpath but you can prefix with classpath: file: or http: to load the resource from different systems. |======================================================================= +{% endraw %} // endpoint options: END + [[NettyHTTP-MessageHeaders]] Message Headers ^^^^^^^^^^^^^^^ http://git-wip-us.apache.org/repos/asf/camel/blob/2ada6795/components/camel-netty/src/main/docs/netty.adoc ---------------------------------------------------------------------- diff --git a/components/camel-netty/src/main/docs/netty.adoc b/components/camel-netty/src/main/docs/netty.adoc index dc4a98c..a711c2e 100644 --- a/components/camel-netty/src/main/docs/netty.adoc +++ b/components/camel-netty/src/main/docs/netty.adoc @@ -58,24 +58,30 @@ Options ^^^^^^^ + // component options: START The Netty component supports 2 options which are listed below. +{% raw %} [width="100%",cols="2s,1m,8",options="header"] |======================================================================= | Name | Java Type | Description | configuration | NettyConfiguration | To use the NettyConfiguration as configuration when creating endpoints. | maximumPoolSize | int | The core pool size for the ordered thread pool if its in use. The default value is 16. |======================================================================= +{% endraw %} // component options: END + + // endpoint options: START The Netty component supports 70 endpoint options which are listed below: +{% raw %} [width="100%",cols="2s,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description @@ -150,9 +156,11 @@ The Netty component supports 70 endpoint options which are listed below: | trustStoreFile | security | | File | Server side certificate keystore to be used for encryption | trustStoreResource | security | | String | Server side certificate keystore to be used for encryption. Is loaded by default from classpath but you can prefix with classpath: file: or http: to load the resource from different systems. |======================================================================= +{% endraw %} // endpoint options: END + [[Netty-RegistrybasedOptions]] Registry based Options ^^^^^^^^^^^^^^^^^^^^^^ http://git-wip-us.apache.org/repos/asf/camel/blob/2ada6795/components/camel-netty4-http/src/main/docs/netty4-http.adoc ---------------------------------------------------------------------- diff --git a/components/camel-netty4-http/src/main/docs/netty4-http.adoc b/components/camel-netty4-http/src/main/docs/netty4-http.adoc index 9a4b320..04d70ab 100644 --- a/components/camel-netty4-http/src/main/docs/netty4-http.adoc +++ b/components/camel-netty4-http/src/main/docs/netty4-http.adoc @@ -77,11 +77,13 @@ applicable when using this Netty4 HTTP component, such as options related to UDP transport. + // component options: START The Netty4 HTTP component supports 6 options which are listed below. +{% raw %} [width="100%",cols="2s,1m,8",options="header"] |======================================================================= | Name | Java Type | Description @@ -92,13 +94,17 @@ The Netty4 HTTP component supports 6 options which are listed below. | configuration | NettyConfiguration | To use the NettyConfiguration as configuration when creating endpoints. | executorService | EventExecutorGroup | To use the given EventExecutorGroup |======================================================================= +{% endraw %} // component options: END + + // endpoint options: START The Netty4 HTTP component supports 80 endpoint options which are listed below: +{% raw %} [width="100%",cols="2s,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description @@ -183,9 +189,11 @@ The Netty4 HTTP component supports 80 endpoint options which are listed below: | trustStoreFile | security | | File | Server side certificate keystore to be used for encryption | trustStoreResource | security | | String | Server side certificate keystore to be used for encryption. Is loaded by default from classpath but you can prefix with classpath: file: or http: to load the resource from different systems. |======================================================================= +{% endraw %} // endpoint options: END + [[Netty4HTTP-MessageHeaders]] Message Headers ^^^^^^^^^^^^^^^ http://git-wip-us.apache.org/repos/asf/camel/blob/2ada6795/components/camel-netty4/src/main/docs/netty4.adoc ---------------------------------------------------------------------- diff --git a/components/camel-netty4/src/main/docs/netty4.adoc b/components/camel-netty4/src/main/docs/netty4.adoc index 4678dc8..72c2f99 100644 --- a/components/camel-netty4/src/main/docs/netty4.adoc +++ b/components/camel-netty4/src/main/docs/netty4.adoc @@ -55,11 +55,13 @@ Options ^^^^^^^ + // component options: START The Netty4 component supports 3 options which are listed below. +{% raw %} [width="100%",cols="2s,1m,8",options="header"] |======================================================================= | Name | Java Type | Description @@ -67,13 +69,17 @@ The Netty4 component supports 3 options which are listed below. | configuration | NettyConfiguration | To use the NettyConfiguration as configuration when creating endpoints. | executorService | EventExecutorGroup | To use the given EventExecutorGroup |======================================================================= +{% endraw %} // component options: END + + // endpoint options: START The Netty4 component supports 72 endpoint options which are listed below: +{% raw %} [width="100%",cols="2s,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description @@ -150,9 +156,11 @@ The Netty4 component supports 72 endpoint options which are listed below: | trustStoreFile | security | | File | Server side certificate keystore to be used for encryption | trustStoreResource | security | | String | Server side certificate keystore to be used for encryption. Is loaded by default from classpath but you can prefix with classpath: file: or http: to load the resource from different systems. |======================================================================= +{% endraw %} // endpoint options: END + [[Netty4-RegistrybasedOptions]] Registry based Options ^^^^^^^^^^^^^^^^^^^^^^ http://git-wip-us.apache.org/repos/asf/camel/blob/2ada6795/components/camel-sjms/src/main/docs/sjms-batch.adoc ---------------------------------------------------------------------- diff --git a/components/camel-sjms/src/main/docs/sjms-batch.adoc b/components/camel-sjms/src/main/docs/sjms-batch.adoc index 9b13de1..3bfaccd 100644 --- a/components/camel-sjms/src/main/docs/sjms-batch.adoc +++ b/components/camel-sjms/src/main/docs/sjms-batch.adoc @@ -114,24 +114,30 @@ Component Options and Configurations ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + // component options: START The Simple JMS Batch component supports 1 options which are listed below. +{% raw %} [width="100%",cols="2s,1m,8",options="header"] |======================================================================= | Name | Java Type | Description | connectionFactory | ConnectionFactory | A ConnectionFactory is required to enable the SjmsBatchComponent. |======================================================================= +{% endraw %} // component options: END + + // endpoint options: START The Simple JMS Batch component supports 19 endpoint options which are listed below: +{% raw %} [width="100%",cols="2s,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description @@ -155,9 +161,11 @@ The Simple JMS Batch component supports 19 endpoint options which are listed bel | synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | timeoutCheckerExecutorService | advanced | | ScheduledExecutorService | If using the completionInterval option a background thread is created to trigger the completion interval. Set this option to provide a custom thread pool to be used rather than creating a new thread for every consumer. |======================================================================= +{% endraw %} // endpoint options: END + The `completionSize` endpoint attribute is used in conjunction with `completionTimeout`, where the first condition to be met will cause the aggregated `Exchange` to be emitted down the route. http://git-wip-us.apache.org/repos/asf/camel/blob/2ada6795/components/camel-sjms/src/main/docs/sjms.adoc ---------------------------------------------------------------------- diff --git a/components/camel-sjms/src/main/docs/sjms.adoc b/components/camel-sjms/src/main/docs/sjms.adoc index 56f2e49..fa3a68d 100644 --- a/components/camel-sjms/src/main/docs/sjms.adoc +++ b/components/camel-sjms/src/main/docs/sjms.adoc @@ -101,11 +101,13 @@ Component Options and Configurations ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + // component options: START The Simple JMS component supports 9 options which are listed below. +{% raw %} [width="100%",cols="2s,1m,8",options="header"] |======================================================================= | Name | Java Type | Description @@ -119,15 +121,19 @@ The Simple JMS component supports 9 options which are listed below. | timedTaskManager | TimedTaskManager | To use a custom TimedTaskManager | messageCreatedStrategy | MessageCreatedStrategy | To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of javax.jms.Message objects when Camel is sending a JMS message. |======================================================================= +{% endraw %} // component options: END + + // endpoint options: START The Simple JMS component supports 32 endpoint options which are listed below: +{% raw %} [width="100%",cols="2s,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description @@ -164,11 +170,13 @@ The Simple JMS component supports 32 endpoint options which are listed below: | transactionBatchTimeout | transaction | 5000 | long | Sets timeout (in millis) for batch transactions the value should be 1000 or higher. | transactionCommitStrategy | transaction | | TransactionCommitStrategy | Sets the commit strategy. |======================================================================= +{% endraw %} // endpoint options: END + Below is an example of how to configure the `SjmsComponent` with its required `ConnectionFactory` provider. It will create a single connection by default and store it using the components internal pooling APIs to http://git-wip-us.apache.org/repos/asf/camel/blob/2ada6795/components/camel-twitter/src/main/docs/twitter.adoc ---------------------------------------------------------------------- diff --git a/components/camel-twitter/src/main/docs/twitter.adoc b/components/camel-twitter/src/main/docs/twitter.adoc index eb8d487..5b6dc9e 100644 --- a/components/camel-twitter/src/main/docs/twitter.adoc +++ b/components/camel-twitter/src/main/docs/twitter.adoc @@ -55,11 +55,13 @@ settings which is mandatory to configure before using. + // component options: START The Twitter component supports 8 options which are listed below. +{% raw %} [width="100%",cols="2s,1m,8",options="header"] |======================================================================= | Name | Java Type | Description @@ -72,10 +74,12 @@ The Twitter component supports 8 options which are listed below. | httpProxyPassword | String | The http proxy password which can be used for the camel-twitter. | httpProxyPort | int | The http proxy port which can be used for the camel-twitter. |======================================================================= +{% endraw %} // component options: END + You can also configure these options directly in the endpoint. [[Twitter-ConsumerEndpoints]] @@ -143,9 +147,11 @@ URI options + // endpoint options: START The Twitter component supports 43 endpoint options which are listed below: +{% raw %} [width="100%",cols="2s,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description @@ -193,12 +199,14 @@ The Twitter component supports 43 endpoint options which are listed below: | httpProxyPort | proxy | | Integer | The http proxy port which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. | httpProxyUser | proxy | | String | The http proxy user which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. |======================================================================= +{% endraw %} // endpoint options: END + [[Twitter-Messageheaders]] Message headers ^^^^^^^^^^^^^^^ http://git-wip-us.apache.org/repos/asf/camel/blob/2ada6795/components/camel-websocket/src/main/docs/websocket.adoc ---------------------------------------------------------------------- diff --git a/components/camel-websocket/src/main/docs/websocket.adoc b/components/camel-websocket/src/main/docs/websocket.adoc index 44c13cf..9343521 100644 --- a/components/camel-websocket/src/main/docs/websocket.adoc +++ b/components/camel-websocket/src/main/docs/websocket.adoc @@ -35,11 +35,13 @@ Websocket Options + // component options: START The Jetty Websocket component supports 12 options which are listed below. +{% raw %} [width="100%",cols="2s,1m,8",options="header"] |======================================================================= | Name | Java Type | Description @@ -56,6 +58,7 @@ The Jetty Websocket component supports 12 options which are listed below. | sslContextParameters | SSLContextParameters | To configure security using SSLContextParameters | socketFactory | Map | To configure a map which contains custom WebSocketFactory for sub protocols. The key in the map is the sub protocol. The default key is reserved for the default implementation. |======================================================================= +{% endraw %} // component options: END @@ -63,9 +66,12 @@ The Jetty Websocket component supports 12 options which are listed below. + + // endpoint options: START The Jetty Websocket component supports 20 endpoint options which are listed below: +{% raw %} [width="100%",cols="2s,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description @@ -90,8 +96,10 @@ The Jetty Websocket component supports 20 endpoint options which are listed belo | exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange | synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= +{% endraw %} // endpoint options: END +  [[Websocket-MessageHeaders]] http://git-wip-us.apache.org/repos/asf/camel/blob/2ada6795/components/camel-xmlsecurity/src/main/docs/xmlsecurity.adoc ---------------------------------------------------------------------- diff --git a/components/camel-xmlsecurity/src/main/docs/xmlsecurity.adoc b/components/camel-xmlsecurity/src/main/docs/xmlsecurity.adoc index 7978402..c40d1a3 100644 --- a/components/camel-xmlsecurity/src/main/docs/xmlsecurity.adoc +++ b/components/camel-xmlsecurity/src/main/docs/xmlsecurity.adoc @@ -231,28 +231,34 @@ Component Options ^^^^^^^^^^^^^^^^ + // component options: START The XML Security component supports 2 options which are listed below. +{% raw %} [width="100%",cols="2s,1m,8",options="header"] |======================================================================= | Name | Java Type | Description | signerConfiguration | XmlSignerConfiguration | To use a shared XmlSignerConfiguration configuration to use as base for configuring endpoints. | verifierConfiguration | XmlVerifierConfiguration | To use a shared XmlVerifierConfiguration configuration to use as base for configuring endpoints. |======================================================================= +{% endraw %} // component options: END + [[XMLSecuritycomponent-EndpointOptions]] Endpoint Options ^^^^^^^^^^^^^^^^ + // endpoint options: START The XML Security component supports 38 endpoint options which are listed below: +{% raw %} [width="100%",cols="2s,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description @@ -295,9 +301,11 @@ The XML Security component supports 38 endpoint options which are listed below: | xmlSignature2Message | verify | | XmlSignature2Message | Bean which maps the XML signature to the output-message after the validation. How this mapping should be done can be configured by the options outputNodeSearchType outputNodeSearch and removeSignatureElements. The default implementation offers three possibilities which are related to the three output node search types Default ElementName and XPath. The default implementation determines a node which is then serialized and set to the body of the output message If the search type is ElementName then the output node (which must be in this case an element) is determined by the local name and namespace defined in the search value (see option outputNodeSearch). If the search type is XPath then the output node is determined by the XPath specified in the search value (in this case the output node can be of type Element TextNode or Document). If the output node search type is Default then the following rules apply: In the enveloped X ML signature case (there is a reference with URI= and transform http://www.w3.org/2000/09/xmldsigenveloped-signature) the incoming XML document without the Signature element is set to the output message body. In the non-enveloped XML signature case the message body is determined from a referenced Object; this is explained in more detail in chapter Output Node Determination in Enveloping XML Signature Case. | xmlSignatureChecker | verify | | XmlSignatureChecker | This interface allows the application to check the XML signature before the validation is executed. This step is recommended in http://www.w3.org/TR/xmldsig-bestpractices/check-what-is-signed |======================================================================= +{% endraw %} // endpoint options: END + [[XMLSecuritycomponent-OutputNodeDeterminationinEnvelopingXMLSignatureCase]] Output Node Determination in Enveloping XML Signature Case ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ http://git-wip-us.apache.org/repos/asf/camel/blob/2ada6795/components/camel-yammer/src/main/docs/yammer.adoc ---------------------------------------------------------------------- diff --git a/components/camel-yammer/src/main/docs/yammer.adoc b/components/camel-yammer/src/main/docs/yammer.adoc index 65ac601..36532c6 100644 --- a/components/camel-yammer/src/main/docs/yammer.adoc +++ b/components/camel-yammer/src/main/docs/yammer.adoc @@ -44,11 +44,13 @@ The Yammer component can be configured with the Yammer account settings which are mandatory to configure before using. + // component options: START The Yammer component supports 4 options which are listed below. +{% raw %} [width="100%",cols="2s,1m,8",options="header"] |======================================================================= | Name | Java Type | Description @@ -57,9 +59,11 @@ The Yammer component supports 4 options which are listed below. | accessToken | String | The access token | config | YammerConfiguration | To use a shared yammer configuration |======================================================================= +{% endraw %} // component options: END + You can also configure these options directly in the endpoint. [[Yammer-EndpointOptions]] @@ -67,9 +71,11 @@ Endpoint options ^^^^^^^^^^^^^^^^^ + // endpoint options: START The Yammer component supports 29 endpoint options which are listed below: +{% raw %} [width="100%",cols="2s,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description @@ -103,10 +109,12 @@ The Yammer component supports 29 endpoint options which are listed below: | timeUnit | scheduler | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options. | useFixedDelay | scheduler | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. |======================================================================= +{% endraw %} // endpoint options: END + [[Yammer-Consumingmessages]] Consuming messages ^^^^^^^^^^^^^^^^^^ http://git-wip-us.apache.org/repos/asf/camel/blob/2ada6795/components/camel-zookeeper/src/main/docs/zookeeper.adoc ---------------------------------------------------------------------- diff --git a/components/camel-zookeeper/src/main/docs/zookeeper.adoc b/components/camel-zookeeper/src/main/docs/zookeeper.adoc index e0cbfc4..6b94438 100644 --- a/components/camel-zookeeper/src/main/docs/zookeeper.adoc +++ b/components/camel-zookeeper/src/main/docs/zookeeper.adoc @@ -54,9 +54,11 @@ _znode_) that will be the target of the endpoint: Options ^^^^^^^ + // endpoint options: START The ZooKeeper component supports 14 endpoint options which are listed below: +{% raw %} [width="100%",cols="2s,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description @@ -75,8 +77,10 @@ The ZooKeeper component supports 14 endpoint options which are listed below: | exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange | synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= +{% endraw %} // endpoint options: END + [[Zookeeper-Usecases]] Use cases ^^^^^^^^^
