This is an automated email from the ASF dual-hosted git repository. acosentino pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/master by this push: new 6d1e848 CAMEL:13111 (#2752) 6d1e848 is described below commit 6d1e848d436438b7c09c6e60a0550f92abaecde6 Author: bwesterfield <bwesterfi...@gmail.com> AuthorDate: Thu Feb 7 11:02:46 2019 -0500 CAMEL:13111 (#2752) * merge * merge upstream * CAMEL:13111 : addition of spring boot markers in documentation files * CAMEL-13111 Regeneration of Docs --- .../src/main/docs/browse-component.adoc | 15 +++++++++++ .../src/main/docs/controlbus-component.adoc | 16 +++++++++++ .../src/main/docs/dataformat-component.adoc | 15 +++++++++++ .../src/main/docs/direct-component.adoc | 17 ++++++++++++ .../camel-file/src/main/docs/file-component.adoc | 16 +++++++++++ .../src/main/docs/jclouds-component.adoc | 20 ++++++++++++++ .../src/main/docs/language-component.adoc | 15 +++++++++++ .../camel-log/src/main/docs/log-component.adoc | 16 +++++++++++ .../src/main/docs/properties-component.adoc | 31 ++++++++++++++++++++++ .../camel-ref/src/main/docs/ref-component.adoc | 15 +++++++++++ .../src/main/docs/rest-api-component.adoc | 15 +++++++++++ .../camel-rest/src/main/docs/rest-component.adoc | 19 +++++++++++++ .../camel-saga/src/main/docs/saga-component.adoc | 16 +++++++++++ .../src/main/docs/scheduler-component.adoc | 16 +++++++++++ .../camel-seda/src/main/docs/seda-component.adoc | 20 ++++++++++++++ .../camel-stub/src/main/docs/stub-component.adoc | 20 ++++++++++++++ .../camel-timer/src/main/docs/timer-component.adoc | 15 +++++++++++ .../src/main/docs/validator-component.adoc | 16 +++++++++++ .../camel-vm/src/main/docs/vm-component.adoc | 20 ++++++++++++++ .../camel-xslt/src/main/docs/xslt-component.adoc | 22 +++++++++++++++ .../modules/ROOT/pages/browse-component.adoc | 15 +++++++++++ .../modules/ROOT/pages/controlbus-component.adoc | 16 +++++++++++ .../modules/ROOT/pages/dataformat-component.adoc | 15 +++++++++++ .../modules/ROOT/pages/direct-component.adoc | 17 ++++++++++++ .../modules/ROOT/pages/file-component.adoc | 16 +++++++++++ .../modules/ROOT/pages/jclouds-component.adoc | 20 ++++++++++++++ .../modules/ROOT/pages/language-component.adoc | 15 +++++++++++ .../modules/ROOT/pages/log-component.adoc | 16 +++++++++++ .../modules/ROOT/pages/properties-component.adoc | 31 ++++++++++++++++++++++ .../modules/ROOT/pages/ref-component.adoc | 15 +++++++++++ .../modules/ROOT/pages/rest-api-component.adoc | 15 +++++++++++ .../modules/ROOT/pages/rest-component.adoc | 19 +++++++++++++ .../modules/ROOT/pages/saga-component.adoc | 16 +++++++++++ .../modules/ROOT/pages/scheduler-component.adoc | 16 +++++++++++ .../modules/ROOT/pages/seda-component.adoc | 20 ++++++++++++++ .../modules/ROOT/pages/stub-component.adoc | 20 ++++++++++++++ .../modules/ROOT/pages/timer-component.adoc | 15 +++++++++++ .../modules/ROOT/pages/validator-component.adoc | 16 +++++++++++ .../modules/ROOT/pages/vm-component.adoc | 20 ++++++++++++++ .../modules/ROOT/pages/xslt-component.adoc | 22 +++++++++++++++ 40 files changed, 710 insertions(+) diff --git a/components/camel-browse/src/main/docs/browse-component.adoc b/components/camel-browse/src/main/docs/browse-component.adoc index ff74a03..ef470f5 100644 --- a/components/camel-browse/src/main/docs/browse-component.adoc +++ b/components/camel-browse/src/main/docs/browse-component.adoc @@ -59,6 +59,21 @@ with the following path and query parameters: |=== // endpoint options: END +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 2 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.component.browse.enabled* | Whether to enable auto configuration of the browse component. This is enabled by default. | | Boolean +| *camel.component.browse.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean +|=== +// spring-boot-auto-configure options: END === Sample diff --git a/components/camel-controlbus/src/main/docs/controlbus-component.adoc b/components/camel-controlbus/src/main/docs/controlbus-component.adoc index 593dd00..41c100b 100644 --- a/components/camel-controlbus/src/main/docs/controlbus-component.adoc +++ b/components/camel-controlbus/src/main/docs/controlbus-component.adoc @@ -106,6 +106,22 @@ with the following path and query parameters: You can append query options to the URI in the following format, `?option=value&option=value&...` +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 2 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.component.controlbus.enabled* | Whether to enable auto configuration of the controlbus component. This is enabled by default. | | Boolean +| *camel.component.controlbus.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean +|=== +// spring-boot-auto-configure options: END + === Using route command diff --git a/components/camel-dataformat/src/main/docs/dataformat-component.adoc b/components/camel-dataformat/src/main/docs/dataformat-component.adoc index bb97bbd..f13804f 100644 --- a/components/camel-dataformat/src/main/docs/dataformat-component.adoc +++ b/components/camel-dataformat/src/main/docs/dataformat-component.adoc @@ -58,6 +58,21 @@ with the following path and query parameters: |=== // endpoint options: END +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 2 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.component.dataformat.enabled* | Whether to enable auto configuration of the dataformat component. This is enabled by default. | | Boolean +| *camel.component.dataformat.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean +|=== +// spring-boot-auto-configure options: END === Samples diff --git a/components/camel-direct/src/main/docs/direct-component.adoc b/components/camel-direct/src/main/docs/direct-component.adoc index c83e5c7..b56dc4b 100644 --- a/components/camel-direct/src/main/docs/direct-component.adoc +++ b/components/camel-direct/src/main/docs/direct-component.adoc @@ -81,6 +81,23 @@ with the following path and query parameters: |=== // endpoint options: END +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 4 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.component.direct.block* | If sending a message to a direct endpoint which has no active consumer, then we can tell the producer to block and wait for the consumer to become active. | true | Boolean +| *camel.component.direct.enabled* | Whether to enable auto configuration of the direct component. This is enabled by default. | | Boolean +| *camel.component.direct.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean +| *camel.component.direct.timeout* | The timeout value to use if block is enabled. | 30000 | Long +|=== +// spring-boot-auto-configure options: END === Samples diff --git a/components/camel-file/src/main/docs/file-component.adoc b/components/camel-file/src/main/docs/file-component.adoc index 6f0865b..652c29a 100644 --- a/components/camel-file/src/main/docs/file-component.adoc +++ b/components/camel-file/src/main/docs/file-component.adoc @@ -171,6 +171,22 @@ with the following path and query parameters: TIP: *Default behavior for file producer* By default it will override any existing file, if one exist with the same name. +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 2 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.component.file.enabled* | Whether to enable auto configuration of the file component. This is enabled by default. | | Boolean +| *camel.component.file.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean +|=== +// spring-boot-auto-configure options: END + === Move and Delete operations Any move or delete operations is executed after (post command) the diff --git a/components/camel-jclouds/src/main/docs/jclouds-component.adoc b/components/camel-jclouds/src/main/docs/jclouds-component.adoc index 77b097f..936c2eb 100644 --- a/components/camel-jclouds/src/main/docs/jclouds-component.adoc +++ b/components/camel-jclouds/src/main/docs/jclouds-component.adoc @@ -177,6 +177,26 @@ jclouds:blobstore:aws-s3?operation=CamelJcloudsGet&container=mycontainer&blobNam For producer endpoint you can override all of the above URI options by passing the appropriate headers to the message. + +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 4 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.component.jclouds.blob-stores* | To use the given BlobStore which must be configured when using blobstore. | | List +| *camel.component.jclouds.compute-services* | To use the given ComputeService which must be configured when use compute. | | List +| *camel.component.jclouds.enabled* | Whether to enable auto configuration of the jclouds component. This is enabled by default. | | Boolean +| *camel.component.jclouds.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean +|=== +// spring-boot-auto-configure options: END + + #### Message Headers for blobstore [width="100%",cols="10%,90%",options="header",] diff --git a/components/camel-language/src/main/docs/language-component.adoc b/components/camel-language/src/main/docs/language-component.adoc index 96777b4..89f89bd 100644 --- a/components/camel-language/src/main/docs/language-component.adoc +++ b/components/camel-language/src/main/docs/language-component.adoc @@ -77,6 +77,21 @@ with the following path and query parameters: |=== // endpoint options: END +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 2 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.component.language.enabled* | Whether to enable auto configuration of the language component. This is enabled by default. | | Boolean +| *camel.component.language.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean +|=== +// spring-boot-auto-configure options: END === Message Headers diff --git a/components/camel-log/src/main/docs/log-component.adoc b/components/camel-log/src/main/docs/log-component.adoc index 42e2cc1d..5b305c1 100644 --- a/components/camel-log/src/main/docs/log-component.adoc +++ b/components/camel-log/src/main/docs/log-component.adoc @@ -124,6 +124,22 @@ with the following path and query parameters: |=== // endpoint options: END +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 3 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.component.log.enabled* | Whether to enable auto configuration of the log component. This is enabled by default. | | Boolean +| *camel.component.log.exchange-formatter* | Sets a custom ExchangeFormatter to convert the Exchange to a String suitable for logging. If not specified, we default to DefaultExchangeFormatter. The option is a org.apache.camel.spi.ExchangeFormatter type. | | String +| *camel.component.log.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean +|=== +// spring-boot-auto-configure options: END === Regular logger sample diff --git a/components/camel-properties/src/main/docs/properties-component.adoc b/components/camel-properties/src/main/docs/properties-component.adoc index 8016672..45c4975 100644 --- a/components/camel-properties/src/main/docs/properties-component.adoc +++ b/components/camel-properties/src/main/docs/properties-component.adoc @@ -77,6 +77,37 @@ with the following path and query parameters: |=== // endpoint options: END +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 18 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.component.properties.cache* | Whether or not to cache loaded properties. The default value is true. | true | Boolean +| *camel.component.properties.default-fallback-enabled* | If false, the component does not attempt to find a default for the key by looking after the colon separator. | true | Boolean +| *camel.component.properties.enabled* | Whether to enable auto configuration of the properties component. This is enabled by default. | | Boolean +| *camel.component.properties.encoding* | Encoding to use when loading properties file from the file system or classpath. If no encoding has been set, then the properties files is loaded using ISO-8859-1 encoding (latin-1) as documented by java.util.Properties#load(java.io.InputStream) | | String +| *camel.component.properties.fallback-to-unaugmented-property* | If true, first attempt resolution of property name augmented with propertyPrefix and propertySuffix before falling back the plain property name specified. If false, only the augmented property name is searched. | true | Boolean +| *camel.component.properties.ignore-missing-location* | Whether to silently ignore if a location cannot be located, such as a properties file not found. | false | Boolean +| *camel.component.properties.initial-properties* | Sets initial properties which will be used before any locations are resolved. The option is a java.util.Properties type. | | String +| *camel.component.properties.location* | A list of locations to load properties. You can use comma to separate multiple locations. This option will override any default locations and only use the locations from this option. | | String +| *camel.component.properties.locations* | A list of locations to load properties. This option will override any default locations and only use the locations from this option. | | List +| *camel.component.properties.override-properties* | Sets a special list of override properties that take precedence and will use first, if a property exist. The option is a java.util.Properties type. | | String +| *camel.component.properties.prefix-token* | Sets the value of the prefix token used to identify properties to replace. Setting a value of null restores the default token (link DEFAULT_PREFIX_TOKEN). | {{ | String +| *camel.component.properties.properties-parser* | To use a custom PropertiesParser. The option is a org.apache.camel.component.properties.PropertiesParser type. | | String +| *camel.component.properties.properties-resolver* | To use a custom PropertiesResolver. The option is a org.apache.camel.component.properties.PropertiesResolver type. | | String +| *camel.component.properties.property-prefix* | Optional prefix prepended to property names before resolution. | | String +| *camel.component.properties.property-suffix* | Optional suffix appended to property names before resolution. | | String +| *camel.component.properties.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean +| *camel.component.properties.suffix-token* | Sets the value of the suffix token used to identify properties to replace. Setting a value of null restores the default token (link DEFAULT_SUFFIX_TOKEN). | }} | String +| *camel.component.properties.system-properties-mode* | Sets the system property mode. | 2 | Integer +|=== +// spring-boot-auto-configure options: END [TIP] **Resolving property from Java code** + diff --git a/components/camel-ref/src/main/docs/ref-component.adoc b/components/camel-ref/src/main/docs/ref-component.adoc index ed6bf0a..6f97711 100644 --- a/components/camel-ref/src/main/docs/ref-component.adoc +++ b/components/camel-ref/src/main/docs/ref-component.adoc @@ -57,6 +57,21 @@ with the following path and query parameters: |=== // endpoint options: END +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 2 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.component.ref.enabled* | Whether to enable auto configuration of the ref component. This is enabled by default. | | Boolean +| *camel.component.ref.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean +|=== +// spring-boot-auto-configure options: END === Runtime lookup diff --git a/components/camel-rest/src/main/docs/rest-api-component.adoc b/components/camel-rest/src/main/docs/rest-api-component.adoc index 69fefaf..0d7e3b7 100644 --- a/components/camel-rest/src/main/docs/rest-api-component.adoc +++ b/components/camel-rest/src/main/docs/rest-api-component.adoc @@ -49,6 +49,21 @@ with the following path and query parameters: |=== // endpoint options: END +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 2 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.component.rest-api.enabled* | Whether to enable auto configuration of the rest-api component. This is enabled by default. | | Boolean +| *camel.component.rest-api.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean +|=== +// spring-boot-auto-configure options: END === See Also diff --git a/components/camel-rest/src/main/docs/rest-component.adoc b/components/camel-rest/src/main/docs/rest-component.adoc index 3f43e1d..2bdad75 100644 --- a/components/camel-rest/src/main/docs/rest-component.adoc +++ b/components/camel-rest/src/main/docs/rest-component.adoc @@ -78,6 +78,25 @@ with the following path and query parameters: |=== // endpoint options: END +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 5 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.component.rest.api-doc* | The swagger api doc resource to use. The resource is loaded from classpath by default and must be in JSon format. | | String +| *camel.component.rest.component-name* | The Camel Rest component to use for the REST transport, such as restlet, spark-rest. If no component has been explicit configured, then Camel will lookup if there is a Camel component that integrates with the Rest DSL, or if a org.apache.camel.spi.RestConsumerFactory (consumer) or org.apache.camel.spi.RestProducerFactory (producer) is registered in the registry. If either one is found, then that is being used. | | String +| *camel.component.rest.enabled* | Whether to enable auto configuration of the rest component. This is enabled by default. | | Boolean +| *camel.component.rest.host* | Host and port of HTTP service to use (override host in swagger schema) | | String +| *camel.component.rest.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean +|=== +// spring-boot-auto-configure options: END + === Supported rest components The following components support rest consumer (Rest DSL): diff --git a/components/camel-saga/src/main/docs/saga-component.adoc b/components/camel-saga/src/main/docs/saga-component.adoc index 531c8b5..a508735 100644 --- a/components/camel-saga/src/main/docs/saga-component.adoc +++ b/components/camel-saga/src/main/docs/saga-component.adoc @@ -52,3 +52,19 @@ with the following path and query parameters: | *synchronous* (advanced) | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | boolean |=== // endpoint options: END + +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 2 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.component.saga.enabled* | Whether to enable auto configuration of the saga component. This is enabled by default. | | Boolean +| *camel.component.saga.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean +|=== +// spring-boot-auto-configure options: END diff --git a/components/camel-scheduler/src/main/docs/scheduler-component.adoc b/components/camel-scheduler/src/main/docs/scheduler-component.adoc index daaba42..9ffdd07 100644 --- a/components/camel-scheduler/src/main/docs/scheduler-component.adoc +++ b/components/camel-scheduler/src/main/docs/scheduler-component.adoc @@ -93,6 +93,22 @@ with the following path and query parameters: |=== // endpoint options: END +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 3 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.component.scheduler.concurrent-tasks* | Number of threads used by the scheduling thread pool. Is by default using a single thread | 1 | Integer +| *camel.component.scheduler.enabled* | Whether to enable auto configuration of the scheduler component. This is enabled by default. | | Boolean +| *camel.component.scheduler.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean +|=== +// spring-boot-auto-configure options: END === More information diff --git a/components/camel-seda/src/main/docs/seda-component.adoc b/components/camel-seda/src/main/docs/seda-component.adoc index 642218a..96fabde 100644 --- a/components/camel-seda/src/main/docs/seda-component.adoc +++ b/components/camel-seda/src/main/docs/seda-component.adoc @@ -101,6 +101,26 @@ with the following path and query parameters: |=== // endpoint options: END +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 7 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.component.seda.concurrent-consumers* | Sets the default number of concurrent threads processing exchanges. | 1 | Integer +| *camel.component.seda.default-block-when-full* | Whether a thread that sends messages to a full SEDA queue will block until the queue's capacity is no longer exhausted. By default, an exception will be thrown stating that the queue is full. By enabling this option, the calling thread will instead block and wait until the message can be accepted. | false | Boolean +| *camel.component.seda.default-offer-timeout* | Whether a thread that sends messages to a full SEDA queue will block until the queue's capacity is no longer exhausted. By default, an exception will be thrown stating that the queue is full. By enabling this option, where a configured timeout can be added to the block case. Utilizing the .offer(timeout) method of the underlining java queue | | Long +| *camel.component.seda.default-queue-factory* | Sets the default queue factory. The option is a org.apache.camel.component .seda.BlockingQueueFactory<org.apache.camel.Exchange> type. | | String +| *camel.component.seda.enabled* | Whether to enable auto configuration of the seda component. This is enabled by default. | | Boolean +| *camel.component.seda.queue-size* | Sets the default maximum capacity of the SEDA queue (i.e., the number of messages it can hold). | 1000 | Integer +| *camel.component.seda.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean +|=== +// spring-boot-auto-configure options: END === Choosing BlockingQueue implementation diff --git a/components/camel-stub/src/main/docs/stub-component.adoc b/components/camel-stub/src/main/docs/stub-component.adoc index f3d2098..1717337 100644 --- a/components/camel-stub/src/main/docs/stub-component.adoc +++ b/components/camel-stub/src/main/docs/stub-component.adoc @@ -91,6 +91,26 @@ with the following path and query parameters: |=== // endpoint options: END +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 7 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.component.stub.concurrent-consumers* | Sets the default number of concurrent threads processing exchanges. | 1 | Integer +| *camel.component.stub.default-block-when-full* | Whether a thread that sends messages to a full SEDA queue will block until the queue's capacity is no longer exhausted. By default, an exception will be thrown stating that the queue is full. By enabling this option, the calling thread will instead block and wait until the message can be accepted. | false | Boolean +| *camel.component.stub.default-offer-timeout* | Whether a thread that sends messages to a full SEDA queue will block until the queue's capacity is no longer exhausted. By default, an exception will be thrown stating that the queue is full. By enabling this option, where a configured timeout can be added to the block case. Utilizing the .offer(timeout) method of the underlining java queue | | Long +| *camel.component.stub.default-queue-factory* | Sets the default queue factory. The option is a org.apache.camel.component .seda.BlockingQueueFactory<org.apache.camel.Exchange> type. | | String +| *camel.component.stub.enabled* | Whether to enable auto configuration of the stub component. This is enabled by default. | | Boolean +| *camel.component.stub.queue-size* | Sets the default maximum capacity of the SEDA queue (i.e., the number of messages it can hold). | 1000 | Integer +| *camel.component.stub.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean +|=== +// spring-boot-auto-configure options: END === Examples diff --git a/components/camel-timer/src/main/docs/timer-component.adoc b/components/camel-timer/src/main/docs/timer-component.adoc index 8b435f2..9986c3e 100644 --- a/components/camel-timer/src/main/docs/timer-component.adoc +++ b/components/camel-timer/src/main/docs/timer-component.adoc @@ -80,6 +80,21 @@ with the following path and query parameters: |=== // endpoint options: END +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 2 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.component.timer.enabled* | Whether to enable auto configuration of the timer component. This is enabled by default. | | Boolean +| *camel.component.timer.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean +|=== +// spring-boot-auto-configure options: END === Exchange Properties diff --git a/components/camel-validator/src/main/docs/validator-component.adoc b/components/camel-validator/src/main/docs/validator-component.adoc index 41004cf..d273078 100644 --- a/components/camel-validator/src/main/docs/validator-component.adoc +++ b/components/camel-validator/src/main/docs/validator-component.adoc @@ -104,6 +104,22 @@ with the following path and query parameters: |=== // endpoint options: END +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 3 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.component.validator.enabled* | Whether to enable auto configuration of the validator component. This is enabled by default. | | Boolean +| *camel.component.validator.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean +| *camel.component.validator.resource-resolver-factory* | To use a custom LSResourceResolver which depends on a dynamic endpoint resource URI. The option is a org.apache.camel.component.validator.ValidatorResourceResolverFactory type. | | String +|=== +// spring-boot-auto-configure options: END === Example diff --git a/components/camel-vm/src/main/docs/vm-component.adoc b/components/camel-vm/src/main/docs/vm-component.adoc index 64b967f..77a6c18 100644 --- a/components/camel-vm/src/main/docs/vm-component.adoc +++ b/components/camel-vm/src/main/docs/vm-component.adoc @@ -121,6 +121,26 @@ with the following path and query parameters: |=== // endpoint options: END +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 7 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.component.vm.concurrent-consumers* | Sets the default number of concurrent threads processing exchanges. | 1 | Integer +| *camel.component.vm.default-block-when-full* | Whether a thread that sends messages to a full SEDA queue will block until the queue's capacity is no longer exhausted. By default, an exception will be thrown stating that the queue is full. By enabling this option, the calling thread will instead block and wait until the message can be accepted. | false | Boolean +| *camel.component.vm.default-offer-timeout* | Whether a thread that sends messages to a full SEDA queue will block until the queue's capacity is no longer exhausted. By default, an exception will be thrown stating that the queue is full. By enabling this option, where a configured timeout can be added to the block case. Utilizing the .offer(timeout) method of the underlining java queue | | Long +| *camel.component.vm.default-queue-factory* | Sets the default queue factory. The option is a org.apache.camel.component .seda.BlockingQueueFactory<org.apache.camel.Exchange> type. | | String +| *camel.component.vm.enabled* | Whether to enable auto configuration of the vm component. This is enabled by default. | | Boolean +| *camel.component.vm.queue-size* | Sets the default maximum capacity of the SEDA queue (i.e., the number of messages it can hold). | 1000 | Integer +| *camel.component.vm.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean +|=== +// spring-boot-auto-configure options: END See the <<seda-component,Seda>> component for options and other important usage details as the same rules apply to the <<vm-component,Vm>> component. diff --git a/components/camel-xslt/src/main/docs/xslt-component.adoc b/components/camel-xslt/src/main/docs/xslt-component.adoc index 415e578..e0f6e25 100644 --- a/components/camel-xslt/src/main/docs/xslt-component.adoc +++ b/components/camel-xslt/src/main/docs/xslt-component.adoc @@ -117,6 +117,28 @@ with the following path and query parameters: |=== // endpoint options: END +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 9 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.component.xslt.content-cache* | Cache for the resource content (the stylesheet file) when it is loaded. If set to false Camel will reload the stylesheet file on each message processing. This is good for development. A cached stylesheet can be forced to reload at runtime via JMX using the clearCachedStylesheet operation. | true | Boolean +| *camel.component.xslt.enabled* | Whether to enable auto configuration of the xslt component. This is enabled by default. | | Boolean +| *camel.component.xslt.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean +| *camel.component.xslt.saxon* | Whether to use Saxon as the transformerFactoryClass. If enabled then the class net.sf.saxon.TransformerFactoryImpl. You would need to add Saxon to the classpath. | false | Boolean +| *camel.component.xslt.saxon-configuration* | To use a custom Saxon configuration. The option is a java.lang.Object type. | | String +| *camel.component.xslt.saxon-configuration-properties* | To set custom Saxon configuration properties. The option is a java.util.Map<java.lang.String,java.lang.Object> type. | | String +| *camel.component.xslt.saxon-extension-functions* | Allows you to use a custom net.sf.saxon.lib.ExtensionFunctionDefinition. You would need to add camel-saxon to the classpath. The function is looked up in the registry, where you can comma to separate multiple values to lookup. | | String +| *camel.component.xslt.uri-resolver* | To use a custom UriResolver. Should not be used together with the option 'uriResolverFactory'. The option is a javax.xml.transform.URIResolver type. | | String +| *camel.component.xslt.uri-resolver-factory* | To use a custom UriResolver which depends on a dynamic endpoint resource URI. Should not be used together with the option 'uriResolver'. The option is a org.apache.camel.component.xslt.XsltUriResolverFactory type. | | String +|=== +// spring-boot-auto-configure options: END === Using XSLT endpoints diff --git a/docs/components/modules/ROOT/pages/browse-component.adoc b/docs/components/modules/ROOT/pages/browse-component.adoc index ff74a03..ef470f5 100644 --- a/docs/components/modules/ROOT/pages/browse-component.adoc +++ b/docs/components/modules/ROOT/pages/browse-component.adoc @@ -59,6 +59,21 @@ with the following path and query parameters: |=== // endpoint options: END +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 2 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.component.browse.enabled* | Whether to enable auto configuration of the browse component. This is enabled by default. | | Boolean +| *camel.component.browse.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean +|=== +// spring-boot-auto-configure options: END === Sample diff --git a/docs/components/modules/ROOT/pages/controlbus-component.adoc b/docs/components/modules/ROOT/pages/controlbus-component.adoc index 593dd00..41c100b 100644 --- a/docs/components/modules/ROOT/pages/controlbus-component.adoc +++ b/docs/components/modules/ROOT/pages/controlbus-component.adoc @@ -106,6 +106,22 @@ with the following path and query parameters: You can append query options to the URI in the following format, `?option=value&option=value&...` +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 2 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.component.controlbus.enabled* | Whether to enable auto configuration of the controlbus component. This is enabled by default. | | Boolean +| *camel.component.controlbus.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean +|=== +// spring-boot-auto-configure options: END + === Using route command diff --git a/docs/components/modules/ROOT/pages/dataformat-component.adoc b/docs/components/modules/ROOT/pages/dataformat-component.adoc index bb97bbd..f13804f 100644 --- a/docs/components/modules/ROOT/pages/dataformat-component.adoc +++ b/docs/components/modules/ROOT/pages/dataformat-component.adoc @@ -58,6 +58,21 @@ with the following path and query parameters: |=== // endpoint options: END +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 2 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.component.dataformat.enabled* | Whether to enable auto configuration of the dataformat component. This is enabled by default. | | Boolean +| *camel.component.dataformat.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean +|=== +// spring-boot-auto-configure options: END === Samples diff --git a/docs/components/modules/ROOT/pages/direct-component.adoc b/docs/components/modules/ROOT/pages/direct-component.adoc index c83e5c7..b56dc4b 100644 --- a/docs/components/modules/ROOT/pages/direct-component.adoc +++ b/docs/components/modules/ROOT/pages/direct-component.adoc @@ -81,6 +81,23 @@ with the following path and query parameters: |=== // endpoint options: END +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 4 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.component.direct.block* | If sending a message to a direct endpoint which has no active consumer, then we can tell the producer to block and wait for the consumer to become active. | true | Boolean +| *camel.component.direct.enabled* | Whether to enable auto configuration of the direct component. This is enabled by default. | | Boolean +| *camel.component.direct.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean +| *camel.component.direct.timeout* | The timeout value to use if block is enabled. | 30000 | Long +|=== +// spring-boot-auto-configure options: END === Samples diff --git a/docs/components/modules/ROOT/pages/file-component.adoc b/docs/components/modules/ROOT/pages/file-component.adoc index 6f0865b..652c29a 100644 --- a/docs/components/modules/ROOT/pages/file-component.adoc +++ b/docs/components/modules/ROOT/pages/file-component.adoc @@ -171,6 +171,22 @@ with the following path and query parameters: TIP: *Default behavior for file producer* By default it will override any existing file, if one exist with the same name. +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 2 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.component.file.enabled* | Whether to enable auto configuration of the file component. This is enabled by default. | | Boolean +| *camel.component.file.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean +|=== +// spring-boot-auto-configure options: END + === Move and Delete operations Any move or delete operations is executed after (post command) the diff --git a/docs/components/modules/ROOT/pages/jclouds-component.adoc b/docs/components/modules/ROOT/pages/jclouds-component.adoc index 77b097f..936c2eb 100644 --- a/docs/components/modules/ROOT/pages/jclouds-component.adoc +++ b/docs/components/modules/ROOT/pages/jclouds-component.adoc @@ -177,6 +177,26 @@ jclouds:blobstore:aws-s3?operation=CamelJcloudsGet&container=mycontainer&blobNam For producer endpoint you can override all of the above URI options by passing the appropriate headers to the message. + +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 4 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.component.jclouds.blob-stores* | To use the given BlobStore which must be configured when using blobstore. | | List +| *camel.component.jclouds.compute-services* | To use the given ComputeService which must be configured when use compute. | | List +| *camel.component.jclouds.enabled* | Whether to enable auto configuration of the jclouds component. This is enabled by default. | | Boolean +| *camel.component.jclouds.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean +|=== +// spring-boot-auto-configure options: END + + #### Message Headers for blobstore [width="100%",cols="10%,90%",options="header",] diff --git a/docs/components/modules/ROOT/pages/language-component.adoc b/docs/components/modules/ROOT/pages/language-component.adoc index 96777b4..89f89bd 100644 --- a/docs/components/modules/ROOT/pages/language-component.adoc +++ b/docs/components/modules/ROOT/pages/language-component.adoc @@ -77,6 +77,21 @@ with the following path and query parameters: |=== // endpoint options: END +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 2 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.component.language.enabled* | Whether to enable auto configuration of the language component. This is enabled by default. | | Boolean +| *camel.component.language.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean +|=== +// spring-boot-auto-configure options: END === Message Headers diff --git a/docs/components/modules/ROOT/pages/log-component.adoc b/docs/components/modules/ROOT/pages/log-component.adoc index 42e2cc1d..5b305c1 100644 --- a/docs/components/modules/ROOT/pages/log-component.adoc +++ b/docs/components/modules/ROOT/pages/log-component.adoc @@ -124,6 +124,22 @@ with the following path and query parameters: |=== // endpoint options: END +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 3 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.component.log.enabled* | Whether to enable auto configuration of the log component. This is enabled by default. | | Boolean +| *camel.component.log.exchange-formatter* | Sets a custom ExchangeFormatter to convert the Exchange to a String suitable for logging. If not specified, we default to DefaultExchangeFormatter. The option is a org.apache.camel.spi.ExchangeFormatter type. | | String +| *camel.component.log.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean +|=== +// spring-boot-auto-configure options: END === Regular logger sample diff --git a/docs/components/modules/ROOT/pages/properties-component.adoc b/docs/components/modules/ROOT/pages/properties-component.adoc index 8016672..45c4975 100644 --- a/docs/components/modules/ROOT/pages/properties-component.adoc +++ b/docs/components/modules/ROOT/pages/properties-component.adoc @@ -77,6 +77,37 @@ with the following path and query parameters: |=== // endpoint options: END +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 18 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.component.properties.cache* | Whether or not to cache loaded properties. The default value is true. | true | Boolean +| *camel.component.properties.default-fallback-enabled* | If false, the component does not attempt to find a default for the key by looking after the colon separator. | true | Boolean +| *camel.component.properties.enabled* | Whether to enable auto configuration of the properties component. This is enabled by default. | | Boolean +| *camel.component.properties.encoding* | Encoding to use when loading properties file from the file system or classpath. If no encoding has been set, then the properties files is loaded using ISO-8859-1 encoding (latin-1) as documented by java.util.Properties#load(java.io.InputStream) | | String +| *camel.component.properties.fallback-to-unaugmented-property* | If true, first attempt resolution of property name augmented with propertyPrefix and propertySuffix before falling back the plain property name specified. If false, only the augmented property name is searched. | true | Boolean +| *camel.component.properties.ignore-missing-location* | Whether to silently ignore if a location cannot be located, such as a properties file not found. | false | Boolean +| *camel.component.properties.initial-properties* | Sets initial properties which will be used before any locations are resolved. The option is a java.util.Properties type. | | String +| *camel.component.properties.location* | A list of locations to load properties. You can use comma to separate multiple locations. This option will override any default locations and only use the locations from this option. | | String +| *camel.component.properties.locations* | A list of locations to load properties. This option will override any default locations and only use the locations from this option. | | List +| *camel.component.properties.override-properties* | Sets a special list of override properties that take precedence and will use first, if a property exist. The option is a java.util.Properties type. | | String +| *camel.component.properties.prefix-token* | Sets the value of the prefix token used to identify properties to replace. Setting a value of null restores the default token (link DEFAULT_PREFIX_TOKEN). | {{ | String +| *camel.component.properties.properties-parser* | To use a custom PropertiesParser. The option is a org.apache.camel.component.properties.PropertiesParser type. | | String +| *camel.component.properties.properties-resolver* | To use a custom PropertiesResolver. The option is a org.apache.camel.component.properties.PropertiesResolver type. | | String +| *camel.component.properties.property-prefix* | Optional prefix prepended to property names before resolution. | | String +| *camel.component.properties.property-suffix* | Optional suffix appended to property names before resolution. | | String +| *camel.component.properties.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean +| *camel.component.properties.suffix-token* | Sets the value of the suffix token used to identify properties to replace. Setting a value of null restores the default token (link DEFAULT_SUFFIX_TOKEN). | }} | String +| *camel.component.properties.system-properties-mode* | Sets the system property mode. | 2 | Integer +|=== +// spring-boot-auto-configure options: END [TIP] **Resolving property from Java code** + diff --git a/docs/components/modules/ROOT/pages/ref-component.adoc b/docs/components/modules/ROOT/pages/ref-component.adoc index ed6bf0a..6f97711 100644 --- a/docs/components/modules/ROOT/pages/ref-component.adoc +++ b/docs/components/modules/ROOT/pages/ref-component.adoc @@ -57,6 +57,21 @@ with the following path and query parameters: |=== // endpoint options: END +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 2 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.component.ref.enabled* | Whether to enable auto configuration of the ref component. This is enabled by default. | | Boolean +| *camel.component.ref.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean +|=== +// spring-boot-auto-configure options: END === Runtime lookup diff --git a/docs/components/modules/ROOT/pages/rest-api-component.adoc b/docs/components/modules/ROOT/pages/rest-api-component.adoc index 69fefaf..0d7e3b7 100644 --- a/docs/components/modules/ROOT/pages/rest-api-component.adoc +++ b/docs/components/modules/ROOT/pages/rest-api-component.adoc @@ -49,6 +49,21 @@ with the following path and query parameters: |=== // endpoint options: END +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 2 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.component.rest-api.enabled* | Whether to enable auto configuration of the rest-api component. This is enabled by default. | | Boolean +| *camel.component.rest-api.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean +|=== +// spring-boot-auto-configure options: END === See Also diff --git a/docs/components/modules/ROOT/pages/rest-component.adoc b/docs/components/modules/ROOT/pages/rest-component.adoc index 3f43e1d..2bdad75 100644 --- a/docs/components/modules/ROOT/pages/rest-component.adoc +++ b/docs/components/modules/ROOT/pages/rest-component.adoc @@ -78,6 +78,25 @@ with the following path and query parameters: |=== // endpoint options: END +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 5 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.component.rest.api-doc* | The swagger api doc resource to use. The resource is loaded from classpath by default and must be in JSon format. | | String +| *camel.component.rest.component-name* | The Camel Rest component to use for the REST transport, such as restlet, spark-rest. If no component has been explicit configured, then Camel will lookup if there is a Camel component that integrates with the Rest DSL, or if a org.apache.camel.spi.RestConsumerFactory (consumer) or org.apache.camel.spi.RestProducerFactory (producer) is registered in the registry. If either one is found, then that is being used. | | String +| *camel.component.rest.enabled* | Whether to enable auto configuration of the rest component. This is enabled by default. | | Boolean +| *camel.component.rest.host* | Host and port of HTTP service to use (override host in swagger schema) | | String +| *camel.component.rest.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean +|=== +// spring-boot-auto-configure options: END + === Supported rest components The following components support rest consumer (Rest DSL): diff --git a/docs/components/modules/ROOT/pages/saga-component.adoc b/docs/components/modules/ROOT/pages/saga-component.adoc index 531c8b5..a508735 100644 --- a/docs/components/modules/ROOT/pages/saga-component.adoc +++ b/docs/components/modules/ROOT/pages/saga-component.adoc @@ -52,3 +52,19 @@ with the following path and query parameters: | *synchronous* (advanced) | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | boolean |=== // endpoint options: END + +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 2 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.component.saga.enabled* | Whether to enable auto configuration of the saga component. This is enabled by default. | | Boolean +| *camel.component.saga.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean +|=== +// spring-boot-auto-configure options: END diff --git a/docs/components/modules/ROOT/pages/scheduler-component.adoc b/docs/components/modules/ROOT/pages/scheduler-component.adoc index daaba42..9ffdd07 100644 --- a/docs/components/modules/ROOT/pages/scheduler-component.adoc +++ b/docs/components/modules/ROOT/pages/scheduler-component.adoc @@ -93,6 +93,22 @@ with the following path and query parameters: |=== // endpoint options: END +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 3 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.component.scheduler.concurrent-tasks* | Number of threads used by the scheduling thread pool. Is by default using a single thread | 1 | Integer +| *camel.component.scheduler.enabled* | Whether to enable auto configuration of the scheduler component. This is enabled by default. | | Boolean +| *camel.component.scheduler.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean +|=== +// spring-boot-auto-configure options: END === More information diff --git a/docs/components/modules/ROOT/pages/seda-component.adoc b/docs/components/modules/ROOT/pages/seda-component.adoc index 642218a..96fabde 100644 --- a/docs/components/modules/ROOT/pages/seda-component.adoc +++ b/docs/components/modules/ROOT/pages/seda-component.adoc @@ -101,6 +101,26 @@ with the following path and query parameters: |=== // endpoint options: END +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 7 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.component.seda.concurrent-consumers* | Sets the default number of concurrent threads processing exchanges. | 1 | Integer +| *camel.component.seda.default-block-when-full* | Whether a thread that sends messages to a full SEDA queue will block until the queue's capacity is no longer exhausted. By default, an exception will be thrown stating that the queue is full. By enabling this option, the calling thread will instead block and wait until the message can be accepted. | false | Boolean +| *camel.component.seda.default-offer-timeout* | Whether a thread that sends messages to a full SEDA queue will block until the queue's capacity is no longer exhausted. By default, an exception will be thrown stating that the queue is full. By enabling this option, where a configured timeout can be added to the block case. Utilizing the .offer(timeout) method of the underlining java queue | | Long +| *camel.component.seda.default-queue-factory* | Sets the default queue factory. The option is a org.apache.camel.component .seda.BlockingQueueFactory<org.apache.camel.Exchange> type. | | String +| *camel.component.seda.enabled* | Whether to enable auto configuration of the seda component. This is enabled by default. | | Boolean +| *camel.component.seda.queue-size* | Sets the default maximum capacity of the SEDA queue (i.e., the number of messages it can hold). | 1000 | Integer +| *camel.component.seda.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean +|=== +// spring-boot-auto-configure options: END === Choosing BlockingQueue implementation diff --git a/docs/components/modules/ROOT/pages/stub-component.adoc b/docs/components/modules/ROOT/pages/stub-component.adoc index f3d2098..1717337 100644 --- a/docs/components/modules/ROOT/pages/stub-component.adoc +++ b/docs/components/modules/ROOT/pages/stub-component.adoc @@ -91,6 +91,26 @@ with the following path and query parameters: |=== // endpoint options: END +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 7 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.component.stub.concurrent-consumers* | Sets the default number of concurrent threads processing exchanges. | 1 | Integer +| *camel.component.stub.default-block-when-full* | Whether a thread that sends messages to a full SEDA queue will block until the queue's capacity is no longer exhausted. By default, an exception will be thrown stating that the queue is full. By enabling this option, the calling thread will instead block and wait until the message can be accepted. | false | Boolean +| *camel.component.stub.default-offer-timeout* | Whether a thread that sends messages to a full SEDA queue will block until the queue's capacity is no longer exhausted. By default, an exception will be thrown stating that the queue is full. By enabling this option, where a configured timeout can be added to the block case. Utilizing the .offer(timeout) method of the underlining java queue | | Long +| *camel.component.stub.default-queue-factory* | Sets the default queue factory. The option is a org.apache.camel.component .seda.BlockingQueueFactory<org.apache.camel.Exchange> type. | | String +| *camel.component.stub.enabled* | Whether to enable auto configuration of the stub component. This is enabled by default. | | Boolean +| *camel.component.stub.queue-size* | Sets the default maximum capacity of the SEDA queue (i.e., the number of messages it can hold). | 1000 | Integer +| *camel.component.stub.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean +|=== +// spring-boot-auto-configure options: END === Examples diff --git a/docs/components/modules/ROOT/pages/timer-component.adoc b/docs/components/modules/ROOT/pages/timer-component.adoc index 8b435f2..9986c3e 100644 --- a/docs/components/modules/ROOT/pages/timer-component.adoc +++ b/docs/components/modules/ROOT/pages/timer-component.adoc @@ -80,6 +80,21 @@ with the following path and query parameters: |=== // endpoint options: END +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 2 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.component.timer.enabled* | Whether to enable auto configuration of the timer component. This is enabled by default. | | Boolean +| *camel.component.timer.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean +|=== +// spring-boot-auto-configure options: END === Exchange Properties diff --git a/docs/components/modules/ROOT/pages/validator-component.adoc b/docs/components/modules/ROOT/pages/validator-component.adoc index 41004cf..d273078 100644 --- a/docs/components/modules/ROOT/pages/validator-component.adoc +++ b/docs/components/modules/ROOT/pages/validator-component.adoc @@ -104,6 +104,22 @@ with the following path and query parameters: |=== // endpoint options: END +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 3 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.component.validator.enabled* | Whether to enable auto configuration of the validator component. This is enabled by default. | | Boolean +| *camel.component.validator.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean +| *camel.component.validator.resource-resolver-factory* | To use a custom LSResourceResolver which depends on a dynamic endpoint resource URI. The option is a org.apache.camel.component.validator.ValidatorResourceResolverFactory type. | | String +|=== +// spring-boot-auto-configure options: END === Example diff --git a/docs/components/modules/ROOT/pages/vm-component.adoc b/docs/components/modules/ROOT/pages/vm-component.adoc index 64b967f..77a6c18 100644 --- a/docs/components/modules/ROOT/pages/vm-component.adoc +++ b/docs/components/modules/ROOT/pages/vm-component.adoc @@ -121,6 +121,26 @@ with the following path and query parameters: |=== // endpoint options: END +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 7 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.component.vm.concurrent-consumers* | Sets the default number of concurrent threads processing exchanges. | 1 | Integer +| *camel.component.vm.default-block-when-full* | Whether a thread that sends messages to a full SEDA queue will block until the queue's capacity is no longer exhausted. By default, an exception will be thrown stating that the queue is full. By enabling this option, the calling thread will instead block and wait until the message can be accepted. | false | Boolean +| *camel.component.vm.default-offer-timeout* | Whether a thread that sends messages to a full SEDA queue will block until the queue's capacity is no longer exhausted. By default, an exception will be thrown stating that the queue is full. By enabling this option, where a configured timeout can be added to the block case. Utilizing the .offer(timeout) method of the underlining java queue | | Long +| *camel.component.vm.default-queue-factory* | Sets the default queue factory. The option is a org.apache.camel.component .seda.BlockingQueueFactory<org.apache.camel.Exchange> type. | | String +| *camel.component.vm.enabled* | Whether to enable auto configuration of the vm component. This is enabled by default. | | Boolean +| *camel.component.vm.queue-size* | Sets the default maximum capacity of the SEDA queue (i.e., the number of messages it can hold). | 1000 | Integer +| *camel.component.vm.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean +|=== +// spring-boot-auto-configure options: END See the <<seda-component,Seda>> component for options and other important usage details as the same rules apply to the <<vm-component,Vm>> component. diff --git a/docs/components/modules/ROOT/pages/xslt-component.adoc b/docs/components/modules/ROOT/pages/xslt-component.adoc index 415e578..e0f6e25 100644 --- a/docs/components/modules/ROOT/pages/xslt-component.adoc +++ b/docs/components/modules/ROOT/pages/xslt-component.adoc @@ -117,6 +117,28 @@ with the following path and query parameters: |=== // endpoint options: END +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 9 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.component.xslt.content-cache* | Cache for the resource content (the stylesheet file) when it is loaded. If set to false Camel will reload the stylesheet file on each message processing. This is good for development. A cached stylesheet can be forced to reload at runtime via JMX using the clearCachedStylesheet operation. | true | Boolean +| *camel.component.xslt.enabled* | Whether to enable auto configuration of the xslt component. This is enabled by default. | | Boolean +| *camel.component.xslt.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean +| *camel.component.xslt.saxon* | Whether to use Saxon as the transformerFactoryClass. If enabled then the class net.sf.saxon.TransformerFactoryImpl. You would need to add Saxon to the classpath. | false | Boolean +| *camel.component.xslt.saxon-configuration* | To use a custom Saxon configuration. The option is a java.lang.Object type. | | String +| *camel.component.xslt.saxon-configuration-properties* | To set custom Saxon configuration properties. The option is a java.util.Map<java.lang.String,java.lang.Object> type. | | String +| *camel.component.xslt.saxon-extension-functions* | Allows you to use a custom net.sf.saxon.lib.ExtensionFunctionDefinition. You would need to add camel-saxon to the classpath. The function is looked up in the registry, where you can comma to separate multiple values to lookup. | | String +| *camel.component.xslt.uri-resolver* | To use a custom UriResolver. Should not be used together with the option 'uriResolverFactory'. The option is a javax.xml.transform.URIResolver type. | | String +| *camel.component.xslt.uri-resolver-factory* | To use a custom UriResolver which depends on a dynamic endpoint resource URI. Should not be used together with the option 'uriResolver'. The option is a org.apache.camel.component.xslt.XsltUriResolverFactory type. | | String +|=== +// spring-boot-auto-configure options: END === Using XSLT endpoints