This is an automated email from the ASF dual-hosted git repository. davsclaus pushed a commit to branch camel-12644 in repository https://gitbox.apache.org/repos/asf/camel.git
commit eb7daccb073a92c5d7b7bd5727f2c4caec0eb0f5 Author: Claus Ibsen <claus.ib...@gmail.com> AuthorDate: Mon Jul 16 21:00:24 2018 +0200 CAMEL-12644: Generate spring boot auto configuration in the docs. --- .../camel-asn1/src/main/docs/asn1-dataformat.adoc | 23 ++ .../camel-avro/src/main/docs/avro-dataformat.adoc | 41 +++ .../src/main/docs/barcode-dataformat.adoc | 23 ++ .../src/main/docs/base64-dataformat.adoc | 25 ++ .../src/main/docs/beanio-dataformat.adoc | 36 ++ .../src/main/docs/bindy-dataformat.adoc | 47 +++ .../camel-boon/src/main/docs/boon-dataformat.adoc | 21 ++ .../src/main/docs/castor-dataformat.adoc | 37 ++ .../src/main/docs/crypto-dataformat.adoc | 152 ++++++++ .../camel-csv/src/main/docs/csv-dataformat.adoc | 53 +++ .../src/main/docs/flatpack-dataformat.adoc | 36 ++ .../src/main/docs/groovy-language.adoc | 19 +- .../src/main/docs/hessian-dataformat.adoc | 22 ++ .../camel-hl7/src/main/docs/hl7-dataformat.adoc | 23 ++ .../camel-ical/src/main/docs/ical-dataformat.adoc | 20 ++ .../src/main/docs/jacksonxml-dataformat.adoc | 58 +++ .../camel-jaxb/src/main/docs/jaxb-dataformat.adoc | 60 ++++ .../camel-jibx/src/main/docs/jibx-dataformat.adoc | 21 ++ .../src/main/docs/jsonpath-language.adoc | 23 ++ .../src/main/docs/jxpath-language.adoc | 22 +- .../camel-kafka/src/main/docs/kafka-component.adoc | 397 +++++++++++++++++++++ .../camel-lzf/src/main/docs/lzf-dataformat.adoc | 20 ++ .../camel-mvel/src/main/docs/mvel-language.adoc | 23 +- .../camel-ognl/src/main/docs/ognl-language.adoc | 19 +- .../src/main/docs/protobuf-dataformat.adoc | 24 ++ .../camel-rss/src/main/docs/rss-dataformat.adoc | 23 ++ .../src/main/docs/soapjaxb-dataformat.adoc | 47 +++ .../src/main/docs/syslog-dataformat.adoc | 19 + .../src/main/docs/tarfile-dataformat.adoc | 26 ++ .../src/main/docs/thrift-dataformat.adoc | 29 ++ .../src/main/docs/xmljson-dataformat.adoc | 58 +++ .../src/main/docs/xmlrpc-dataformat.adoc | 24 ++ .../src/main/docs/xstream-dataformat.adoc | 112 ++++++ .../src/main/docs/zipfile-dataformat.adoc | 26 ++ ...pdateSpringBootAutoConfigurationReadmeMojo.java | 11 - 35 files changed, 1605 insertions(+), 15 deletions(-) diff --git a/components/camel-asn1/src/main/docs/asn1-dataformat.adoc b/components/camel-asn1/src/main/docs/asn1-dataformat.adoc index be31038..2190a74 100644 --- a/components/camel-asn1/src/main/docs/asn1-dataformat.adoc +++ b/components/camel-asn1/src/main/docs/asn1-dataformat.adoc @@ -20,6 +20,29 @@ The ASN.1 File dataformat supports 3 options, which are listed below. | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSon etc. |=== // dataformat 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.dataformat.asn1.clazz-name* | Name of class to use when unmarshalling | | String +| *camel.dataformat.asn1.content-type-header* | Whether the data format should set the Content-Type header with the type + from the data format if the data format is capable of doing so. For + example application/xml for data formats marshalling to XML, or + application/json for data formats marshalling to JSon etc. | false | boolean +| *camel.dataformat.asn1.enabled* | null | | boolean +| *camel.dataformat.asn1.using-iterator* | If the asn1 file has more then one entry, the setting this option to + true, allows to work with the splitter EIP, to split the data using an + iterator in a streaming mode. | false | boolean +|=== +// spring-boot-auto-configure options: END +ND ### Unmarshal diff --git a/components/camel-avro/src/main/docs/avro-dataformat.adoc b/components/camel-avro/src/main/docs/avro-dataformat.adoc index b295d5d..b67107b 100644 --- a/components/camel-avro/src/main/docs/avro-dataformat.adoc +++ b/components/camel-avro/src/main/docs/avro-dataformat.adoc @@ -141,3 +141,44 @@ The Avro dataformat supports 2 options, which are listed below. | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSon etc. |=== // dataformat options: END +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 19 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.component.avro.configuration.host* | Hostname to use | | String +| *camel.component.avro.configuration.message-name* | The name of the message to send. | | String +| *camel.component.avro.configuration.port* | Port number to use | | int +| *camel.component.avro.configuration.protocol-class-name* | Avro protocol to use defined by the FQN class name | | String +| *camel.component.avro.configuration.protocol-location* | Avro protocol location | | String +| *camel.component.avro.configuration.protocol.json-props* | null | | Map +| *camel.component.avro.configuration.protocol.messages* | null | | Map +| *camel.component.avro.configuration.protocol.object-props* | null | | Map +| *camel.component.avro.configuration.protocol.props* | null | | Map +| *camel.component.avro.configuration.protocol.types* | null | | Schema> +| *camel.component.avro.configuration.reflection-protocol* | If protocol object provided is reflection protocol. Should be used + only with protocol parameter because for protocolClassName protocol + type will be auto detected | false | boolean +| *camel.component.avro.configuration.single-parameter* | If true, consumer parameter won't be wrapped into array. Will fail if + protocol specifies more then 1 parameter for the message | false | boolean +| *camel.component.avro.configuration.transport* | null | | AvroTransport +| *camel.component.avro.configuration.uri-authority* | Authority to use (username and password) | | String +| *camel.component.avro.enabled* | Enable avro component | true | boolean +| *camel.component.avro.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.dataformat.avro.content-type-header* | Whether the data format should set the Content-Type header with the type + from the data format if the data format is capable of doing so. For + example application/xml for data formats marshalling to XML, or + application/json for data formats marshalling to JSon etc. | false | boolean +| *camel.dataformat.avro.enabled* | Enable avro dataformat | true | boolean +| *camel.dataformat.avro.instance-class-name* | Class name to use for marshal and unmarshalling | | String +|=== +// spring-boot-auto-configure options: END +ND diff --git a/components/camel-barcode/src/main/docs/barcode-dataformat.adoc b/components/camel-barcode/src/main/docs/barcode-dataformat.adoc index f819d8c..57b2efb 100644 --- a/components/camel-barcode/src/main/docs/barcode-dataformat.adoc +++ b/components/camel-barcode/src/main/docs/barcode-dataformat.adoc @@ -44,6 +44,29 @@ The Barcode dataformat supports 5 options, which are listed below. | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSon etc. |=== // dataformat options: END +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 6 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.dataformat.barcode.barcode-format* | Barcode format such as QR-Code | | String +| *camel.dataformat.barcode.content-type-header* | Whether the data format should set the Content-Type header with the type + from the data format if the data format is capable of doing so. For + example application/xml for data formats marshalling to XML, or + application/json for data formats marshalling to JSon etc. | false | boolean +| *camel.dataformat.barcode.enabled* | Enable barcode dataformat | true | boolean +| *camel.dataformat.barcode.height* | Height of the barcode | | int +| *camel.dataformat.barcode.image-type* | Image type of the barcode such as png | | String +| *camel.dataformat.barcode.width* | Width of the barcode | | int +|=== +// spring-boot-auto-configure options: END +ND ### Using the Java DSL diff --git a/components/camel-base64/src/main/docs/base64-dataformat.adoc b/components/camel-base64/src/main/docs/base64-dataformat.adoc index b0cec71..089275f 100644 --- a/components/camel-base64/src/main/docs/base64-dataformat.adoc +++ b/components/camel-base64/src/main/docs/base64-dataformat.adoc @@ -21,6 +21,31 @@ The Base64 dataformat supports 4 options, which are listed below. | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSon etc. |=== // dataformat 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.dataformat.base64.content-type-header* | Whether the data format should set the Content-Type header with the type + from the data format if the data format is capable of doing so. For + example application/xml for data formats marshalling to XML, or + application/json for data formats marshalling to JSon etc. | false | boolean +| *camel.dataformat.base64.enabled* | Enable base64 dataformat | true | boolean +| *camel.dataformat.base64.line-length* | To specific a maximum line length for the encoded data. By default 76 is + used. | 76 | int +| *camel.dataformat.base64.line-separator* | The line separators to use. Uses new line characters (CRLF) by default. | | String +| *camel.dataformat.base64.url-safe* | Instead of emitting '' and '/' we emit '-' and '_' respectively. urlSafe + is only applied to encode operations. Decoding seamlessly handles both + modes. Is by default false. | false | boolean +|=== +// spring-boot-auto-configure options: END +ND In Spring DSL, you configure the data format using this tag: diff --git a/components/camel-beanio/src/main/docs/beanio-dataformat.adoc b/components/camel-beanio/src/main/docs/beanio-dataformat.adoc index 6df2bf4..b937cd3 100644 --- a/components/camel-beanio/src/main/docs/beanio-dataformat.adoc +++ b/components/camel-beanio/src/main/docs/beanio-dataformat.adoc @@ -33,6 +33,42 @@ The BeanIO dataformat supports 9 options, which are listed below. | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSon etc. |=== // dataformat options: END +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 10 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.dataformat.beanio.bean-reader-error-handler-type* | To use a custom org.apache.camel.dataformat.beanio.BeanIOErrorHandler as + error handler while parsing. Configure the fully qualified class name of + the error handler. Notice the options ignoreUnidentifiedRecords, + ignoreUnexpectedRecords, and ignoreInvalidRecords may not be in use when + you use a custom error handler. | | String +| *camel.dataformat.beanio.content-type-header* | Whether the data format should set the Content-Type header with the type + from the data format if the data format is capable of doing so. For + example application/xml for data formats marshalling to XML, or + application/json for data formats marshalling to JSon etc. | false | boolean +| *camel.dataformat.beanio.enabled* | Enable beanio dataformat | true | boolean +| *camel.dataformat.beanio.encoding* | The charset to use. Is by default the JVM platform default charset. | | String +| *camel.dataformat.beanio.ignore-invalid-records* | Whether to ignore invalid records. | false | boolean +| *camel.dataformat.beanio.ignore-unexpected-records* | Whether to ignore unexpected records. | false | boolean +| *camel.dataformat.beanio.ignore-unidentified-records* | Whether to ignore unidentified records. | false | boolean +| *camel.dataformat.beanio.mapping* | The BeanIO mapping file. Is by default loaded from the classpath. You can + prefix with file:, http:, or classpath: to denote from where to load the + mapping file. | | String +| *camel.dataformat.beanio.stream-name* | The name of the stream to use. | | String +| *camel.dataformat.beanio.unmarshal-single-object* | This options controls whether to unmarshal as a list of objects or as a + single object only. The former is the default mode, and the latter is + only intended in special use-cases where beanio maps the Camel message to + a single POJO bean. | false | boolean +|=== +// spring-boot-auto-configure options: END +ND ### Usage diff --git a/components/camel-bindy/src/main/docs/bindy-dataformat.adoc b/components/camel-bindy/src/main/docs/bindy-dataformat.adoc index 3bdc0b3..c680a21 100644 --- a/components/camel-bindy/src/main/docs/bindy-dataformat.adoc +++ b/components/camel-bindy/src/main/docs/bindy-dataformat.adoc @@ -70,6 +70,53 @@ The Bindy dataformat supports 5 options, which are listed below. | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSon etc. |=== // dataformat 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.dataformat.bindy-csv.class-type* | Name of model class to use. | | String +| *camel.dataformat.bindy-csv.content-type-header* | Whether the data format should set the Content-Type header with the type + from the data format if the data format is capable of doing so. For + example application/xml for data formats marshalling to XML, or + application/json for data formats marshalling to JSon etc. | false | boolean +| *camel.dataformat.bindy-csv.enabled* | Enable bindy-csv dataformat | true | boolean +| *camel.dataformat.bindy-csv.locale* | To configure a default locale to use, such as us for united states. To + use the JVM platform default locale then use the name default | | String +| *camel.dataformat.bindy-csv.type* | Whether to use csv, fixed or key value pairs mode. | | BindyType +| *camel.dataformat.bindy-csv.unwrap-single-instance* | When unmarshalling should a single instance be unwrapped and returned + instead of wrapped in a java.util.List. | true | boolean +| *camel.dataformat.bindy-fixed.class-type* | Name of model class to use. | | String +| *camel.dataformat.bindy-fixed.content-type-header* | Whether the data format should set the Content-Type header with the type + from the data format if the data format is capable of doing so. For + example application/xml for data formats marshalling to XML, or + application/json for data formats marshalling to JSon etc. | false | boolean +| *camel.dataformat.bindy-fixed.enabled* | Enable bindy-fixed dataformat | true | boolean +| *camel.dataformat.bindy-fixed.locale* | To configure a default locale to use, such as us for united states. To + use the JVM platform default locale then use the name default | | String +| *camel.dataformat.bindy-fixed.type* | Whether to use csv, fixed or key value pairs mode. | | BindyType +| *camel.dataformat.bindy-fixed.unwrap-single-instance* | When unmarshalling should a single instance be unwrapped and returned + instead of wrapped in a java.util.List. | true | boolean +| *camel.dataformat.bindy-kvp.class-type* | Name of model class to use. | | String +| *camel.dataformat.bindy-kvp.content-type-header* | Whether the data format should set the Content-Type header with the type + from the data format if the data format is capable of doing so. For + example application/xml for data formats marshalling to XML, or + application/json for data formats marshalling to JSon etc. | false | boolean +| *camel.dataformat.bindy-kvp.enabled* | Enable bindy-kvp dataformat | true | boolean +| *camel.dataformat.bindy-kvp.locale* | To configure a default locale to use, such as us for united states. To + use the JVM platform default locale then use the name default | | String +| *camel.dataformat.bindy-kvp.type* | Whether to use csv, fixed or key value pairs mode. | | BindyType +| *camel.dataformat.bindy-kvp.unwrap-single-instance* | When unmarshalling should a single instance be unwrapped and returned + instead of wrapped in a java.util.List. | true | boolean +|=== +// spring-boot-auto-configure options: END +ND diff --git a/components/camel-boon/src/main/docs/boon-dataformat.adoc b/components/camel-boon/src/main/docs/boon-dataformat.adoc index 419aeca..3a167fb 100644 --- a/components/camel-boon/src/main/docs/boon-dataformat.adoc +++ b/components/camel-boon/src/main/docs/boon-dataformat.adoc @@ -29,6 +29,27 @@ The Boon dataformat supports 3 options, which are listed below. | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSon etc. |=== // dataformat 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.dataformat.boon.content-type-header* | Whether the data format should set the Content-Type header with the type + from the data format if the data format is capable of doing so. For + example application/xml for data formats marshalling to XML, or + application/json for data formats marshalling to JSon etc. | false | boolean +| *camel.dataformat.boon.enabled* | Enable boon dataformat | true | boolean +| *camel.dataformat.boon.unmarshal-type-name* | Class name of the java type to use when unarmshalling | | String +| *camel.dataformat.boon.use-list* | To unarmshal to a List of Map or a List of Pojo. | false | boolean +|=== +// spring-boot-auto-configure options: END +ND diff --git a/components/camel-castor/src/main/docs/castor-dataformat.adoc b/components/camel-castor/src/main/docs/castor-dataformat.adoc index 07eb069..bc8a183 100644 --- a/components/camel-castor/src/main/docs/castor-dataformat.adoc +++ b/components/camel-castor/src/main/docs/castor-dataformat.adoc @@ -124,6 +124,43 @@ The Castor dataformat supports 9 options, which are listed below. | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSon etc. |=== // dataformat options: END +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 10 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.dataformat.castor.allowed-unmarshall-objects* | Define the allowed objects to be unmarshalled. You can specify the FQN + class name of allowed objects, and you can use comma to separate multiple + entries. It is also possible to use wildcards and regular expression + which is based on the pattern defined by link + org.apache.camel.util.EndpointHelpermatchPattern(String, String). Denied + objects takes precedence over allowed objects. | | String +| *camel.dataformat.castor.classes* | Add additional class names to Castor XmlContext | | string[] +| *camel.dataformat.castor.content-type-header* | Whether the data format should set the Content-Type header with the type + from the data format if the data format is capable of doing so. For + example application/xml for data formats marshalling to XML, or + application/json for data formats marshalling to JSon etc. | false | boolean +| *camel.dataformat.castor.denied-unmarshall-objects* | Define the denied objects to be unmarshalled. You can specify the FQN + class name of deined objects, and you can use comma to separate multiple + entries. It is also possible to use wildcards and regular expression + which is based on the pattern defined by link + org.apache.camel.util.EndpointHelpermatchPattern(String, String). Denied + objects takes precedence over allowed objects. | | String +| *camel.dataformat.castor.enabled* | Enable castor dataformat | true | boolean +| *camel.dataformat.castor.encoding* | Encoding to use when marshalling an Object to XML. Is by default UTF-8 | UTF-8 | String +| *camel.dataformat.castor.mapping-file* | Path to a Castor mapping file to load from the classpath. | | String +| *camel.dataformat.castor.packages* | Add additional packages to Castor XmlContext | | string[] +| *camel.dataformat.castor.validation* | Whether validation is turned on or off. Is by default true. | true | boolean +| *camel.dataformat.castor.whitelist-enabled* | Define if Whitelist feature is enabled or not | true | boolean +|=== +// spring-boot-auto-configure options: END +ND ### Dependencies diff --git a/components/camel-crypto/src/main/docs/crypto-dataformat.adoc b/components/camel-crypto/src/main/docs/crypto-dataformat.adoc index 9b7c781..c27d9f9 100644 --- a/components/camel-crypto/src/main/docs/crypto-dataformat.adoc +++ b/components/camel-crypto/src/main/docs/crypto-dataformat.adoc @@ -33,6 +33,158 @@ The Crypto (Java Cryptographic Extension) dataformat supports 10 options, which | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSon etc. |=== // dataformat options: END +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 54 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.component.crypto.configuration.algorithm* | Sets the JCE name of the Algorithm that should be used for the + signer. | SHA1WithDSA | String +| *camel.component.crypto.configuration.alias* | Sets the alias used to query the KeyStore for keys and + {@link java.security.cert.Certificate Certificates} to be used in + signing and verifying exchanges. This value can be provided at + runtime via the message header + {@link org.apache.camel.component.crypto.DigitalSignatureConstants#KEYSTORE_ALIAS} | | String +| *camel.component.crypto.configuration.buffer-size* | Set the size of the buffer used to read in the Exchange payload data. | 2048 | int +| *camel.component.crypto.configuration.camel-context* | null | | CamelContext +| *camel.component.crypto.configuration.certificate* | Set the Certificate that should be used to verify the signature in + the exchange based on its payload. | | Certificate +| *camel.component.crypto.configuration.certificate-name* | Sets the reference name for a PrivateKey that can be fond in the + registry. | | String +| *camel.component.crypto.configuration.clear-headers* | Determines if the Signature specific headers be cleared after signing + and verification. Defaults to true, and should only be made otherwise + at your extreme peril as vital private information such as Keys and + passwords may escape if unset. | true | boolean +| *camel.component.crypto.configuration.crypto-operation* | null | | CryptoOperation +| *camel.component.crypto.configuration.key-store-parameters.camel-context* | null | | CamelContext +| *camel.component.crypto.configuration.key-store-parameters.password* | null | | String +| *camel.component.crypto.configuration.key-store-parameters.provider* | null | | String +| *camel.component.crypto.configuration.key-store-parameters.resource* | null | | String +| *camel.component.crypto.configuration.key-store-parameters.type* | null | | String +| *camel.component.crypto.configuration.keystore* | Sets the KeyStore that can contain keys and Certficates for use in + signing and verifying exchanges. A {@link KeyStore} is typically used + with an alias, either one supplied in the Route definition or + dynamically via the message header "CamelSignatureKeyStoreAlias". If + no alias is supplied and there is only a single entry in the + Keystore, then this single entry will be used. | | KeyStore +| *camel.component.crypto.configuration.keystore-name* | Sets the reference name for a Keystore that can be fond in the + registry. | | String +| *camel.component.crypto.configuration.name* | The logical name of this operation. | | String +| *camel.component.crypto.configuration.password* | Sets the password used to access an aliased {@link PrivateKey} in the + KeyStore. | | character[] +| *camel.component.crypto.configuration.private-key* | Set the PrivateKey that should be used to sign the exchange + + @param privateKey + the key with with to sign the exchange. | | PrivateKey +| *camel.component.crypto.configuration.private-key-name* | Sets the reference name for a PrivateKey that can be fond in the + registry. | | String +| *camel.component.crypto.configuration.provider* | Set the id of the security provider that provides the configured + {@link Signature} algorithm. + + @param provider + the id of the security provider | | String +| *camel.component.crypto.configuration.public-key* | Set the PublicKey that should be used to verify the signature in the + exchange. | | PublicKey +| *camel.component.crypto.configuration.public-key-name* | Sets the reference name for a publicKey that can be fond in the + registry. | | String +| *camel.component.crypto.configuration.secure-random* | Set the SecureRandom used to initialize the Signature service + + @param secureRandom + the random used to init the Signature service | | SecureRandom +| *camel.component.crypto.configuration.secure-random-name* | Sets the reference name for a SecureRandom that can be fond in the + registry. | | String +| *camel.component.crypto.configuration.signature-header-name* | Set the name of the message header that should be used to store the + base64 encoded signature. This defaults to 'CamelDigitalSignature' | | String +| *camel.component.crypto.enabled* | Enable crypto component | true | boolean +| *camel.component.crypto.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.dataformat.crypto.algorithm* | The JCE algorithm name indicating the cryptographic algorithm that will + be used. Is by default DES/CBC/PKCS5Padding. | DES/CBC/PKCS5Padding | String +| *camel.dataformat.crypto.algorithm-parameter-ref* | A JCE AlgorithmParameterSpec used to initialize the Cipher. Will lookup + the type using the given name as a + java.security.spec.AlgorithmParameterSpec type. | | String +| *camel.dataformat.crypto.buffersize* | The size of the buffer used in the signature process. | | int +| *camel.dataformat.crypto.content-type-header* | Whether the data format should set the Content-Type header with the type + from the data format if the data format is capable of doing so. For + example application/xml for data formats marshalling to XML, or + application/json for data formats marshalling to JSon etc. | false | boolean +| *camel.dataformat.crypto.crypto-provider* | The name of the JCE Security Provider that should be used. | | String +| *camel.dataformat.crypto.enabled* | Enable crypto dataformat | true | boolean +| *camel.dataformat.crypto.init-vector-ref* | Refers to a byte array containing the Initialization Vector that will be + used to initialize the Cipher. | | String +| *camel.dataformat.crypto.inline* | Flag indicating that the configured IV should be inlined into the + encrypted data stream. Is by default false. | false | boolean +| *camel.dataformat.crypto.key-ref* | Refers to the secret key to lookup from the register to use. | | String +| *camel.dataformat.crypto.mac-algorithm* | The JCE algorithm name indicating the Message Authentication algorithm. | HmacSHA1 | String +| *camel.dataformat.crypto.should-append-h-m-a-c* | Flag indicating that a Message Authentication Code should be calculated + and appended to the encrypted data. | false | boolean +| *camel.dataformat.pgp.algorithm* | Symmetric key encryption algorithm; possible values are defined in + org.bouncycastle.bcpg.SymmetricKeyAlgorithmTags; for example 2 (= TRIPLE + DES), 3 (= CAST5), 4 (= BLOWFISH), 6 (= DES), 7 (= AES_128). Only + relevant for encrypting. | | int +| *camel.dataformat.pgp.armored* | This option will cause PGP to base64 encode the encrypted text, making it + available for copy/paste, etc. | false | boolean +| *camel.dataformat.pgp.compression-algorithm* | Compression algorithm; possible values are defined in + org.bouncycastle.bcpg.CompressionAlgorithmTags; for example 0 (= + UNCOMPRESSED), 1 (= ZIP), 2 (= ZLIB), 3 (= BZIP2). Only relevant for + encrypting. | | int +| *camel.dataformat.pgp.content-type-header* | Whether the data format should set the Content-Type header with the type + from the data format if the data format is capable of doing so. For + example application/xml for data formats marshalling to XML, or + application/json for data formats marshalling to JSon etc. | false | boolean +| *camel.dataformat.pgp.enabled* | Enable pgp dataformat | true | boolean +| *camel.dataformat.pgp.hash-algorithm* | Signature hash algorithm; possible values are defined in + org.bouncycastle.bcpg.HashAlgorithmTags; for example 2 (= SHA1), 8 (= + SHA256), 9 (= SHA384), 10 (= SHA512), 11 (=SHA224). Only relevant for + signing. | | int +| *camel.dataformat.pgp.integrity* | Adds an integrity check/sign into the encryption file. The default value + is true. | true | boolean +| *camel.dataformat.pgp.key-file-name* | Filename of the keyring; must be accessible as a classpath resource (but + you can specify a location in the file system by using the file: prefix). | | String +| *camel.dataformat.pgp.key-userid* | The user ID of the key in the PGP keyring used during encryption. Can + also be only a part of a user ID. For example, if the user ID is Test + User then you can use the part Test User or to address the user ID. | | String +| *camel.dataformat.pgp.password* | Password used when opening the private key (not used for encryption). | | String +| *camel.dataformat.pgp.provider* | Java Cryptography Extension (JCE) provider, default is Bouncy Castle + (BC). Alternatively you can use, for example, the IAIK JCE provider; in + this case the provider must be registered beforehand and the Bouncy + Castle provider must not be registered beforehand. The Sun JCE provider + does not work. | | String +| *camel.dataformat.pgp.signature-key-file-name* | Filename of the keyring to use for signing (during encryption) or for + signature verification (during decryption); must be accessible as a + classpath resource (but you can specify a location in the file system by + using the file: prefix). | | String +| *camel.dataformat.pgp.signature-key-ring* | Keyring used for signing/verifying as byte array. You can not set the + signatureKeyFileName and signatureKeyRing at the same time. | | String +| *camel.dataformat.pgp.signature-key-userid* | User ID of the key in the PGP keyring used for signing (during + encryption) or signature verification (during decryption). During the + signature verification process the specified User ID restricts the public + keys from the public keyring which can be used for the verification. If + no User ID is specified for the signature verficiation then any public + key in the public keyring can be used for the verification. Can also be + only a part of a user ID. For example, if the user ID is Test User then + you can use the part Test User or to address the User ID. | | String +| *camel.dataformat.pgp.signature-password* | Password used when opening the private key used for signing (during + encryption). | | String +| *camel.dataformat.pgp.signature-verification-option* | Controls the behavior for verifying the signature during unmarshaling. + There are 4 values possible: optional: The PGP message may or may not + contain signatures; if it does contain signatures, then a signature + verification is executed. required: The PGP message must contain at least + one signature; if this is not the case an exception (PGPException) is + thrown. A signature verification is executed. ignore: Contained + signatures in the PGP message are ignored; no signature verification is + executed. no_signature_allowed: The PGP message must not contain a + signature; otherwise an exception (PGPException) is thrown. | | String +|=== +// spring-boot-auto-configure options: END +ND ### Basic Usage diff --git a/components/camel-csv/src/main/docs/csv-dataformat.adoc b/components/camel-csv/src/main/docs/csv-dataformat.adoc index 5720d98..7446b69 100644 --- a/components/camel-csv/src/main/docs/csv-dataformat.adoc +++ b/components/camel-csv/src/main/docs/csv-dataformat.adoc @@ -49,6 +49,59 @@ The CSV dataformat supports 28 options, which are listed below. | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSon etc. |=== // dataformat options: END +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 29 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.dataformat.csv.allow-missing-column-names* | Whether to allow missing column names. | false | boolean +| *camel.dataformat.csv.comment-marker* | Sets the comment marker of the reference format. | | String +| *camel.dataformat.csv.comment-marker-disabled* | Disables the comment marker of the reference format. | false | boolean +| *camel.dataformat.csv.content-type-header* | Whether the data format should set the Content-Type header with the type + from the data format if the data format is capable of doing so. For + example application/xml for data formats marshalling to XML, or + application/json for data formats marshalling to JSon etc. | false | boolean +| *camel.dataformat.csv.delimiter* | Sets the delimiter to use. The default value is , (comma) | | String +| *camel.dataformat.csv.enabled* | Enable csv dataformat | true | boolean +| *camel.dataformat.csv.escape* | Sets the escape character to use | | String +| *camel.dataformat.csv.escape-disabled* | Use for disabling using escape character | false | boolean +| *camel.dataformat.csv.format-name* | The name of the format to use, the default value is CSVFormat.DEFAULT | | String +| *camel.dataformat.csv.format-ref* | The reference format to use, it will be updated with the other format + options, the default value is CSVFormat.DEFAULT | | String +| *camel.dataformat.csv.header* | To configure the CSV headers | | List +| *camel.dataformat.csv.header-disabled* | Use for disabling headers | false | boolean +| *camel.dataformat.csv.ignore-empty-lines* | Whether to ignore empty lines. | false | boolean +| *camel.dataformat.csv.ignore-header-case* | Sets whether or not to ignore case when accessing header names. | false | boolean +| *camel.dataformat.csv.ignore-surrounding-spaces* | Whether to ignore surrounding spaces | false | boolean +| *camel.dataformat.csv.lazy-load* | Whether the unmarshalling should produce an iterator that reads the lines + on the fly or if all the lines must be read at one. | false | boolean +| *camel.dataformat.csv.null-string* | Sets the null string | | String +| *camel.dataformat.csv.null-string-disabled* | Used to disable null strings | false | boolean +| *camel.dataformat.csv.quote* | Sets the quote which by default is | | String +| *camel.dataformat.csv.quote-disabled* | Used to disable quotes | false | boolean +| *camel.dataformat.csv.quote-mode* | Sets the quote mode | | String +| *camel.dataformat.csv.record-converter-ref* | Refers to a custom CsvRecordConverter to lookup from the registry to use. | | String +| *camel.dataformat.csv.record-separator* | Sets the record separator (aka new line) which by default is new line + characters (CRLF) | | String +| *camel.dataformat.csv.record-separator-disabled* | Used for disabling record separator | | String +| *camel.dataformat.csv.skip-header-record* | Whether to skip the header record in the output | false | boolean +| *camel.dataformat.csv.trailing-delimiter* | Sets whether or not to add a trailing delimiter. | false | boolean +| *camel.dataformat.csv.trim* | Sets whether or not to trim leading and trailing blanks. | false | boolean +| *camel.dataformat.csv.use-maps* | Whether the unmarshalling should produce maps (HashMap)for the lines + values instead of lists. It requires to have header (either defined or + collected). | false | boolean +| *camel.dataformat.csv.use-ordered-maps* | Whether the unmarshalling should produce ordered maps (LinkedHashMap) for + the lines values instead of lists. It requires to have header (either + defined or collected). | false | boolean +|=== +// spring-boot-auto-configure options: END +ND diff --git a/components/camel-flatpack/src/main/docs/flatpack-dataformat.adoc b/components/camel-flatpack/src/main/docs/flatpack-dataformat.adoc index fd39019..8d16ef0 100644 --- a/components/camel-flatpack/src/main/docs/flatpack-dataformat.adoc +++ b/components/camel-flatpack/src/main/docs/flatpack-dataformat.adoc @@ -40,6 +40,42 @@ The Flatpack dataformat supports 9 options, which are listed below. | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSon etc. |=== // dataformat options: END +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 12 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.component.flatpack.enabled* | Enable flatpack component | true | boolean +| *camel.component.flatpack.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.dataformat.flatpack.allow-short-lines* | Allows for lines to be shorter than expected and ignores the extra + characters | false | boolean +| *camel.dataformat.flatpack.content-type-header* | Whether the data format should set the Content-Type header with the type + from the data format if the data format is capable of doing so. For + example application/xml for data formats marshalling to XML, or + application/json for data formats marshalling to JSon etc. | false | boolean +| *camel.dataformat.flatpack.definition* | The flatpack pzmap configuration file. Can be omitted in simpler + situations, but its preferred to use the pzmap. | | String +| *camel.dataformat.flatpack.delimiter* | The delimiter char (could be ; , or similar) | , | String +| *camel.dataformat.flatpack.enabled* | Enable flatpack dataformat | true | boolean +| *camel.dataformat.flatpack.fixed* | Delimited or fixed. Is by default false = delimited | false | boolean +| *camel.dataformat.flatpack.ignore-extra-columns* | Allows for lines to be longer than expected and ignores the extra + characters. | false | boolean +| *camel.dataformat.flatpack.ignore-first-record* | Whether the first line is ignored for delimited files (for the column + headers). Is by default true. | true | boolean +| *camel.dataformat.flatpack.parser-factory-ref* | References to a custom parser factory to lookup in the registry | | String +| *camel.dataformat.flatpack.text-qualifier* | If the text is qualified with a character. Uses quote character by + default. | | String +|=== +// spring-boot-auto-configure options: END +ND ### Usage diff --git a/components/camel-groovy/src/main/docs/groovy-language.adoc b/components/camel-groovy/src/main/docs/groovy-language.adoc index c70c590..2a9d56c 100644 --- a/components/camel-groovy/src/main/docs/groovy-language.adoc +++ b/components/camel-groovy/src/main/docs/groovy-language.adoc @@ -36,6 +36,23 @@ The Groovy language supports 1 options, which are listed below. | trim | true | Boolean | Whether to trim the value to remove leading and trailing whitespaces and line breaks |=== // language 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.language.groovy.enabled* | Enable groovy language | true | boolean +| *camel.language.groovy.trim* | Whether to trim the value to remove leading and trailing whitespaces and + line breaks | true | boolean +|=== +// spring-boot-auto-configure options: END + @@ -194,4 +211,4 @@ the download page for the latest versions). <artifactId>camel-script</artifactId> <version>x.x.x</version> </dependency> ---------------------------------------- \ No newline at end of file +--------------------------------------- diff --git a/components/camel-hessian/src/main/docs/hessian-dataformat.adoc b/components/camel-hessian/src/main/docs/hessian-dataformat.adoc index 1314eef..cf52b69 100644 --- a/components/camel-hessian/src/main/docs/hessian-dataformat.adoc +++ b/components/camel-hessian/src/main/docs/hessian-dataformat.adoc @@ -33,6 +33,28 @@ The Hessian dataformat supports 4 options, which are listed below. | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSon etc. |=== // dataformat 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.dataformat.hessian.allowed-unmarshall-objects* | Define the allowed objects to be unmarshalled | | String +| *camel.dataformat.hessian.content-type-header* | Whether the data format should set the Content-Type header with the type + from the data format if the data format is capable of doing so. For + example application/xml for data formats marshalling to XML, or + application/json for data formats marshalling to JSon etc. | false | boolean +| *camel.dataformat.hessian.denied-unmarshall-objects* | Define the denied objects to be unmarshalled | | String +| *camel.dataformat.hessian.enabled* | Enable hessian dataformat | true | boolean +| *camel.dataformat.hessian.whitelist-enabled* | Define if Whitelist feature is enabled or not | true | boolean +|=== +// spring-boot-auto-configure options: END +ND ### Using the Hessian data format in Java DSL diff --git a/components/camel-hl7/src/main/docs/hl7-dataformat.adoc b/components/camel-hl7/src/main/docs/hl7-dataformat.adoc index fd25664..8c4e2b2 100644 --- a/components/camel-hl7/src/main/docs/hl7-dataformat.adoc +++ b/components/camel-hl7/src/main/docs/hl7-dataformat.adoc @@ -224,6 +224,29 @@ The HL7 dataformat supports 2 options, which are listed below. | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSon etc. |=== // dataformat 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.dataformat.hl7.content-type-header* | Whether the data format should set the Content-Type header with the type + from the data format if the data format is capable of doing so. For + example application/xml for data formats marshalling to XML, or + application/json for data formats marshalling to JSon etc. | false | boolean +| *camel.dataformat.hl7.enabled* | Enable hl7 dataformat | true | boolean +| *camel.dataformat.hl7.validate* | Whether to validate the HL7 message Is by default true. | true | boolean +| *camel.language.terser.enabled* | Enable terser language | true | boolean +| *camel.language.terser.trim* | Whether to trim the value to remove leading and trailing whitespaces and + line breaks | true | boolean +|=== +// spring-boot-auto-configure options: END +ND * `marshal` = from Message to byte stream (can be used when responding using the HL7 MLLP codec) diff --git a/components/camel-ical/src/main/docs/ical-dataformat.adoc b/components/camel-ical/src/main/docs/ical-dataformat.adoc index d134ea8..456e566 100644 --- a/components/camel-ical/src/main/docs/ical-dataformat.adoc +++ b/components/camel-ical/src/main/docs/ical-dataformat.adoc @@ -41,6 +41,26 @@ The iCal dataformat supports 2 options, which are listed below. | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSon etc. |=== // dataformat 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.dataformat.ical.content-type-header* | Whether the data format should set the Content-Type header with the type + from the data format if the data format is capable of doing so. For + example application/xml for data formats marshalling to XML, or + application/json for data formats marshalling to JSon etc. | false | boolean +| *camel.dataformat.ical.enabled* | Enable ical dataformat | true | boolean +| *camel.dataformat.ical.validating* | Whether to validate. | false | boolean +|=== +// spring-boot-auto-configure options: END +ND ### Basic Usage diff --git a/components/camel-jacksonxml/src/main/docs/jacksonxml-dataformat.adoc b/components/camel-jacksonxml/src/main/docs/jacksonxml-dataformat.adoc index b0fede9..b4a2604 100644 --- a/components/camel-jacksonxml/src/main/docs/jacksonxml-dataformat.adoc +++ b/components/camel-jacksonxml/src/main/docs/jacksonxml-dataformat.adoc @@ -57,6 +57,64 @@ The JacksonXML dataformat supports 15 options, which are listed below. | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSon etc. |=== // dataformat options: END +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 16 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.dataformat.jacksonxml.allow-jms-type* | Used for JMS users to allow the JMSType header from the JMS spec to + specify a FQN classname to use to unmarshal to. | false | boolean +| *camel.dataformat.jacksonxml.allow-unmarshall-type* | If enabled then Jackson is allowed to attempt to use the + CamelJacksonUnmarshalType header during the unmarshalling. This should + only be enabled when desired to be used. | false | boolean +| *camel.dataformat.jacksonxml.collection-type-name* | Refers to a custom collection type to lookup in the registry to use. This + option should rarely be used, but allows to use different collection + types than java.util.Collection based as default. | | String +| *camel.dataformat.jacksonxml.content-type-header* | Whether the data format should set the Content-Type header with the type + from the data format if the data format is capable of doing so. For + example application/xml for data formats marshalling to XML, or + application/json for data formats marshalling to JSon etc. | false | boolean +| *camel.dataformat.jacksonxml.disable-features* | Set of features to disable on the Jackson + com.fasterxml.jackson.databind.ObjectMapper. The features should be a + name that matches a enum from + com.fasterxml.jackson.databind.SerializationFeature, + com.fasterxml.jackson.databind.DeserializationFeature, or + com.fasterxml.jackson.databind.MapperFeature Multiple features can be + separated by comma | | String +| *camel.dataformat.jacksonxml.enable-features* | Set of features to enable on the Jackson + com.fasterxml.jackson.databind.ObjectMapper. The features should be a + name that matches a enum from + com.fasterxml.jackson.databind.SerializationFeature, + com.fasterxml.jackson.databind.DeserializationFeature, or + com.fasterxml.jackson.databind.MapperFeature Multiple features can be + separated by comma | | String +| *camel.dataformat.jacksonxml.enable-jaxb-annotation-module* | Whether to enable the JAXB annotations module when using jackson. When + enabled then JAXB annotations can be used by Jackson. | false | boolean +| *camel.dataformat.jacksonxml.enabled* | Enable jacksonxml dataformat | true | boolean +| *camel.dataformat.jacksonxml.include* | If you want to marshal a pojo to JSON, and the pojo has some fields with + null values. And you want to skip these null values, you can set this + option to NOT_NULL | | String +| *camel.dataformat.jacksonxml.json-view* | When marshalling a POJO to JSON you might want to exclude certain fields + from the JSON output. With Jackson you can use JSON views to accomplish + this. This option is to refer to the class which has JsonView annotations | | class +| *camel.dataformat.jacksonxml.module-class-names* | To use custom Jackson modules com.fasterxml.jackson.databind.Module + specified as a String with FQN class names. Multiple classes can be + separated by comma. | | String +| *camel.dataformat.jacksonxml.module-refs* | To use custom Jackson modules referred from the Camel registry. Multiple + modules can be separated by comma. | | String +| *camel.dataformat.jacksonxml.pretty-print* | To enable pretty printing output nicely formatted. Is by default false. | false | boolean +| *camel.dataformat.jacksonxml.unmarshal-type-name* | Class name of the java type to use when unarmshalling | | String +| *camel.dataformat.jacksonxml.use-list* | To unarmshal to a List of Map or a List of Pojo. | false | boolean +| *camel.dataformat.jacksonxml.xml-mapper* | Lookup and use the existing XmlMapper with the given id. | | String +|=== +// spring-boot-auto-configure options: END +ND #### Using Jackson XML in Spring DSL diff --git a/components/camel-jaxb/src/main/docs/jaxb-dataformat.adoc b/components/camel-jaxb/src/main/docs/jaxb-dataformat.adoc index c4c087e..2695ddd 100644 --- a/components/camel-jaxb/src/main/docs/jaxb-dataformat.adoc +++ b/components/camel-jaxb/src/main/docs/jaxb-dataformat.adoc @@ -38,6 +38,66 @@ The JAXB dataformat supports 18 options, which are listed below. | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSon etc. |=== // dataformat options: END +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 19 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.dataformat.jaxb.content-type-header* | Whether the data format should set the Content-Type header with the type + from the data format if the data format is capable of doing so. For + example application/xml for data formats marshalling to XML, or + application/json for data formats marshalling to JSon etc. | false | boolean +| *camel.dataformat.jaxb.context-path* | Package name where your JAXB classes are located. | | String +| *camel.dataformat.jaxb.enabled* | Enable jaxb dataformat | true | boolean +| *camel.dataformat.jaxb.encoding* | To overrule and use a specific encoding | | String +| *camel.dataformat.jaxb.filter-non-xml-chars* | To ignore non xml characheters and replace them with an empty space. | false | boolean +| *camel.dataformat.jaxb.fragment* | To turn on marshalling XML fragment trees. By default JAXB looks for + XmlRootElement annotation on given class to operate on whole XML tree. + This is useful but not always - sometimes generated code does not have + XmlRootElement annotation, sometimes you need unmarshall only part of + tree. In that case you can use partial unmarshalling. To enable this + behaviours you need set property partClass. Camel will pass this class to + JAXB's unmarshaler. | false | boolean +| *camel.dataformat.jaxb.ignore-j-a-x-b-element* | Whether to ignore JAXBElement elements - only needed to be set to false + in very special use-cases. | false | boolean +| *camel.dataformat.jaxb.jaxb-provider-properties* | Refers to a custom java.util.Map to lookup in the registry containing + custom JAXB provider properties to be used with the JAXB marshaller. | | String +| *camel.dataformat.jaxb.must-be-j-a-x-b-element* | Whether marhsalling must be java objects with JAXB annotations. And if + not then it fails. This option can be set to false to relax that, such as + when the data is already in XML format. | false | boolean +| *camel.dataformat.jaxb.namespace-prefix-ref* | When marshalling using JAXB or SOAP then the JAXB implementation will + automatic assign namespace prefixes, such as ns2, ns3, ns4 etc. To + control this mapping, Camel allows you to refer to a map which contains + the desired mapping. | | String +| *camel.dataformat.jaxb.no-namespace-schema-location* | To define the location of the namespaceless schema | | String +| *camel.dataformat.jaxb.object-factory* | Whether to allow using ObjectFactory classes to create the POJO classes + during marshalling. This only applies to POJO classes that has not been + annotated with JAXB and providing jaxb.index descriptor files. | false | boolean +| *camel.dataformat.jaxb.part-class* | Name of class used for fragment parsing. See more details at the fragment + option. | | String +| *camel.dataformat.jaxb.part-namespace* | XML namespace to use for fragment parsing. See more details at the + fragment option. | | String +| *camel.dataformat.jaxb.pretty-print* | To enable pretty printing output nicely formatted. Is by default false. | false | boolean +| *camel.dataformat.jaxb.schema* | To validate against an existing schema. Your can use the prefix + classpath:, file: or http: to specify how the resource should by + resolved. You can separate multiple schema files by using the ',' + character. | | String +| *camel.dataformat.jaxb.schema-location* | To define the location of the schema | | String +| *camel.dataformat.jaxb.schema-severity-level* | Sets the schema severity level to use when validating against a schema. + This level determines the minimum severity error that triggers JAXB to + stop continue parsing. The default value of 0 (warning) means that any + error (warning, error or fatal error) will trigger JAXB to stop. There + are the following three levels: 0=warning, 1=error, 2=fatal error. | 0 | int +| *camel.dataformat.jaxb.xml-stream-writer-wrapper* | To use a custom xml stream writer. | | String +|=== +// spring-boot-auto-configure options: END +ND ### Using the Java DSL diff --git a/components/camel-jibx/src/main/docs/jibx-dataformat.adoc b/components/camel-jibx/src/main/docs/jibx-dataformat.adoc index 3ea1c62..3a90c2a 100644 --- a/components/camel-jibx/src/main/docs/jibx-dataformat.adoc +++ b/components/camel-jibx/src/main/docs/jibx-dataformat.adoc @@ -42,6 +42,27 @@ The JiBX dataformat supports 3 options, which are listed below. | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSon etc. |=== // dataformat 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.dataformat.jibx.binding-name* | To use a custom binding factory | | String +| *camel.dataformat.jibx.content-type-header* | Whether the data format should set the Content-Type header with the type + from the data format if the data format is capable of doing so. For + example application/xml for data formats marshalling to XML, or + application/json for data formats marshalling to JSon etc. | false | boolean +| *camel.dataformat.jibx.enabled* | Enable jibx dataformat | true | boolean +| *camel.dataformat.jibx.unmarshall-class* | Class name to use when unmarshalling from XML to Java. | | String +|=== +// spring-boot-auto-configure options: END +ND ### JiBX Spring DSL diff --git a/components/camel-jsonpath/src/main/docs/jsonpath-language.adoc b/components/camel-jsonpath/src/main/docs/jsonpath-language.adoc index 8a4b683..4b91d29 100644 --- a/components/camel-jsonpath/src/main/docs/jsonpath-language.adoc +++ b/components/camel-jsonpath/src/main/docs/jsonpath-language.adoc @@ -39,6 +39,29 @@ The JsonPath language supports 7 options, which are listed below. | trim | true | Boolean | Whether to trim the value to remove leading and trailing whitespaces and line breaks |=== // language 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.language.jsonpath.allow-easy-predicate* | Whether to allow using the easy predicate parser to pre-parse predicates. | true | boolean +| *camel.language.jsonpath.allow-simple* | Whether to allow in inlined simple exceptions in the JsonPath expression | true | boolean +| *camel.language.jsonpath.enabled* | Enable jsonpath language | true | boolean +| *camel.language.jsonpath.header-name* | Name of header to use as input, instead of the message body | | String +| *camel.language.jsonpath.suppress-exceptions* | Whether to suppress exceptions such as PathNotFoundException. | false | boolean +| *camel.language.jsonpath.trim* | Whether to trim the value to remove leading and trailing whitespaces and + line breaks | true | boolean +| *camel.language.jsonpath.write-as-string* | Whether to write the output of each row/element as a JSON String value + instead of a Map/POJO value. | false | boolean +|=== +// spring-boot-auto-configure options: END + diff --git a/components/camel-jxpath/src/main/docs/jxpath-language.adoc b/components/camel-jxpath/src/main/docs/jxpath-language.adoc index 66ba263..b860396 100644 --- a/components/camel-jxpath/src/main/docs/jxpath-language.adoc +++ b/components/camel-jxpath/src/main/docs/jxpath-language.adoc @@ -37,6 +37,26 @@ The JXPath language supports 2 options, which are listed below. | trim | true | Boolean | Whether to trim the value to remove leading and trailing whitespaces and line breaks |=== // language 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.language.jxpath.enabled* | Enable jxpath language | true | boolean +| *camel.language.jxpath.lenient* | Allows to turn lenient on the JXPathContext. When turned on this allows + the JXPath expression to evaluate against expressions and message bodies + which may be invalid / missing data. This option is by default false | false | boolean +| *camel.language.jxpath.trim* | Whether to trim the value to remove leading and trailing whitespaces and + line breaks | true | boolean +|=== +// spring-boot-auto-configure options: END + @@ -152,4 +172,4 @@ the download page for the latest versions). Otherwise, you'll also need http://repo2.maven.org/maven2/commons-jxpath/commons-jxpath/1.3/commons-jxpath-1.3.jar[Commons -JXPath]. \ No newline at end of file +JXPath]. diff --git a/components/camel-kafka/src/main/docs/kafka-component.adoc b/components/camel-kafka/src/main/docs/kafka-component.adoc index 4559ab4..8c757a9 100644 --- a/components/camel-kafka/src/main/docs/kafka-component.adoc +++ b/components/camel-kafka/src/main/docs/kafka-component.adoc @@ -173,6 +173,403 @@ with the following path and query parameters: | *sslTruststoreType* (security) | The file format of the trust store file. Default value is JKS. | JKS | String |=== // endpoint options: END +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 111 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.component.kafka.allow-manual-commit* | Whether to allow doing manual commits via KafkaManualCommit. If this + option is enabled then an instance of KafkaManualCommit is stored on the + Exchange message header, which allows end users to access this API and + perform manual offset commits via the Kafka consumer. | false | boolean +| *camel.component.kafka.break-on-first-error* | This options controls what happens when a consumer is processing an + exchange and it fails. If the option is false then the consumer continues + to the next message and processes it. If the option is true then the + consumer breaks out, and will seek back to offset of the message that + caused a failure, and then re-attempt to process this message. However + this can lead to endless processing of the same message if its bound to + fail every time, eg a poison message. Therefore its recommended to deal + with that for example by using Camel's error handler. | false | boolean +| *camel.component.kafka.brokers* | URL of the Kafka brokers to use. The format is host1:port1,host2:port2, + and the list can be a subset of brokers or a VIP pointing to a subset of + brokers. This option is known as bootstrap.servers in the Kafka + documentation. | | String +| *camel.component.kafka.configuration.allow-manual-commit* | Whether to allow doing manual commits via {@link KafkaManualCommit} . + <p/> + If this option is enabled then an instance of + {@link KafkaManualCommit} is stored on the {@link Exchange} message + header, which allows end users to access this API and perform manual + offset commits via the Kafka consumer. | false | boolean +| *camel.component.kafka.configuration.auto-commit-enable* | If true, periodically commit to ZooKeeper the offset of messages + already fetched by the consumer. This committed offset will be used + when the process fails as the position from which the new consumer + will begin. | true | boolean +| *camel.component.kafka.configuration.auto-commit-interval-ms* | The frequency in ms that the consumer offsets are committed to + zookeeper. | 5000 | int +| *camel.component.kafka.configuration.auto-commit-on-stop* | Whether to perform an explicit auto commit when the consumer stops to + ensure the broker has a commit from the last consumed message. This + requires the option autoCommitEnable is turned on. The possible + values are: sync, async, or none. And sync is the default value. | sync | String +| *camel.component.kafka.configuration.auto-offset-reset* | What to do when there is no initial offset in ZooKeeper or if an + offset is out of range: smallest : automatically reset the offset to + the smallest offset largest : automatically reset the offset to the + largest offset fail: throw exception to the consumer | latest | String +| *camel.component.kafka.configuration.break-on-first-error* | This options controls what happens when a consumer is processing an + exchange and it fails. If the option is <tt>false</tt> then the + consumer continues to the next message and processes it. If the + option is <tt>true</tt> then the consumer breaks out, and will seek + back to offset of the message that caused a failure, and then + re-attempt to process this message. However this can lead to endless + processing of the same message if its bound to fail every time, eg a + poison message. Therefore its recommended to deal with that for + example by using Camel's error handler. | false | boolean +| *camel.component.kafka.configuration.bridge-endpoint* | If the option is true, then KafkaProducer will ignore the + KafkaConstants.TOPIC header setting of the inbound message. | false | boolean +| *camel.component.kafka.configuration.brokers* | URL of the Kafka brokers to use. The format is + host1:port1,host2:port2, and the list can be a subset of brokers or a + VIP pointing to a subset of brokers. + <p/> + This option is known as <tt>bootstrap.servers</tt> in the Kafka + documentation. | | String +| *camel.component.kafka.configuration.buffer-memory-size* | The total bytes of memory the producer can use to buffer records + waiting to be sent to the server. If records are sent faster than + they can be delivered to the server the producer will either block or + throw an exception based on the preference specified by + block.on.buffer.full.This setting should correspond roughly to the + total memory the producer will use, but is not a hard bound since not + all memory the producer uses is used for buffering. Some additional + memory will be used for compression (if compression is enabled) as + well as for maintaining in-flight requests. | 33554432 | int +| *camel.component.kafka.configuration.check-crcs* | Automatically check the CRC32 of the records consumed. This ensures + no on-the-wire or on-disk corruption to the messages occurred. This + check adds some overhead, so it may be disabled in cases seeking + extreme performance. | true | boolean +| *camel.component.kafka.configuration.circular-topic-detection* | If the option is true, then KafkaProducer will detect if the message + is attempted to be sent back to the same topic it may come from, if + the message was original from a kafka consumer. If the + KafkaConstants.TOPIC header is the same as the original kafka + consumer topic, then the header setting is ignored, and the topic of + the producer endpoint is used. In other words this avoids sending the + same message back to where it came from. This option is not in use if + the option bridgeEndpoint is set to true. | true | boolean +| *camel.component.kafka.configuration.client-id* | The client id is a user-specified string sent in each request to help + trace calls. It should logically identify the application making the + request. | | String +| *camel.component.kafka.configuration.compression-codec* | This parameter allows you to specify the compression codec for all + data generated by this producer. Valid values are "none", "gzip" and + "snappy". | none | String +| *camel.component.kafka.configuration.connection-max-idle-ms* | Close idle connections after the number of milliseconds specified by + this config. | 540000 | int +| *camel.component.kafka.configuration.consumer-request-timeout-ms* | The configuration controls the maximum amount of time the client will + wait for the response of a request. If the response is not received + before the timeout elapses the client will resend the request if + necessary or fail the request if retries are exhausted. | 40000 | int +| *camel.component.kafka.configuration.consumer-streams* | Number of concurrent consumers on the consumer | 10 | int +| *camel.component.kafka.configuration.consumers-count* | The number of consumers that connect to kafka server | 1 | int +| *camel.component.kafka.configuration.enable-idempotence* | If set to 'true' the producer will ensure that exactly one copy of + each message is written in the stream. If 'false', producer retries + may write duplicates of the retried message in the stream. If set to + true this option will require max.in.flight.requests.per.connection + to be set to 1 and retries cannot be zero and additionally acks must + be set to 'all'. | false | boolean +| *camel.component.kafka.configuration.fetch-max-bytes* | null | 52428800 | int +| *camel.component.kafka.configuration.fetch-min-bytes* | The minimum amount of data the server should return for a fetch + request. If insufficient data is available the request will wait for + that much data to accumulate before answering the request. | 1 | int +| *camel.component.kafka.configuration.fetch-wait-max-ms* | The maximum amount of time the server will block before answering the + fetch request if there isn't sufficient data to immediately satisfy + fetch.min.bytes | 500 | int +| *camel.component.kafka.configuration.group-id* | A string that uniquely identifies the group of consumer processes to + which this consumer belongs. By setting the same group id multiple + processes indicate that they are all part of the same consumer group. + This option is required for consumers. | | String +| *camel.component.kafka.configuration.header-filter-strategy* | To use a custom HeaderFilterStrategy to filter header to and from + Camel message. | | HeaderFilterStrategy +| *camel.component.kafka.configuration.heartbeat-interval-ms* | The expected time between heartbeats to the consumer coordinator when + using Kafka's group management facilities. Heartbeats are used to + ensure that the consumer's session stays active and to facilitate + rebalancing when new consumers join or leave the group. The value + must be set lower than session.timeout.ms, but typically should be + set no higher than 1/3 of that value. It can be adjusted even lower + to control the expected time for normal rebalances. | 3000 | int +| *camel.component.kafka.configuration.interceptor-classes* | Sets interceptors for producer or consumers. Producer interceptors + have to be classes implementing + {@link org.apache.kafka.clients.producer.ProducerInterceptor} + Consumer interceptors have to be classes implementing + {@link org.apache.kafka.clients.consumer.ConsumerInterceptor} Note + that if you use Producer interceptor on a consumer it will throw a + class cast exception in runtime | | String +| *camel.component.kafka.configuration.kafka-header-deserializer* | Sets custom KafkaHeaderDeserializer for deserialization kafka headers + values to camel headers values. + + @param kafkaHeaderDeserializer + custom kafka header deserializer to be used | | KafkaHeaderDeserializer +| *camel.component.kafka.configuration.kafka-header-serializer* | Sets custom KafkaHeaderDeserializer for serialization camel headers + values to kafka headers values. + + @param kafkaHeaderSerializer + custom kafka header serializer to be used | | KafkaHeaderSerializer +| *camel.component.kafka.configuration.kerberos-before-relogin-min-time* | Login thread sleep time between refresh attempts. | 60000 | int +| *camel.component.kafka.configuration.kerberos-init-cmd* | Kerberos kinit command path. Default is /usr/bin/kinit | /usr/bin/kinit | String +| *camel.component.kafka.configuration.kerberos-principal-to-local-rules* | A list of rules for mapping from principal names to short names + (typically operating system usernames). The rules are evaluated in + order and the first rule that matches a principal name is used to map + it to a short name. Any later rules in the list are ignored. By + default, principal names of the form {username}/{hostname}@{REALM} + are mapped to {username}. For more details on the format please see + <a href=\"#security_authz\"> security authorization and acls</a>. + <p/> + Multiple values can be separated by comma | DEFAULT | String +| *camel.component.kafka.configuration.kerberos-renew-jitter* | Percentage of random jitter added to the renewal time. | | double +| *camel.component.kafka.configuration.kerberos-renew-window-factor* | Login thread will sleep until the specified window factor of time + from last refresh to ticket's expiry has been reached, at which time + it will try to renew the ticket. | | double +| *camel.component.kafka.configuration.key* | The record key (or null if no key is specified). If this option has + been configured then it take precedence over header + {@link KafkaConstants#KEY} | | String +| *camel.component.kafka.configuration.key-deserializer* | Deserializer class for key that implements the Deserializer + interface. | org.apache.kafka.common.serialization.StringDeserializer | String +| *camel.component.kafka.configuration.key-serializer-class* | The serializer class for keys (defaults to the same as for messages + if nothing is given). | org.apache.kafka.common.serialization.StringSerializer | String +| *camel.component.kafka.configuration.linger-ms* | The producer groups together any records that arrive in between + request transmissions into a single batched request. Normally this + occurs only under load when records arrive faster than they can be + sent out. However in some circumstances the client may want to reduce + the number of requests even under moderate load. This setting + accomplishes this by adding a small amount of artificial delay—that + is, rather than immediately sending out a record the producer will + wait for up to the given delay to allow other records to be sent so + that the sends can be batched together. This can be thought of as + analogous to Nagle's algorithm in TCP. This setting gives the upper + bound on the delay for batching: once we get batch.size worth of + records for a partition it will be sent immediately regardless of + this setting, however if we have fewer than this many bytes + accumulated for this partition we will 'linger' for the specified + time waiting for more records to show up. This setting defaults to 0 + (i.e. no delay). Setting linger.ms=5, for example, would have the + effect of reducing the number of requests sent but would add up to + 5ms of latency to records sent in the absense of load. | 0 | int +| *camel.component.kafka.configuration.max-block-ms* | The configuration controls how long sending to kafka will block. + These methods can be blocked for multiple reasons. For e.g: buffer + full, metadata unavailable.This configuration imposes maximum limit + on the total time spent in fetching metadata, serialization of key + and value, partitioning and allocation of buffer memory when doing a + send(). In case of partitionsFor(), this configuration imposes a + maximum time threshold on waiting for metadata | 60000 | int +| *camel.component.kafka.configuration.max-in-flight-request* | The maximum number of unacknowledged requests the client will send on + a single connection before blocking. Note that if this setting is set + to be greater than 1 and there are failed sends, there is a risk of + message re-ordering due to retries (i.e., if retries are enabled). | 5 | int +| *camel.component.kafka.configuration.max-partition-fetch-bytes* | The maximum amount of data per-partition the server will return. The + maximum total memory used for a request will be #partitions * + max.partition.fetch.bytes. This size must be at least as large as the + maximum message size the server allows or else it is possible for the + producer to send messages larger than the consumer can fetch. If that + happens, the consumer can get stuck trying to fetch a large message + on a certain partition. | 1048576 | int +| *camel.component.kafka.configuration.max-poll-interval-ms* | The maximum delay between invocations of poll() when using consumer + group management. This places an upper bound on the amount of time + that the consumer can be idle before fetching more records. If poll() + is not called before expiration of this timeout, then the consumer is + considered failed and the group will rebalance in order to reassign + the partitions to another member. | | long +| *camel.component.kafka.configuration.max-poll-records* | The maximum number of records returned in a single call to poll() | 500 | int +| *camel.component.kafka.configuration.max-request-size* | The maximum size of a request. This is also effectively a cap on the + maximum record size. Note that the server has its own cap on record + size which may be different from this. This setting will limit the + number of record batches the producer will send in a single request + to avoid sending huge requests. | 1048576 | int +| *camel.component.kafka.configuration.metadata-max-age-ms* | The period of time in milliseconds after which we force a refresh of + metadata even if we haven't seen any partition leadership changes to + proactively discover any new brokers or partitions. | 300000 | int +| *camel.component.kafka.configuration.metric-reporters* | A list of classes to use as metrics reporters. Implementing the + MetricReporter interface allows plugging in classes that will be + notified of new metric creation. The JmxReporter is always included + to register JMX statistics. | | String +| *camel.component.kafka.configuration.metrics-sample-window-ms* | The number of samples maintained to compute metrics. | 30000 | int +| *camel.component.kafka.configuration.no-of-metrics-sample* | The number of samples maintained to compute metrics. | 2 | int +| *camel.component.kafka.configuration.offset-repository* | The offset repository to use in order to locally store the offset of + each partition of the topic. Defining one will disable the + autocommit. | | StateRepository +| *camel.component.kafka.configuration.partition-assignor* | The class name of the partition assignment strategy that the client + will use to distribute partition ownership amongst consumer instances + when group management is used | org.apache.kafka.clients.consumer.RangeAssignor | String +| *camel.component.kafka.configuration.partition-key* | The partition to which the record will be sent (or null if no + partition was specified). If this option has been configured then it + take precedence over header {@link KafkaConstants#PARTITION_KEY} | | int +| *camel.component.kafka.configuration.partitioner* | The partitioner class for partitioning messages amongst sub-topics. + The default partitioner is based on the hash of the key. | org.apache.kafka.clients.producer.internals.DefaultPartitioner | String +| *camel.component.kafka.configuration.poll-timeout-ms* | The timeout used when polling the KafkaConsumer. | 5000 | long +| *camel.component.kafka.configuration.producer-batch-size* | The producer will attempt to batch records together into fewer + requests whenever multiple records are being sent to the same + partition. This helps performance on both the client and the server. + This configuration controls the default batch size in bytes. No + attempt will be made to batch records larger than this size.Requests + sent to brokers will contain multiple batches, one for each partition + with data available to be sent.A small batch size will make batching + less common and may reduce throughput (a batch size of zero will + disable batching entirely). A very large batch size may use memory a + bit more wastefully as we will always allocate a buffer of the + specified batch size in anticipation of additional records. | 16384 | int +| *camel.component.kafka.configuration.queue-buffering-max-messages* | The maximum number of unsent messages that can be queued up the + producer when using async mode before either the producer must be + blocked or data must be dropped. | 10000 | int +| *camel.component.kafka.configuration.receive-buffer-bytes* | The size of the TCP receive buffer (SO_RCVBUF) to use when reading + data. | 65536 | int +| *camel.component.kafka.configuration.reconnect-backoff-max-ms* | The maximum amount of time in milliseconds to wait when reconnecting + to a broker that has repeatedly failed to connect. If provided, the + backoff per host will increase exponentially for each consecutive + connection failure, up to this maximum. After calculating the backoff + increase, 20% random jitter is added to avoid connection storms. | 1000 | int +| *camel.component.kafka.configuration.reconnect-backoff-ms* | The amount of time to wait before attempting to reconnect to a given + host. This avoids repeatedly connecting to a host in a tight loop. + This backoff applies to all requests sent by the consumer to the + broker. | 50 | int +| *camel.component.kafka.configuration.record-metadata* | Whether the producer should store the {@link RecordMetadata} results + from sending to Kafka. The results are stored in a {@link List} + containing the {@link RecordMetadata} metadata's. The list is stored + on a header with the key {@link KafkaConstants#KAFKA_RECORDMETA} | true | boolean +| *camel.component.kafka.configuration.request-required-acks* | The number of acknowledgments the producer requires the leader to + have received before considering a request complete. This controls + the durability of records that are sent. The following settings are + common: acks=0 If set to zero then the producer will not wait for any + acknowledgment from the server at all. The record will be immediately + added to the socket buffer and considered sent. No guarantee can be + made that the server has received the record in this case, and the + retries configuration will not take effect (as the client won't + generally know of any failures). The offset given back for each + record will always be set to -1. acks=1 This will mean the leader + will write the record to its local log but will respond without + awaiting full acknowledgement from all followers. In this case should + the leader fail immediately after acknowledging the record but before + the followers have replicated it then the record will be lost. + acks=all This means the leader will wait for the full set of in-sync + replicas to acknowledge the record. This guarantees that the record + will not be lost as long as at least one in-sync replica remains + alive. This is the strongest available guarantee. | 1 | String +| *camel.component.kafka.configuration.request-timeout-ms* | The amount of time the broker will wait trying to meet the + request.required.acks requirement before sending back an error to the + client. | 305000 | int +| *camel.component.kafka.configuration.retries* | Setting a value greater than zero will cause the client to resend any + record whose send fails with a potentially transient error. Note that + this retry is no different than if the client resent the record upon + receiving the error. Allowing retries will potentially change the + ordering of records because if two records are sent to a single + partition, and the first fails and is retried but the second + succeeds, then the second record may appear first. | 0 | int +| *camel.component.kafka.configuration.retry-backoff-ms* | Before each retry, the producer refreshes the metadata of relevant + topics to see if a new leader has been elected. Since leader election + takes a bit of time, this property specifies the amount of time that + the producer waits before refreshing the metadata. | 100 | int +| *camel.component.kafka.configuration.sasl-jaas-config* | Expose the kafka sasl.jaas.config parameter Example: + org.apache.kafka.common.security.plain.PlainLoginModule required + username="USERNAME" password="PASSWORD"; | | String +| *camel.component.kafka.configuration.sasl-kerberos-service-name* | The Kerberos principal name that Kafka runs as. This can be defined + either in Kafka's JAAS config or in Kafka's config. | | String +| *camel.component.kafka.configuration.sasl-mechanism* | The Simple Authentication and Security Layer (SASL) Mechanism used. + For the valid values see <a href= + "http://www.iana.org/assignments/sasl-mechanisms/sasl-mechanisms.xhtml" + >http://www.iana.org/assignments/sasl-mechanisms/sasl-mechanisms. + xhtml</a> | GSSAPI | String +| *camel.component.kafka.configuration.security-protocol* | Protocol used to communicate with brokers. Currently only PLAINTEXT + and SSL are supported. | PLAINTEXT | String +| *camel.component.kafka.configuration.seek-to* | Set if KafkaConsumer will read from beginning or end on startup: + beginning : read from beginning end : read from end This is replacing + the earlier property seekToBeginning | | String +| *camel.component.kafka.configuration.send-buffer-bytes* | Socket write buffer size | 131072 | int +| *camel.component.kafka.configuration.serializer-class* | The serializer class for messages. | org.apache.kafka.common.serialization.StringSerializer | String +| *camel.component.kafka.configuration.session-timeout-ms* | The timeout used to detect failures when using Kafka's group + management facilities. | 10000 | int +| *camel.component.kafka.configuration.ssl-cipher-suites* | A list of cipher suites. This is a named combination of + authentication, encryption, MAC and key exchange algorithm used to + negotiate the security settings for a network connection using TLS or + SSL network protocol.By default all the available cipher suites are + supported. | | String +| *camel.component.kafka.configuration.ssl-context-parameters.camel-context* | null | | CamelContext +| *camel.component.kafka.configuration.ssl-context-parameters.cert-alias* | null | | String +| *camel.component.kafka.configuration.ssl-context-parameters.cipher-suites* | null | | CipherSuitesParameters +| *camel.component.kafka.configuration.ssl-context-parameters.cipher-suites-filter* | null | | FilterParameters +| *camel.component.kafka.configuration.ssl-context-parameters.client-parameters* | null | | SSLContextClientParameters +| *camel.component.kafka.configuration.ssl-context-parameters.key-managers* | null | | KeyManagersParameters +| *camel.component.kafka.configuration.ssl-context-parameters.provider* | null | | String +| *camel.component.kafka.configuration.ssl-context-parameters.secure-random* | null | | SecureRandomParameters +| *camel.component.kafka.configuration.ssl-context-parameters.secure-socket-protocol* | null | | String +| *camel.component.kafka.configuration.ssl-context-parameters.secure-socket-protocols* | null | | SecureSocketProtocolsParameters +| *camel.component.kafka.configuration.ssl-context-parameters.secure-socket-protocols-filter* | null | | FilterParameters +| *camel.component.kafka.configuration.ssl-context-parameters.server-parameters* | null | | SSLContextServerParameters +| *camel.component.kafka.configuration.ssl-context-parameters.session-timeout* | null | | String +| *camel.component.kafka.configuration.ssl-context-parameters.trust-managers* | null | | TrustManagersParameters +| *camel.component.kafka.configuration.ssl-enabled-protocols* | The list of protocols enabled for SSL connections. TLSv1.2, TLSv1.1 + and TLSv1 are enabled by default. | TLSv1.2,TLSv1.1,TLSv1 | String +| *camel.component.kafka.configuration.ssl-endpoint-algorithm* | The endpoint identification algorithm to validate server hostname + using server certificate. | | String +| *camel.component.kafka.configuration.ssl-key-password* | The password of the private key in the key store file. This is + optional for client. | | String +| *camel.component.kafka.configuration.ssl-keymanager-algorithm* | The algorithm used by key manager factory for SSL connections. + Default value is the key manager factory algorithm configured for the + Java Virtual Machine. | SunX509 | String +| *camel.component.kafka.configuration.ssl-keystore-location* | The location of the key store file. This is optional for client and + can be used for two-way authentication for client. | | String +| *camel.component.kafka.configuration.ssl-keystore-password* | The store password for the key store file.This is optional for client + and only needed if ssl.keystore.location is configured. | | String +| *camel.component.kafka.configuration.ssl-keystore-type* | The file format of the key store file. This is optional for client. + Default value is JKS | JKS | String +| *camel.component.kafka.configuration.ssl-protocol* | The SSL protocol used to generate the SSLContext. Default setting is + TLS, which is fine for most cases. Allowed values in recent JVMs are + TLS, TLSv1.1 and TLSv1.2. SSL, SSLv2 and SSLv3 may be supported in + older JVMs, but their usage is discouraged due to known security + vulnerabilities. | TLS | String +| *camel.component.kafka.configuration.ssl-provider* | The name of the security provider used for SSL connections. Default + value is the default security provider of the JVM. | | String +| *camel.component.kafka.configuration.ssl-trustmanager-algorithm* | The algorithm used by trust manager factory for SSL connections. + Default value is the trust manager factory algorithm configured for + the Java Virtual Machine. | PKIX | String +| *camel.component.kafka.configuration.ssl-truststore-location* | The location of the trust store file. | | String +| *camel.component.kafka.configuration.ssl-truststore-password* | The password for the trust store file. | | String +| *camel.component.kafka.configuration.ssl-truststore-type* | The file format of the trust store file. Default value is JKS. | JKS | String +| *camel.component.kafka.configuration.topic* | Name of the topic to use. On the consumer you can use comma to + separate multiple topics. A producer can only send a message to a + single topic. | | String +| *camel.component.kafka.configuration.topic-is-pattern* | Whether the topic is a pattern (regular expression). This can be used + to subscribe to dynamic number of topics matching the pattern. | false | boolean +| *camel.component.kafka.configuration.value-deserializer* | Deserializer class for value that implements the Deserializer + interface. | org.apache.kafka.common.serialization.StringDeserializer | String +| *camel.component.kafka.configuration.worker-pool* | To use a custom worker pool for continue routing {@link Exchange} + after kafka server has acknowledge the message that was sent to it + from {@link KafkaProducer} using asynchronous non-blocking + processing. | | ExecutorService +| *camel.component.kafka.configuration.worker-pool-core-size* | Number of core threads for the worker pool for continue routing + {@link Exchange} after kafka server has acknowledge the message that + was sent to it from {@link KafkaProducer} using asynchronous + non-blocking processing. | 10 | int +| *camel.component.kafka.configuration.worker-pool-max-size* | Maximum number of threads for the worker pool for continue routing + {@link Exchange} after kafka server has acknowledge the message that + was sent to it from {@link KafkaProducer} using asynchronous + non-blocking processing. | 20 | int +| *camel.component.kafka.enabled* | Enable kafka component | true | boolean +| *camel.component.kafka.kafka-manual-commit-factory* | Factory to use for creating KafkaManualCommit instances. This allows to + plugin a custom factory to create custom KafkaManualCommit instances in + case special logic is needed when doing manual commits that deviates from + the default implementation that comes out of the box. The option is a + org.apache.camel.component.kafka.KafkaManualCommitFactory type. | | String +| *camel.component.kafka.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.kafka.use-global-ssl-context-parameters* | Enable usage of global SSL context parameters. | false | boolean +| *camel.component.kafka.worker-pool* | To use a shared custom worker pool for continue routing Exchange after + kafka server has acknowledge the message that was sent to it from + KafkaProducer using asynchronous non-blocking processing. If using this + option then you must handle the lifecycle of the thread pool to shut the + pool down when no longer needed. The option is a + java.util.concurrent.ExecutorService type. | | String +|=== +// spring-boot-auto-configure options: END For more information about Producer/Consumer configuration: diff --git a/components/camel-lzf/src/main/docs/lzf-dataformat.adoc b/components/camel-lzf/src/main/docs/lzf-dataformat.adoc index 02ff9a9..abcb418 100644 --- a/components/camel-lzf/src/main/docs/lzf-dataformat.adoc +++ b/components/camel-lzf/src/main/docs/lzf-dataformat.adoc @@ -26,6 +26,26 @@ The LZF Deflate Compression dataformat supports 2 options, which are listed belo | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSon etc. |=== // dataformat 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.dataformat.lzf.content-type-header* | Whether the data format should set the Content-Type header with the type + from the data format if the data format is capable of doing so. For + example application/xml for data formats marshalling to XML, or + application/json for data formats marshalling to JSon etc. | false | boolean +| *camel.dataformat.lzf.enabled* | Enable lzf dataformat | true | boolean +| *camel.dataformat.lzf.using-parallel-compression* | Enable encoding (compress) using multiple processing cores. | false | boolean +|=== +// spring-boot-auto-configure options: END +ND ### Marshal diff --git a/components/camel-mvel/src/main/docs/mvel-language.adoc b/components/camel-mvel/src/main/docs/mvel-language.adoc index ec0bc84..110fe26 100644 --- a/components/camel-mvel/src/main/docs/mvel-language.adoc +++ b/components/camel-mvel/src/main/docs/mvel-language.adoc @@ -36,6 +36,27 @@ The MVEL language supports 1 options, which are listed below. | trim | true | Boolean | Whether to trim the value to remove leading and trailing whitespaces and line breaks |=== // language 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.mvel.enabled* | Enable mvel component | true | boolean +| *camel.component.mvel.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.language.mvel.enabled* | Enable mvel language | true | boolean +| *camel.language.mvel.trim* | Whether to trim the value to remove leading and trailing whitespaces and + line breaks | true | boolean +|=== +// spring-boot-auto-configure options: END + ### Variables @@ -117,4 +138,4 @@ the download page for the latest versions). <artifactId>camel-mvel</artifactId> <version>x.x.x</version> </dependency> -------------------------------------- \ No newline at end of file +------------------------------------- diff --git a/components/camel-ognl/src/main/docs/ognl-language.adoc b/components/camel-ognl/src/main/docs/ognl-language.adoc index f3518d4..f498179 100644 --- a/components/camel-ognl/src/main/docs/ognl-language.adoc +++ b/components/camel-ognl/src/main/docs/ognl-language.adoc @@ -38,6 +38,23 @@ The OGNL language supports 1 options, which are listed below. | trim | true | Boolean | Whether to trim the value to remove leading and trailing whitespaces and line breaks |=== // language 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.language.ognl.enabled* | Enable ognl language | true | boolean +| *camel.language.ognl.trim* | Whether to trim the value to remove leading and trailing whitespaces and + line breaks | true | boolean +|=== +// spring-boot-auto-configure options: END + @@ -124,4 +141,4 @@ the download page for the latest versions). ------------------------------------- Otherwise, you'll also need -http://repo2.maven.org/maven2/org/apache/servicemix/bundles/org.apache.servicemix.bundles.ognl/2.7.3_4/org.apache.servicemix.bundles.ognl-2.7.3_4.jar[OGNL] \ No newline at end of file +http://repo2.maven.org/maven2/org/apache/servicemix/bundles/org.apache.servicemix.bundles.ognl/2.7.3_4/org.apache.servicemix.bundles.ognl-2.7.3_4.jar[OGNL] diff --git a/components/camel-protobuf/src/main/docs/protobuf-dataformat.adoc b/components/camel-protobuf/src/main/docs/protobuf-dataformat.adoc index e234c9e..99f935d 100644 --- a/components/camel-protobuf/src/main/docs/protobuf-dataformat.adoc +++ b/components/camel-protobuf/src/main/docs/protobuf-dataformat.adoc @@ -36,6 +36,30 @@ The Protobuf dataformat supports 3 options, which are listed below. | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSon etc. |=== // dataformat 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.dataformat.protobuf.content-type-format* | Defines a content type format in which protobuf message will be + serialized/deserialized from(to) the Java been. The format can either be + native or json for either native protobuf or json fields representation. + The default value is native. | native | String +| *camel.dataformat.protobuf.content-type-header* | Whether the data format should set the Content-Type header with the type + from the data format if the data format is capable of doing so. For + example application/xml for data formats marshalling to XML, or + application/json for data formats marshalling to JSon etc. | false | boolean +| *camel.dataformat.protobuf.enabled* | Enable protobuf dataformat | true | boolean +| *camel.dataformat.protobuf.instance-class* | Name of class to use when unarmshalling | | String +|=== +// spring-boot-auto-configure options: END +ND ### Content type format (starting from *Camel 2.19*) diff --git a/components/camel-rss/src/main/docs/rss-dataformat.adoc b/components/camel-rss/src/main/docs/rss-dataformat.adoc index f57c341..a4b0914 100644 --- a/components/camel-rss/src/main/docs/rss-dataformat.adoc +++ b/components/camel-rss/src/main/docs/rss-dataformat.adoc @@ -34,3 +34,26 @@ The RSS dataformat supports 1 options, which are listed below. | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSon etc. |=== // dataformat 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.rss.enabled* | Enable rss component | true | boolean +| *camel.component.rss.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.dataformat.rss.content-type-header* | Whether the data format should set the Content-Type header with the type + from the data format if the data format is capable of doing so. For + example application/xml for data formats marshalling to XML, or + application/json for data formats marshalling to JSon etc. | false | boolean +| *camel.dataformat.rss.enabled* | Enable rss dataformat | true | boolean +|=== +// spring-boot-auto-configure options: END +ND diff --git a/components/camel-soap/src/main/docs/soapjaxb-dataformat.adoc b/components/camel-soap/src/main/docs/soapjaxb-dataformat.adoc index 631d120..23d7a0e 100644 --- a/components/camel-soap/src/main/docs/soapjaxb-dataformat.adoc +++ b/components/camel-soap/src/main/docs/soapjaxb-dataformat.adoc @@ -37,6 +37,53 @@ The SOAP dataformat supports 7 options, which are listed below. | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSon etc. |=== // dataformat options: END +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 8 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.dataformat.soapjaxb.content-type-header* | Whether the data format should set the Content-Type header with the type + from the data format if the data format is capable of doing so. For + example application/xml for data formats marshalling to XML, or + application/json for data formats marshalling to JSon etc. | false | boolean +| *camel.dataformat.soapjaxb.context-path* | Package name where your JAXB classes are located. | | String +| *camel.dataformat.soapjaxb.element-name-strategy-ref* | Refers to an element strategy to lookup from the registry. An element + name strategy is used for two purposes. The first is to find a xml + element name for a given object and soap action when marshaling the + object into a SOAP message. The second is to find an Exception class for + a given soap fault name. The following three element strategy class name + is provided out of the box. QNameStrategy - Uses a fixed qName that is + configured on instantiation. Exception lookup is not supported + TypeNameStrategy - Uses the name and namespace from the XMLType + annotation of the given type. If no namespace is set then package-info is + used. Exception lookup is not supported ServiceInterfaceStrategy - Uses + information from a webservice interface to determine the type name and to + find the exception class for a SOAP fault All three classes is located in + the package name org.apache.camel.dataformat.soap.name If you have + generated the web service stub code with cxf-codegen or a similar tool + then you probably will want to use the ServiceInterfaceStrategy. In the + case you have no annotated service interface you should use QNameStrategy + or TypeNameStrategy. | | String +| *camel.dataformat.soapjaxb.enabled* | Enable soapjaxb dataformat | true | boolean +| *camel.dataformat.soapjaxb.encoding* | To overrule and use a specific encoding | | String +| *camel.dataformat.soapjaxb.namespace-prefix-ref* | When marshalling using JAXB or SOAP then the JAXB implementation will + automatic assign namespace prefixes, such as ns2, ns3, ns4 etc. To + control this mapping, Camel allows you to refer to a map which contains + the desired mapping. | | String +| *camel.dataformat.soapjaxb.schema* | To validate against an existing schema. Your can use the prefix + classpath:, file: or http: to specify how the resource should by + resolved. You can separate multiple schema files by using the ',' + character. | | String +| *camel.dataformat.soapjaxb.version* | SOAP version should either be 1.1 or 1.2. Is by default 1.1 | 1.1 | String +|=== +// spring-boot-auto-configure options: END +ND diff --git a/components/camel-syslog/src/main/docs/syslog-dataformat.adoc b/components/camel-syslog/src/main/docs/syslog-dataformat.adoc index 0de9792..5a89792 100644 --- a/components/camel-syslog/src/main/docs/syslog-dataformat.adoc +++ b/components/camel-syslog/src/main/docs/syslog-dataformat.adoc @@ -58,6 +58,25 @@ The Syslog dataformat supports 1 options, which are listed below. | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSon etc. |=== // dataformat 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.dataformat.syslog.content-type-header* | Whether the data format should set the Content-Type header with the type + from the data format if the data format is capable of doing so. For + example application/xml for data formats marshalling to XML, or + application/json for data formats marshalling to JSon etc. | false | boolean +| *camel.dataformat.syslog.enabled* | Enable syslog dataformat | true | boolean +|=== +// spring-boot-auto-configure options: END +ND ### RFC5424 Syslog protocol diff --git a/components/camel-tarfile/src/main/docs/tarfile-dataformat.adoc b/components/camel-tarfile/src/main/docs/tarfile-dataformat.adoc index 4d3fed3..40b02a4 100644 --- a/components/camel-tarfile/src/main/docs/tarfile-dataformat.adoc +++ b/components/camel-tarfile/src/main/docs/tarfile-dataformat.adoc @@ -28,6 +28,32 @@ The Tar File dataformat supports 4 options, which are listed below. | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSon etc. |=== // dataformat 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.dataformat.tarfile.allow-empty-directory* | If the tar file has more then one entry, setting this option to true, + allows to get the iterator even if the directory is empty | false | boolean +| *camel.dataformat.tarfile.content-type-header* | Whether the data format should set the Content-Type header with the type + from the data format if the data format is capable of doing so. For + example application/xml for data formats marshalling to XML, or + application/json for data formats marshalling to JSon etc. | false | boolean +| *camel.dataformat.tarfile.enabled* | Enable tarfile dataformat | true | boolean +| *camel.dataformat.tarfile.preserve-path-elements* | If the file name contains path elements, setting this option to true, + allows the path to be maintained in the tar file. | false | boolean +| *camel.dataformat.tarfile.using-iterator* | If the tar file has more then one entry, the setting this option to true, + allows to work with the splitter EIP, to split the data using an iterator + in a streaming mode. | false | boolean +|=== +// spring-boot-auto-configure options: END +ND ### Marshal diff --git a/components/camel-thrift/src/main/docs/thrift-dataformat.adoc b/components/camel-thrift/src/main/docs/thrift-dataformat.adoc index d30af74..7bd8da4 100644 --- a/components/camel-thrift/src/main/docs/thrift-dataformat.adoc +++ b/components/camel-thrift/src/main/docs/thrift-dataformat.adoc @@ -29,6 +29,35 @@ The Thrift dataformat supports 3 options, which are listed below. | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSon etc. |=== // dataformat 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.thrift.enabled* | null | | boolean +| *camel.component.thrift.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.thrift.use-global-ssl-context-parameters* | Determine if the thrift component is using global SSL context parameters | false | boolean +| *camel.dataformat.thrift.content-type-format* | Defines a content type format in which thrift message will be + serialized/deserialized from(to) the Java been. The format can either be + native or json for either native binary thrift, json or simple json + fields representation. The default value is binary. | binary | String +| *camel.dataformat.thrift.content-type-header* | Whether the data format should set the Content-Type header with the type + from the data format if the data format is capable of doing so. For + example application/xml for data formats marshalling to XML, or + application/json for data formats marshalling to JSon etc. | false | boolean +| *camel.dataformat.thrift.enabled* | null | | boolean +| *camel.dataformat.thrift.instance-class* | Name of class to use when unarmshalling | | String +|=== +// spring-boot-auto-configure options: END +ND ### Content type format diff --git a/components/camel-xmljson/src/main/docs/xmljson-dataformat.adoc b/components/camel-xmljson/src/main/docs/xmljson-dataformat.adoc index bcde5ef..a6dcae0 100644 --- a/components/camel-xmljson/src/main/docs/xmljson-dataformat.adoc +++ b/components/camel-xmljson/src/main/docs/xmljson-dataformat.adoc @@ -43,6 +43,64 @@ The XML JSon dataformat supports 13 options, which are listed below. | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSon etc. |=== // dataformat options: END +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 14 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.dataformat.xmljson.array-name* | Specifies the name of the top-level XML element. Used for unmarshalling + (JSON to XML conversion). For example, when converting 1, 2, 3, it will + be output by default as 123. By setting this option or rootName, you can + alter the name of element 'a'. | | String +| *camel.dataformat.xmljson.content-type-header* | Whether the data format should set the Content-Type header with the type + from the data format if the data format is capable of doing so. For + example application/xml for data formats marshalling to XML, or + application/json for data formats marshalling to JSon etc. | false | boolean +| *camel.dataformat.xmljson.element-name* | Specifies the name of the XML elements representing each array element. + Used for unmarshalling (JSON to XML conversion). | | String +| *camel.dataformat.xmljson.enabled* | Enable xmljson dataformat | true | boolean +| *camel.dataformat.xmljson.encoding* | Sets the encoding. Used for unmarshalling (JSON to XML conversion). | | String +| *camel.dataformat.xmljson.expandable-properties* | With expandable properties, JSON array elements are converted to XML as a + sequence of repetitive XML elements with the local name equal to the JSON + key, for example: number: 1,2,3 , normally converted to: 123 (where e can + be modified by setting elementName), would instead translate to 123, if + number is set as an expandable property Used for unmarshalling (JSON to + XML conversion). | | List +| *camel.dataformat.xmljson.force-top-level-object* | Determines whether the resulting JSON will start off with a top-most + element whose name matches the XML root element. Used for marshalling + (XML to JSon conversion). If disabled, XML string 12 turns into 'x: '1', + 'y': '2' . Otherwise, it turns into 'a': 'x: '1', 'y': '2' . | false | boolean +| *camel.dataformat.xmljson.namespace-lenient* | Flag to be tolerant to incomplete namespace prefixes. Used for + unmarshalling (JSON to XML conversion). In most cases, json-lib + automatically changes this flag at runtime to match the processing. | false | boolean +| *camel.dataformat.xmljson.remove-namespace-prefixes* | Removes the namespace prefixes from XML qualified elements, so that the + resulting JSON string does not contain them. Used for marshalling (XML to + JSon conversion). | false | boolean +| *camel.dataformat.xmljson.root-name* | Specifies the name of the top-level element. Used for unmarshalling (JSON + to XML conversion). If not set, json-lib will use arrayName or objectName + (default value: 'o', at the current time it is not configurable in this + data format). If set to 'root', the JSON string 'x': 'value1', 'y' : + 'value2' would turn into value1value2, otherwise the 'root' element would + be named 'o'. | | String +| *camel.dataformat.xmljson.skip-namespaces* | Signals whether namespaces should be ignored. By default they will be + added to the JSON output using xmlns elements. Used for marshalling (XML + to JSon conversion). | false | boolean +| *camel.dataformat.xmljson.skip-whitespace* | Determines whether white spaces between XML elements will be regarded as + text values or disregarded. Used for marshalling (XML to JSon + conversion). | false | boolean +| *camel.dataformat.xmljson.trim-spaces* | Determines whether leading and trailing white spaces will be omitted from + String values. Used for marshalling (XML to JSon conversion). | false | boolean +| *camel.dataformat.xmljson.type-hints* | Adds type hints to the resulting XML to aid conversion back to JSON. Used + for unmarshalling (JSON to XML conversion). | | String +|=== +// spring-boot-auto-configure options: END +ND ### Basic Usage with Java DSL diff --git a/components/camel-xmlrpc/src/main/docs/xmlrpc-dataformat.adoc b/components/camel-xmlrpc/src/main/docs/xmlrpc-dataformat.adoc index 5612f76..2365122 100644 --- a/components/camel-xmlrpc/src/main/docs/xmlrpc-dataformat.adoc +++ b/components/camel-xmlrpc/src/main/docs/xmlrpc-dataformat.adoc @@ -51,3 +51,27 @@ The XML RPC dataformat supports 2 options, which are listed below. | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSon etc. |=== // dataformat 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.xmlrpc.enabled* | Enable xmlrpc component | true | boolean +| *camel.component.xmlrpc.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.dataformat.xmlrpc.content-type-header* | Whether the data format should set the Content-Type header with the type + from the data format if the data format is capable of doing so. For + example application/xml for data formats marshalling to XML, or + application/json for data formats marshalling to JSon etc. | false | boolean +| *camel.dataformat.xmlrpc.enabled* | Enable xmlrpc dataformat | true | boolean +| *camel.dataformat.xmlrpc.request* | Whether to marshal/unmarshal request or response Is by default false | false | boolean +|=== +// spring-boot-auto-configure options: END +ND diff --git a/components/camel-xstream/src/main/docs/xstream-dataformat.adoc b/components/camel-xstream/src/main/docs/xstream-dataformat.adoc index 207e3ed..97d469b 100644 --- a/components/camel-xstream/src/main/docs/xstream-dataformat.adoc +++ b/components/camel-xstream/src/main/docs/xstream-dataformat.adoc @@ -45,6 +45,118 @@ The XStream dataformat supports 10 options, which are listed below. | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSon etc. |=== // dataformat options: END +// spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + + +The component supports 31 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.dataformat.json-xstream.allow-jms-type* | Used for JMS users to allow the JMSType header from the JMS spec to + specify a FQN classname to use to unmarshal to. | false | boolean +| *camel.dataformat.json-xstream.allow-unmarshall-type* | If enabled then Jackson is allowed to attempt to use the + CamelJacksonUnmarshalType header during the unmarshalling. This should + only be enabled when desired to be used. | false | boolean +| *camel.dataformat.json-xstream.collection-type-name* | Refers to a custom collection type to lookup in the registry to use. This + option should rarely be used, but allows to use different collection + types than java.util.Collection based as default. | | String +| *camel.dataformat.json-xstream.content-type-header* | Whether the data format should set the Content-Type header with the type + from the data format if the data format is capable of doing so. For + example application/xml for data formats marshalling to XML, or + application/json for data formats marshalling to JSon etc. | false | boolean +| *camel.dataformat.json-xstream.disable-features* | Set of features to disable on the Jackson + com.fasterxml.jackson.databind.ObjectMapper. The features should be a + name that matches a enum from + com.fasterxml.jackson.databind.SerializationFeature, + com.fasterxml.jackson.databind.DeserializationFeature, or + com.fasterxml.jackson.databind.MapperFeature Multiple features can be + separated by comma | | String +| *camel.dataformat.json-xstream.enable-features* | Set of features to enable on the Jackson + com.fasterxml.jackson.databind.ObjectMapper. The features should be a + name that matches a enum from + com.fasterxml.jackson.databind.SerializationFeature, + com.fasterxml.jackson.databind.DeserializationFeature, or + com.fasterxml.jackson.databind.MapperFeature Multiple features can be + separated by comma | | String +| *camel.dataformat.json-xstream.enable-jaxb-annotation-module* | Whether to enable the JAXB annotations module when using jackson. When + enabled then JAXB annotations can be used by Jackson. | false | boolean +| *camel.dataformat.json-xstream.enabled* | Enable json-xstream dataformat | true | boolean +| *camel.dataformat.json-xstream.include* | If you want to marshal a pojo to JSON, and the pojo has some fields with + null values. And you want to skip these null values, you can set this + option to NOT_NULL | | String +| *camel.dataformat.json-xstream.json-view* | When marshalling a POJO to JSON you might want to exclude certain fields + from the JSON output. With Jackson you can use JSON views to accomplish + this. This option is to refer to the class which has JsonView annotations | | class +| *camel.dataformat.json-xstream.library* | Which json library to use. | | JsonLibrary +| *camel.dataformat.json-xstream.module-class-names* | To use custom Jackson modules com.fasterxml.jackson.databind.Module + specified as a String with FQN class names. Multiple classes can be + separated by comma. | | String +| *camel.dataformat.json-xstream.module-refs* | To use custom Jackson modules referred from the Camel registry. Multiple + modules can be separated by comma. | | String +| *camel.dataformat.json-xstream.object-mapper* | Lookup and use the existing ObjectMapper with the given id when using + Jackson. | | String +| *camel.dataformat.json-xstream.permissions* | Adds permissions that controls which Java packages and classes XStream is + allowed to use during unmarshal from xml/json to Java beans. A permission + must be configured either here or globally using a JVM system property. + The permission can be specified in a syntax where a plus sign is allow, + and minus sign is deny. Wildcards is supported by using . as prefix. For + example to allow com.foo and all subpackages then specfy com.foo.. + Multiple permissions can be configured separated by comma, such as + com.foo.,-com.foo.bar.MySecretBean. The following default permission is + always included: -,java.lang.,java.util. unless its overridden by + specifying a JVM system property with they key + org.apache.camel.xstream.permissions. | | String +| *camel.dataformat.json-xstream.pretty-print* | To enable pretty printing output nicely formatted. Is by default false. | false | boolean +| *camel.dataformat.json-xstream.timezone* | If set then Jackson will use the Timezone when marshalling/unmarshalling. + This option will have no effect on the others Json DataFormat, like gson, + fastjson and xstream. | | String +| *camel.dataformat.json-xstream.unmarshal-type-name* | Class name of the java type to use when unarmshalling | | String +| *camel.dataformat.json-xstream.use-default-object-mapper* | Whether to lookup and use default Jackson ObjectMapper from the registry. | true | boolean +| *camel.dataformat.json-xstream.use-list* | To unarmshal to a List of Map or a List of Pojo. | false | boolean +| *camel.dataformat.xstream.aliases* | Alias a Class to a shorter name to be used in XML elements. The option is + a java.util.Map<java.lang.String,java.lang.String> type. | | String +| *camel.dataformat.xstream.content-type-header* | Whether the data format should set the Content-Type header with the type + from the data format if the data format is capable of doing so. For + example application/xml for data formats marshalling to XML, or + application/json for data formats marshalling to JSon etc. | false | boolean +| *camel.dataformat.xstream.converters* | List of class names for using custom XStream converters. The classes must + be of type com.thoughtworks.xstream.converters.Converter | | List +| *camel.dataformat.xstream.driver* | To use a custom XStream driver. The instance must be of type + com.thoughtworks.xstream.io.HierarchicalStreamDriver | | String +| *camel.dataformat.xstream.driver-ref* | To refer to a custom XStream driver to lookup in the registry. The + instance must be of type + com.thoughtworks.xstream.io.HierarchicalStreamDriver | | String +| *camel.dataformat.xstream.enabled* | Enable xstream dataformat | true | boolean +| *camel.dataformat.xstream.encoding* | Sets the encoding to use | | String +| *camel.dataformat.xstream.implicit-collections* | Adds a default implicit collection which is used for any unmapped XML + tag. The option is a java.util.Map<java.lang.String,java.lang.String[]> + type. | | String +| *camel.dataformat.xstream.mode* | Mode for dealing with duplicate references The possible values are: + NO_REFERENCES ID_REFERENCES XPATH_RELATIVE_REFERENCES + XPATH_ABSOLUTE_REFERENCES SINGLE_NODE_XPATH_RELATIVE_REFERENCES + SINGLE_NODE_XPATH_ABSOLUTE_REFERENCES | | String +| *camel.dataformat.xstream.omit-fields* | Prevents a field from being serialized. To omit a field you must always + provide the declaring type and not necessarily the type that is + converted. The option is a + java.util.Map<java.lang.String,java.lang.String[]> type. | | String +| *camel.dataformat.xstream.permissions* | Adds permissions that controls which Java packages and classes XStream is + allowed to use during unmarshal from xml/json to Java beans. A permission + must be configured either here or globally using a JVM system property. + The permission can be specified in a syntax where a plus sign is allow, + and minus sign is deny. Wildcards is supported by using . as prefix. For + example to allow com.foo and all subpackages then specfy com.foo.. + Multiple permissions can be configured separated by comma, such as + com.foo.,-com.foo.bar.MySecretBean. The following default permission is + always included: -,java.lang.,java.util. unless its overridden by + specifying a JVM system property with they key + org.apache.camel.xstream.permissions. | | String +|=== +// spring-boot-auto-configure options: END +ND ### Using the Java DSL diff --git a/components/camel-zipfile/src/main/docs/zipfile-dataformat.adoc b/components/camel-zipfile/src/main/docs/zipfile-dataformat.adoc index 6994d1e..0485ab5 100644 --- a/components/camel-zipfile/src/main/docs/zipfile-dataformat.adoc +++ b/components/camel-zipfile/src/main/docs/zipfile-dataformat.adoc @@ -25,6 +25,32 @@ The Zip File dataformat supports 4 options, which are listed below. | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSon etc. |=== // dataformat 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.dataformat.zipfile.allow-empty-directory* | If the zip file has more then one entry, setting this option to true, + allows to get the iterator even if the directory is empty | false | boolean +| *camel.dataformat.zipfile.content-type-header* | Whether the data format should set the Content-Type header with the type + from the data format if the data format is capable of doing so. For + example application/xml for data formats marshalling to XML, or + application/json for data formats marshalling to JSon etc. | false | boolean +| *camel.dataformat.zipfile.enabled* | Enable zipfile dataformat | true | boolean +| *camel.dataformat.zipfile.preserve-path-elements* | If the file name contains path elements, setting this option to true, + allows the path to be maintained in the zip file. | false | boolean +| *camel.dataformat.zipfile.using-iterator* | If the zip file has more then one entry, the setting this option to true, + allows to work with the splitter EIP, to split the data using an iterator + in a streaming mode. | false | boolean +|=== +// spring-boot-auto-configure options: END +ND === Marshal diff --git a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/UpdateSpringBootAutoConfigurationReadmeMojo.java b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/UpdateSpringBootAutoConfigurationReadmeMojo.java index ffab8a8..0fad8af 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/UpdateSpringBootAutoConfigurationReadmeMojo.java +++ b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/UpdateSpringBootAutoConfigurationReadmeMojo.java @@ -174,17 +174,6 @@ public class UpdateSpringBootAutoConfigurationReadmeMojo extends AbstractMojo { String text = loadText(new FileInputStream(file)); String existing = StringHelper.between(text, "// spring-boot-auto-configure options: START", "// spring-boot-auto-configure options: END"); - if (existing == null) { - // attach to the end of the endpoint options - int pos = text.indexOf("// endpoint options: END"); - if (pos != -1) { - String before = text.substring(0, pos); - String after = text.substring(pos + 24); - text = before + "// endpoint options: END\n// spring-boot-auto-configure options: START\n// spring-boot-auto-configure options: END\n" + after; - writeText(file, text); - existing = StringHelper.between(text, "// spring-boot-auto-configure options: START", "// spring-boot-auto-configure options: END"); - } - } if (existing != null) { // remove leading line breaks etc existing = existing.trim();