This is an automated email from the ASF dual-hosted git repository. zregvart pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/camel.git
commit 138189d512144edb46b401309694f1435ee810b1 Author: Zoran Regvart <zregv...@apache.org> AuthorDate: Wed Jul 3 13:20:40 2019 +0200 CAMEL-13588: escape $ in options Unescaped dollar signs in assciidoc files are interpreted as attribute references, this adds automatic escaping of dollar signs via MVEL templates. --- .../camel-aws-ddb/src/main/docs/aws-ddb-component.adoc | 2 +- .../camel-aws-ddb/src/main/docs/aws-ddbstream-component.adoc | 2 +- .../camel-aws-ec2/src/main/docs/aws-ec2-component.adoc | 2 +- .../camel-aws-ecs/src/main/docs/aws-ecs-component.adoc | 2 +- .../camel-aws-eks/src/main/docs/aws-eks-component.adoc | 2 +- .../camel-aws-iam/src/main/docs/aws-iam-component.adoc | 2 +- .../src/main/docs/aws-kinesis-component.adoc | 2 +- .../src/main/docs/aws-kinesis-firehose-component.adoc | 2 +- .../camel-aws-kms/src/main/docs/aws-kms-component.adoc | 2 +- .../camel-aws-lambda/src/main/docs/aws-lambda-component.adoc | 2 +- components/camel-aws-mq/src/main/docs/aws-mq-component.adoc | 2 +- .../camel-aws-msk/src/main/docs/aws-msk-component.adoc | 2 +- components/camel-aws-s3/src/main/docs/aws-s3-component.adoc | 2 +- .../camel-aws-sdb/src/main/docs/aws-sdb-component.adoc | 2 +- .../camel-aws-ses/src/main/docs/aws-ses-component.adoc | 2 +- .../camel-aws-sns/src/main/docs/aws-sns-component.adoc | 2 +- .../camel-aws-sqs/src/main/docs/aws-sqs-component.adoc | 2 +- .../camel-aws-swf/src/main/docs/aws-swf-component.adoc | 2 +- components/camel-file/src/main/docs/file-component.adoc | 12 ++++++------ components/camel-ftp/src/main/docs/ftp-component.adoc | 10 +++++----- components/camel-ftp/src/main/docs/ftps-component.adoc | 10 +++++----- components/camel-ftp/src/main/docs/sftp-component.adoc | 10 +++++----- .../src/main/docs/google-bigquery-sql-component.adoc | 2 +- components/camel-grok/src/main/docs/grok-dataformat.adoc | 4 ++-- components/camel-grpc/src/main/docs/grpc-component.adoc | 2 +- .../camel-hipchat/src/main/docs/hipchat-component.adoc | 2 +- components/camel-jsch/src/main/docs/scp-component.adoc | 2 +- .../camel-jsonpath/src/main/docs/jsonpath-language.adoc | 2 +- .../camel-protobuf/src/main/docs/protobuf-dataformat.adoc | 2 +- docs/components/modules/ROOT/pages/aws-ddb-component.adoc | 2 +- .../modules/ROOT/pages/aws-ddbstream-component.adoc | 2 +- docs/components/modules/ROOT/pages/aws-ec2-component.adoc | 2 +- docs/components/modules/ROOT/pages/aws-ecs-component.adoc | 2 +- docs/components/modules/ROOT/pages/aws-eks-component.adoc | 2 +- docs/components/modules/ROOT/pages/aws-iam-component.adoc | 2 +- .../components/modules/ROOT/pages/aws-kinesis-component.adoc | 2 +- .../modules/ROOT/pages/aws-kinesis-firehose-component.adoc | 2 +- docs/components/modules/ROOT/pages/aws-kms-component.adoc | 2 +- docs/components/modules/ROOT/pages/aws-lambda-component.adoc | 2 +- docs/components/modules/ROOT/pages/aws-mq-component.adoc | 2 +- docs/components/modules/ROOT/pages/aws-msk-component.adoc | 2 +- docs/components/modules/ROOT/pages/aws-s3-component.adoc | 2 +- docs/components/modules/ROOT/pages/aws-sdb-component.adoc | 2 +- docs/components/modules/ROOT/pages/aws-ses-component.adoc | 2 +- docs/components/modules/ROOT/pages/aws-sns-component.adoc | 2 +- docs/components/modules/ROOT/pages/aws-sqs-component.adoc | 2 +- docs/components/modules/ROOT/pages/aws-swf-component.adoc | 2 +- docs/components/modules/ROOT/pages/file-component.adoc | 12 ++++++------ docs/components/modules/ROOT/pages/ftp-component.adoc | 10 +++++----- docs/components/modules/ROOT/pages/ftps-component.adoc | 10 +++++----- .../modules/ROOT/pages/google-bigquery-sql-component.adoc | 2 +- docs/components/modules/ROOT/pages/grok-dataformat.adoc | 4 ++-- docs/components/modules/ROOT/pages/grpc-component.adoc | 2 +- docs/components/modules/ROOT/pages/hipchat-component.adoc | 2 +- docs/components/modules/ROOT/pages/jsonpath-language.adoc | 2 +- docs/components/modules/ROOT/pages/protobuf-dataformat.adoc | 2 +- docs/components/modules/ROOT/pages/scp-component.adoc | 2 +- docs/components/modules/ROOT/pages/sftp-component.adoc | 10 +++++----- .../src/main/resources/component-options.mvel | 4 ++-- .../src/main/resources/dataformat-options.mvel | 2 +- .../src/main/resources/eip-options.mvel | 2 +- .../src/main/resources/endpoint-options.mvel | 4 ++-- .../src/main/resources/language-options.mvel | 2 +- .../src/main/resources/readme-components.mvel | 2 +- .../src/main/resources/readme-dataformats.mvel | 2 +- .../src/main/resources/readme-eips.mvel | 2 +- .../src/main/resources/readme-examples.mvel | 2 +- .../src/main/resources/readme-languages.mvel | 2 +- .../src/main/resources/readme-others.mvel | 2 +- .../main/resources/spring-boot-auto-configure-options.mvel | 2 +- .../src/main/docs/camel-restdsl-swagger-plugin.adoc | 4 ++-- 71 files changed, 110 insertions(+), 110 deletions(-) diff --git a/components/camel-aws-ddb/src/main/docs/aws-ddb-component.adoc b/components/camel-aws-ddb/src/main/docs/aws-ddb-component.adoc index 30166d3..31b398d 100644 --- a/components/camel-aws-ddb/src/main/docs/aws-ddb-component.adoc +++ b/components/camel-aws-ddb/src/main/docs/aws-ddb-component.adoc @@ -383,7 +383,7 @@ Maven users will need to add the following dependency to their pom.xml. </dependency> --------------------------------------- -where `${camel-version}` must be replaced by the actual version of Camel. +where `\${camel-version}` must be replaced by the actual version of Camel. ### See Also diff --git a/components/camel-aws-ddb/src/main/docs/aws-ddbstream-component.adoc b/components/camel-aws-ddb/src/main/docs/aws-ddbstream-component.adoc index 10fa9df..6697a5d 100644 --- a/components/camel-aws-ddb/src/main/docs/aws-ddbstream-component.adoc +++ b/components/camel-aws-ddb/src/main/docs/aws-ddbstream-component.adoc @@ -240,7 +240,7 @@ Maven users will need to add the following dependency to their pom.xml. </dependency> --------------------------------------- -where `${camel-version}` must be replaced by the actual version of Camel. +where `\${camel-version}` must be replaced by the actual version of Camel. ### See Also diff --git a/components/camel-aws-ec2/src/main/docs/aws-ec2-component.adoc b/components/camel-aws-ec2/src/main/docs/aws-ec2-component.adoc index 8c30a3e..addc99b 100644 --- a/components/camel-aws-ec2/src/main/docs/aws-ec2-component.adoc +++ b/components/camel-aws-ec2/src/main/docs/aws-ec2-component.adoc @@ -181,7 +181,7 @@ Maven users will need to add the following dependency to their pom.xml. </dependency> --------------------------------------- -where `${camel-version}` must be replaced by the actual version of Camel. +where `\${camel-version}` must be replaced by the actual version of Camel. ### See Also diff --git a/components/camel-aws-ecs/src/main/docs/aws-ecs-component.adoc b/components/camel-aws-ecs/src/main/docs/aws-ecs-component.adoc index b6bd3f8..e34dc5c 100644 --- a/components/camel-aws-ecs/src/main/docs/aws-ecs-component.adoc +++ b/components/camel-aws-ecs/src/main/docs/aws-ecs-component.adoc @@ -175,7 +175,7 @@ Maven users will need to add the following dependency to their pom.xml. </dependency> --------------------------------------- -where `${camel-version}` must be replaced by the actual version of Camel. +where `\${camel-version}` must be replaced by the actual version of Camel. ### See Also diff --git a/components/camel-aws-eks/src/main/docs/aws-eks-component.adoc b/components/camel-aws-eks/src/main/docs/aws-eks-component.adoc index ca5c3d6..e753e0c 100644 --- a/components/camel-aws-eks/src/main/docs/aws-eks-component.adoc +++ b/components/camel-aws-eks/src/main/docs/aws-eks-component.adoc @@ -181,7 +181,7 @@ Maven users will need to add the following dependency to their pom.xml. </dependency> --------------------------------------- -where `${camel-version}` must be replaced by the actual version of Camel. +where `\${camel-version}` must be replaced by the actual version of Camel. ### See Also diff --git a/components/camel-aws-iam/src/main/docs/aws-iam-component.adoc b/components/camel-aws-iam/src/main/docs/aws-iam-component.adoc index 2e0ef3f..ee1f28b 100644 --- a/components/camel-aws-iam/src/main/docs/aws-iam-component.adoc +++ b/components/camel-aws-iam/src/main/docs/aws-iam-component.adoc @@ -190,7 +190,7 @@ Maven users will need to add the following dependency to their pom.xml. </dependency> --------------------------------------- -where `${camel-version}` must be replaced by the actual version of Camel. +where `\${camel-version}` must be replaced by the actual version of Camel. ### See Also diff --git a/components/camel-aws-kinesis/src/main/docs/aws-kinesis-component.adoc b/components/camel-aws-kinesis/src/main/docs/aws-kinesis-component.adoc index 2c7dff2..09ba7e2 100644 --- a/components/camel-aws-kinesis/src/main/docs/aws-kinesis-component.adoc +++ b/components/camel-aws-kinesis/src/main/docs/aws-kinesis-component.adoc @@ -270,7 +270,7 @@ Maven users will need to add the following dependency to their pom.xml. </dependency> --------------------------------------- -where `${camel-version}` must be replaced by the actual version of Camel. +where `\${camel-version}` must be replaced by the actual version of Camel. ### See Also diff --git a/components/camel-aws-kinesis/src/main/docs/aws-kinesis-firehose-component.adoc b/components/camel-aws-kinesis/src/main/docs/aws-kinesis-firehose-component.adoc index a0936bf..9224621 100644 --- a/components/camel-aws-kinesis/src/main/docs/aws-kinesis-firehose-component.adoc +++ b/components/camel-aws-kinesis/src/main/docs/aws-kinesis-firehose-component.adoc @@ -206,7 +206,7 @@ Maven users will need to add the following dependency to their pom.xml. </dependency> --------------------------------------- -where `${camel-version}` must be replaced by the actual version of Camel. +where `\${camel-version}` must be replaced by the actual version of Camel. ### See Also diff --git a/components/camel-aws-kms/src/main/docs/aws-kms-component.adoc b/components/camel-aws-kms/src/main/docs/aws-kms-component.adoc index c35994a..56f8ece 100644 --- a/components/camel-aws-kms/src/main/docs/aws-kms-component.adoc +++ b/components/camel-aws-kms/src/main/docs/aws-kms-component.adoc @@ -179,7 +179,7 @@ Maven users will need to add the following dependency to their pom.xml. </dependency> --------------------------------------- -where `${camel-version}` must be replaced by the actual version of Camel. +where `\${camel-version}` must be replaced by the actual version of Camel. ### See Also diff --git a/components/camel-aws-lambda/src/main/docs/aws-lambda-component.adoc b/components/camel-aws-lambda/src/main/docs/aws-lambda-component.adoc index 969af66..4c27217 100644 --- a/components/camel-aws-lambda/src/main/docs/aws-lambda-component.adoc +++ b/components/camel-aws-lambda/src/main/docs/aws-lambda-component.adoc @@ -241,7 +241,7 @@ Maven users will need to add the following dependency to their pom.xml. </dependency> --------------------------------------- -where `${camel-version}` must be replaced by the actual version of Camel. +where `\${camel-version}` must be replaced by the actual version of Camel. ### See Also diff --git a/components/camel-aws-mq/src/main/docs/aws-mq-component.adoc b/components/camel-aws-mq/src/main/docs/aws-mq-component.adoc index 3321493..94a0132 100644 --- a/components/camel-aws-mq/src/main/docs/aws-mq-component.adoc +++ b/components/camel-aws-mq/src/main/docs/aws-mq-component.adoc @@ -180,7 +180,7 @@ Maven users will need to add the following dependency to their pom.xml. </dependency> --------------------------------------- -where `${camel-version}` must be replaced by the actual version of Camel. +where `\${camel-version}` must be replaced by the actual version of Camel. ### See Also diff --git a/components/camel-aws-msk/src/main/docs/aws-msk-component.adoc b/components/camel-aws-msk/src/main/docs/aws-msk-component.adoc index 87ae252..f4f81a0 100644 --- a/components/camel-aws-msk/src/main/docs/aws-msk-component.adoc +++ b/components/camel-aws-msk/src/main/docs/aws-msk-component.adoc @@ -183,7 +183,7 @@ Maven users will need to add the following dependency to their pom.xml. </dependency> --------------------------------------- -where `${camel-version}` must be replaced by the actual version of Camel. +where `\${camel-version}` must be replaced by the actual version of Camel. ### See Also diff --git a/components/camel-aws-s3/src/main/docs/aws-s3-component.adoc b/components/camel-aws-s3/src/main/docs/aws-s3-component.adoc index 0f3220b..d4f3955 100644 --- a/components/camel-aws-s3/src/main/docs/aws-s3-component.adoc +++ b/components/camel-aws-s3/src/main/docs/aws-s3-component.adoc @@ -536,7 +536,7 @@ Maven users will need to add the following dependency to their pom.xml. </dependency> --------------------------------------- -where `${camel-version}` must be replaced by the actual version of Camel. +where `\${camel-version}` must be replaced by the actual version of Camel. ### See Also diff --git a/components/camel-aws-sdb/src/main/docs/aws-sdb-component.adoc b/components/camel-aws-sdb/src/main/docs/aws-sdb-component.adoc index e2e4975f..1e7535c 100644 --- a/components/camel-aws-sdb/src/main/docs/aws-sdb-component.adoc +++ b/components/camel-aws-sdb/src/main/docs/aws-sdb-component.adoc @@ -255,7 +255,7 @@ Maven users will need to add the following dependency to their pom.xml. </dependency> --------------------------------------- -where `${camel-version}` must be replaced by the actual version of Camel. +where `\${camel-version}` must be replaced by the actual version of Camel. ### See Also diff --git a/components/camel-aws-ses/src/main/docs/aws-ses-component.adoc b/components/camel-aws-ses/src/main/docs/aws-ses-component.adoc index 89ec05c..88a74b8 100644 --- a/components/camel-aws-ses/src/main/docs/aws-ses-component.adoc +++ b/components/camel-aws-ses/src/main/docs/aws-ses-component.adoc @@ -216,7 +216,7 @@ This may be really useful for smarter configuration of the endpoint. </dependency> --------------------------------------- -where `${camel-version}` must be replaced by the actual version of Camel. +where `\${camel-version}` must be replaced by the actual version of Camel. ### See Also diff --git a/components/camel-aws-sns/src/main/docs/aws-sns-component.adoc b/components/camel-aws-sns/src/main/docs/aws-sns-component.adoc index 6f14c39..5e491d5 100644 --- a/components/camel-aws-sns/src/main/docs/aws-sns-component.adoc +++ b/components/camel-aws-sns/src/main/docs/aws-sns-component.adoc @@ -251,7 +251,7 @@ Maven users will need to add the following dependency to their pom.xml. </dependency> --------------------------------------- -where `${camel-version}` must be replaced by the actual version of Camel. +where `\${camel-version}` must be replaced by the actual version of Camel. ### See Also diff --git a/components/camel-aws-sqs/src/main/docs/aws-sqs-component.adoc b/components/camel-aws-sqs/src/main/docs/aws-sqs-component.adoc index 6863f75..8399773 100644 --- a/components/camel-aws-sqs/src/main/docs/aws-sqs-component.adoc +++ b/components/camel-aws-sqs/src/main/docs/aws-sqs-component.adoc @@ -323,7 +323,7 @@ Maven users will need to add the following dependency to their pom.xml. </dependency> --------------------------------------- -where `${camel-version}` must be replaced by the actual version of Camel. +where `\${camel-version}` must be replaced by the actual version of Camel. ### JMS-style Selectors diff --git a/components/camel-aws-swf/src/main/docs/aws-swf-component.adoc b/components/camel-aws-swf/src/main/docs/aws-swf-component.adoc index 4aceaf5..12612ab 100644 --- a/components/camel-aws-swf/src/main/docs/aws-swf-component.adoc +++ b/components/camel-aws-swf/src/main/docs/aws-swf-component.adoc @@ -306,7 +306,7 @@ Maven users will need to add the following dependency to their pom.xml. </dependency> --------------------------------------- -where `${camel-version}` must be replaced by the actual version of Camel. +where `\${camel-version}` must be replaced by the actual version of Camel. ### See Also diff --git a/components/camel-file/src/main/docs/file-component.adoc b/components/camel-file/src/main/docs/file-component.adoc index 54ba798..1e75755 100644 --- a/components/camel-file/src/main/docs/file-component.adoc +++ b/components/camel-file/src/main/docs/file-component.adoc @@ -92,8 +92,8 @@ with the following path and query parameters: |=== | Name | Description | Default | Type | *charset* (common) | This option is used to specify the encoding of the file. You can use this on the consumer, to specify the encodings of the files, which allow Camel to know the charset it should load the file content in case the file content is being accessed. Likewise when writing a file, you can use this option to specify which charset to write the file as well. Do mind that when writing the file Camel may have to read the message content into memory to be able to convert the dat [...] -| *doneFileName* (common) | Producer: If provided, then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Consumer: If provided, Camel will only consume files if a done file exists. This option configures what file name to use. Either you ca [...] -| *fileName* (common) | Use Expression such as File Language to dynamically set the filename. For consumers, it's used as a filename filter. For producers, it's used to evaluate the filename to write. If an expression is set, it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type, it is always evaluated using the File Language. If the express [...] +| *doneFileName* (common) | Producer: If provided, then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Consumer: If provided, Camel will only consume files if a done file exists. This option configures what file name to use. Either you ca [...] +| *fileName* (common) | Use Expression such as File Language to dynamically set the filename. For consumers, it's used as a filename filter. For producers, it's used to evaluate the filename to write. If an expression is set, it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type, it is always evaluated using the File Language. If the express [...] | *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | false | boolean | *delete* (consumer) | If true, the file will be deleted after it is processed successfully. | false | boolean | *moveFailed* (consumer) | Sets the move failure expression based on Simple language. For example, to move files into a .error subdirectory use: .error. Note: When moving the files to the fail location Camel will handle the error and will not pick up the file again. | | String @@ -140,10 +140,10 @@ with the following path and query parameters: | *eagerMaxMessagesPerPoll* (filter) | Allows for controlling whether the limit from maxMessagesPerPoll is eager or not. If eager then the limit is during the scanning of files. Where as false would scan all files, and then perform sorting. Setting this option to false allows for sorting all files first, and then limit the poll. Mind that this requires a higher memory usage as all file details are in memory to perform the sorting. | true | boolean | *exclude* (filter) | Is used to exclude files, if filename matches the regex pattern (matching is case in-senstive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris | | String | *filter* (filter) | Pluggable filter as a org.apache.camel.component.file.GenericFileFilter class. Will skip files if filter returns false in its accept() method. | | GenericFileFilter -| *filterDirectory* (filter) | Filters the directory based on Simple language. For example to filter on current date, you can use a simple date pattern such as ${date:now:yyyMMdd} | | String -| *filterFile* (filter) | Filters the file based on Simple language. For example to filter on file size, you can use ${file:size} 5000 | | String +| *filterDirectory* (filter) | Filters the directory based on Simple language. For example to filter on current date, you can use a simple date pattern such as \${date:now:yyyMMdd} | | String +| *filterFile* (filter) | Filters the file based on Simple language. For example to filter on file size, you can use \${file:size} 5000 | | String | *idempotent* (filter) | Option to use the Idempotent Consumer EIP pattern to let Camel skip already processed files. Will by default use a memory based LRUCache that holds 1000 entries. If noop=true then idempotent will be enabled as well to avoid consuming the same files over and over again. | false | Boolean -| *idempotentKey* (filter) | To use a custom idempotent key. By default the absolute path of the file is used. You can use the File Language, for example to use the file name and file size, you can do: idempotentKey=${file:name}-${file:size} | | String +| *idempotentKey* (filter) | To use a custom idempotent key. By default the absolute path of the file is used. You can use the File Language, for example to use the file name and file size, you can do: idempotentKey=\${file:name}-\${file:size} | | String | *idempotentRepository* (filter) | A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryMessageIdRepository if none is specified and idempotent is true. | | IdempotentRepository | *include* (filter) | Is used to include files, if filename matches the regex pattern (matching is case in-sensitive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris | | String | *maxDepth* (filter) | The maximum depth to traverse when recursively processing a directory. | 2147483647 | int @@ -288,7 +288,7 @@ of the directory and name pattern. + Camel will, in fact, internally convert the directory name you enter into a xref:file-language.adoc[File Language] expression. So when we enter `move=.done` Camel will convert this into: -`${``file:parent``}/.done/${``file:onlyname`}. This is only done if +`\${file:parent}/.done/${file:onlyname}`. This is only done if Camel detects that you have not provided a $\{ } in the option value yourself. So when you enter a $\{ } Camel will *not* convert it and thus you have the full power. diff --git a/components/camel-ftp/src/main/docs/ftp-component.adoc b/components/camel-ftp/src/main/docs/ftp-component.adoc index 27a8d04..757e558 100644 --- a/components/camel-ftp/src/main/docs/ftp-component.adoc +++ b/components/camel-ftp/src/main/docs/ftp-component.adoc @@ -111,8 +111,8 @@ with the following path and query parameters: | *binary* (common) | Specifies the file transfer mode, BINARY or ASCII. Default is ASCII (false). | false | boolean | *charset* (common) | This option is used to specify the encoding of the file. You can use this on the consumer, to specify the encodings of the files, which allow Camel to know the charset it should load the file content in case the file content is being accessed. Likewise when writing a file, you can use this option to specify which charset to write the file as well. Do mind that when writing the file Camel may have to read the message content into memory to be able to convert the dat [...] | *disconnect* (common) | Whether or not to disconnect from remote FTP server right after use. Disconnect will only disconnect the current connection to the FTP server. If you have a consumer which you want to stop, then you need to stop the consumer/route instead. | false | boolean -| *doneFileName* (common) | Producer: If provided, then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Consumer: If provided, Camel will only consume files if a done file exists. This option configures what file name to use. Either you ca [...] -| *fileName* (common) | Use Expression such as File Language to dynamically set the filename. For consumers, it's used as a filename filter. For producers, it's used to evaluate the filename to write. If an expression is set, it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type, it is always evaluated using the File Language. If the express [...] +| *doneFileName* (common) | Producer: If provided, then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Consumer: If provided, Camel will only consume files if a done file exists. This option configures what file name to use. Either you ca [...] +| *fileName* (common) | Use Expression such as File Language to dynamically set the filename. For consumers, it's used as a filename filter. For producers, it's used to evaluate the filename to write. If an expression is set, it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type, it is always evaluated using the File Language. If the express [...] | *passiveMode* (common) | Sets passive mode connections. Default is active mode connections. | false | boolean | *separator* (common) | Sets the path separator to be used. UNIX = Uses unix style path separator Windows = Uses windows style path separator Auto = (is default) Use existing path separator in file name | UNIX | PathSeparator | *transferLoggingInterval Seconds* (common) | Configures the interval in seconds to use when logging the progress of upload and download operations that are in-flight. This is used for logging progress when operations takes longer time. | 5 | int @@ -178,10 +178,10 @@ with the following path and query parameters: | *eagerMaxMessagesPerPoll* (filter) | Allows for controlling whether the limit from maxMessagesPerPoll is eager or not. If eager then the limit is during the scanning of files. Where as false would scan all files, and then perform sorting. Setting this option to false allows for sorting all files first, and then limit the poll. Mind that this requires a higher memory usage as all file details are in memory to perform the sorting. | true | boolean | *exclude* (filter) | Is used to exclude files, if filename matches the regex pattern (matching is case in-senstive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris | | String | *filter* (filter) | Pluggable filter as a org.apache.camel.component.file.GenericFileFilter class. Will skip files if filter returns false in its accept() method. | | GenericFileFilter -| *filterDirectory* (filter) | Filters the directory based on Simple language. For example to filter on current date, you can use a simple date pattern such as ${date:now:yyyMMdd} | | String -| *filterFile* (filter) | Filters the file based on Simple language. For example to filter on file size, you can use ${file:size} 5000 | | String +| *filterDirectory* (filter) | Filters the directory based on Simple language. For example to filter on current date, you can use a simple date pattern such as \${date:now:yyyMMdd} | | String +| *filterFile* (filter) | Filters the file based on Simple language. For example to filter on file size, you can use \${file:size} 5000 | | String | *idempotent* (filter) | Option to use the Idempotent Consumer EIP pattern to let Camel skip already processed files. Will by default use a memory based LRUCache that holds 1000 entries. If noop=true then idempotent will be enabled as well to avoid consuming the same files over and over again. | false | Boolean -| *idempotentKey* (filter) | To use a custom idempotent key. By default the absolute path of the file is used. You can use the File Language, for example to use the file name and file size, you can do: idempotentKey=${file:name}-${file:size} | | String +| *idempotentKey* (filter) | To use a custom idempotent key. By default the absolute path of the file is used. You can use the File Language, for example to use the file name and file size, you can do: idempotentKey=\${file:name}-\${file:size} | | String | *idempotentRepository* (filter) | A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryMessageIdRepository if none is specified and idempotent is true. | | IdempotentRepository | *include* (filter) | Is used to include files, if filename matches the regex pattern (matching is case in-sensitive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris | | String | *maxDepth* (filter) | The maximum depth to traverse when recursively processing a directory. | 2147483647 | int diff --git a/components/camel-ftp/src/main/docs/ftps-component.adoc b/components/camel-ftp/src/main/docs/ftps-component.adoc index d605dca..38bdb9c 100644 --- a/components/camel-ftp/src/main/docs/ftps-component.adoc +++ b/components/camel-ftp/src/main/docs/ftps-component.adoc @@ -70,8 +70,8 @@ with the following path and query parameters: | *binary* (common) | Specifies the file transfer mode, BINARY or ASCII. Default is ASCII (false). | false | boolean | *charset* (common) | This option is used to specify the encoding of the file. You can use this on the consumer, to specify the encodings of the files, which allow Camel to know the charset it should load the file content in case the file content is being accessed. Likewise when writing a file, you can use this option to specify which charset to write the file as well. Do mind that when writing the file Camel may have to read the message content into memory to be able to convert the dat [...] | *disconnect* (common) | Whether or not to disconnect from remote FTP server right after use. Disconnect will only disconnect the current connection to the FTP server. If you have a consumer which you want to stop, then you need to stop the consumer/route instead. | false | boolean -| *doneFileName* (common) | Producer: If provided, then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Consumer: If provided, Camel will only consume files if a done file exists. This option configures what file name to use. Either you ca [...] -| *fileName* (common) | Use Expression such as File Language to dynamically set the filename. For consumers, it's used as a filename filter. For producers, it's used to evaluate the filename to write. If an expression is set, it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type, it is always evaluated using the File Language. If the express [...] +| *doneFileName* (common) | Producer: If provided, then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Consumer: If provided, Camel will only consume files if a done file exists. This option configures what file name to use. Either you ca [...] +| *fileName* (common) | Use Expression such as File Language to dynamically set the filename. For consumers, it's used as a filename filter. For producers, it's used to evaluate the filename to write. If an expression is set, it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type, it is always evaluated using the File Language. If the express [...] | *passiveMode* (common) | Sets passive mode connections. Default is active mode connections. | false | boolean | *separator* (common) | Sets the path separator to be used. UNIX = Uses unix style path separator Windows = Uses windows style path separator Auto = (is default) Use existing path separator in file name | UNIX | PathSeparator | *transferLoggingInterval Seconds* (common) | Configures the interval in seconds to use when logging the progress of upload and download operations that are in-flight. This is used for logging progress when operations takes longer time. | 5 | int @@ -137,10 +137,10 @@ with the following path and query parameters: | *eagerMaxMessagesPerPoll* (filter) | Allows for controlling whether the limit from maxMessagesPerPoll is eager or not. If eager then the limit is during the scanning of files. Where as false would scan all files, and then perform sorting. Setting this option to false allows for sorting all files first, and then limit the poll. Mind that this requires a higher memory usage as all file details are in memory to perform the sorting. | true | boolean | *exclude* (filter) | Is used to exclude files, if filename matches the regex pattern (matching is case in-senstive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris | | String | *filter* (filter) | Pluggable filter as a org.apache.camel.component.file.GenericFileFilter class. Will skip files if filter returns false in its accept() method. | | GenericFileFilter -| *filterDirectory* (filter) | Filters the directory based on Simple language. For example to filter on current date, you can use a simple date pattern such as ${date:now:yyyMMdd} | | String -| *filterFile* (filter) | Filters the file based on Simple language. For example to filter on file size, you can use ${file:size} 5000 | | String +| *filterDirectory* (filter) | Filters the directory based on Simple language. For example to filter on current date, you can use a simple date pattern such as \${date:now:yyyMMdd} | | String +| *filterFile* (filter) | Filters the file based on Simple language. For example to filter on file size, you can use \${file:size} 5000 | | String | *idempotent* (filter) | Option to use the Idempotent Consumer EIP pattern to let Camel skip already processed files. Will by default use a memory based LRUCache that holds 1000 entries. If noop=true then idempotent will be enabled as well to avoid consuming the same files over and over again. | false | Boolean -| *idempotentKey* (filter) | To use a custom idempotent key. By default the absolute path of the file is used. You can use the File Language, for example to use the file name and file size, you can do: idempotentKey=${file:name}-${file:size} | | String +| *idempotentKey* (filter) | To use a custom idempotent key. By default the absolute path of the file is used. You can use the File Language, for example to use the file name and file size, you can do: idempotentKey=\${file:name}-\${file:size} | | String | *idempotentRepository* (filter) | A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryMessageIdRepository if none is specified and idempotent is true. | | IdempotentRepository | *include* (filter) | Is used to include files, if filename matches the regex pattern (matching is case in-sensitive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris | | String | *maxDepth* (filter) | The maximum depth to traverse when recursively processing a directory. | 2147483647 | int diff --git a/components/camel-ftp/src/main/docs/sftp-component.adoc b/components/camel-ftp/src/main/docs/sftp-component.adoc index 5052fb4..ebd3d23 100644 --- a/components/camel-ftp/src/main/docs/sftp-component.adoc +++ b/components/camel-ftp/src/main/docs/sftp-component.adoc @@ -68,8 +68,8 @@ with the following path and query parameters: | Name | Description | Default | Type | *charset* (common) | This option is used to specify the encoding of the file. You can use this on the consumer, to specify the encodings of the files, which allow Camel to know the charset it should load the file content in case the file content is being accessed. Likewise when writing a file, you can use this option to specify which charset to write the file as well. Do mind that when writing the file Camel may have to read the message content into memory to be able to convert the dat [...] | *disconnect* (common) | Whether or not to disconnect from remote FTP server right after use. Disconnect will only disconnect the current connection to the FTP server. If you have a consumer which you want to stop, then you need to stop the consumer/route instead. | false | boolean -| *doneFileName* (common) | Producer: If provided, then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Consumer: If provided, Camel will only consume files if a done file exists. This option configures what file name to use. Either you ca [...] -| *fileName* (common) | Use Expression such as File Language to dynamically set the filename. For consumers, it's used as a filename filter. For producers, it's used to evaluate the filename to write. If an expression is set, it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type, it is always evaluated using the File Language. If the express [...] +| *doneFileName* (common) | Producer: If provided, then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Consumer: If provided, Camel will only consume files if a done file exists. This option configures what file name to use. Either you ca [...] +| *fileName* (common) | Use Expression such as File Language to dynamically set the filename. For consumers, it's used as a filename filter. For producers, it's used to evaluate the filename to write. If an expression is set, it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type, it is always evaluated using the File Language. If the express [...] | *jschLoggingLevel* (common) | The logging level to use for JSCH activity logging. As JSCH is verbose at by default at INFO level the threshold is WARN by default. | WARN | LoggingLevel | *separator* (common) | Sets the path separator to be used. UNIX = Uses unix style path separator Windows = Uses windows style path separator Auto = (is default) Use existing path separator in file name | UNIX | PathSeparator | *fastExistsCheck* (common) | If set this option to be true, camel-ftp will use the list file directly to check if the file exists. Since some FTP server may not support to list the file directly, if the option is false, camel-ftp will use the old way to list the directory and check if the file exists. This option also influences readLock=changed to control whether it performs a fast check to update file information or not. This can be used to speed up the process if the FTP server has [...] @@ -129,10 +129,10 @@ with the following path and query parameters: | *eagerMaxMessagesPerPoll* (filter) | Allows for controlling whether the limit from maxMessagesPerPoll is eager or not. If eager then the limit is during the scanning of files. Where as false would scan all files, and then perform sorting. Setting this option to false allows for sorting all files first, and then limit the poll. Mind that this requires a higher memory usage as all file details are in memory to perform the sorting. | true | boolean | *exclude* (filter) | Is used to exclude files, if filename matches the regex pattern (matching is case in-senstive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris | | String | *filter* (filter) | Pluggable filter as a org.apache.camel.component.file.GenericFileFilter class. Will skip files if filter returns false in its accept() method. | | GenericFileFilter -| *filterDirectory* (filter) | Filters the directory based on Simple language. For example to filter on current date, you can use a simple date pattern such as ${date:now:yyyMMdd} | | String -| *filterFile* (filter) | Filters the file based on Simple language. For example to filter on file size, you can use ${file:size} 5000 | | String +| *filterDirectory* (filter) | Filters the directory based on Simple language. For example to filter on current date, you can use a simple date pattern such as \${date:now:yyyMMdd} | | String +| *filterFile* (filter) | Filters the file based on Simple language. For example to filter on file size, you can use \${file:size} 5000 | | String | *idempotent* (filter) | Option to use the Idempotent Consumer EIP pattern to let Camel skip already processed files. Will by default use a memory based LRUCache that holds 1000 entries. If noop=true then idempotent will be enabled as well to avoid consuming the same files over and over again. | false | Boolean -| *idempotentKey* (filter) | To use a custom idempotent key. By default the absolute path of the file is used. You can use the File Language, for example to use the file name and file size, you can do: idempotentKey=${file:name}-${file:size} | | String +| *idempotentKey* (filter) | To use a custom idempotent key. By default the absolute path of the file is used. You can use the File Language, for example to use the file name and file size, you can do: idempotentKey=\${file:name}-\${file:size} | | String | *idempotentRepository* (filter) | A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryMessageIdRepository if none is specified and idempotent is true. | | IdempotentRepository | *include* (filter) | Is used to include files, if filename matches the regex pattern (matching is case in-sensitive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris | | String | *maxDepth* (filter) | The maximum depth to traverse when recursively processing a directory. | 2147483647 | int diff --git a/components/camel-google-bigquery/src/main/docs/google-bigquery-sql-component.adoc b/components/camel-google-bigquery/src/main/docs/google-bigquery-sql-component.adoc index 5673e1d..f2afc85 100644 --- a/components/camel-google-bigquery/src/main/docs/google-bigquery-sql-component.adoc +++ b/components/camel-google-bigquery/src/main/docs/google-bigquery-sql-component.adoc @@ -60,7 +60,7 @@ Examples: -------------------------------------------------------- where - * parameters in form ${name} are extracted from message headers and formed the translated query + * parameters in form \${name} are extracted from message headers and formed the translated query * parameters in form @name are extracted from body or message headers and sent to Google Bigquery You can externalize your SQL queries to files in the classpath or file system as shown: diff --git a/components/camel-grok/src/main/docs/grok-dataformat.adoc b/components/camel-grok/src/main/docs/grok-dataformat.adoc index eb71f040..b1413af 100644 --- a/components/camel-grok/src/main/docs/grok-dataformat.adoc +++ b/components/camel-grok/src/main/docs/grok-dataformat.adoc @@ -100,7 +100,7 @@ The Grok dataformat supports 5 options, which are listed below. | pattern | | String | The grok pattern to match lines of input | flattened | false | Boolean | Turns on flattened mode. In flattened mode the exception is thrown when there are multiple pattern matches with same key. | allowMultipleMatchesPerLine | true | Boolean | If false, every line of input is matched for pattern only once. Otherwise the line can be scanned multiple times when non-terminal pattern is used. -| namedOnly | false | Boolean | Whether to capture named expressions only or not (i.e. %{IP:ip} but not ${IP}) +| namedOnly | false | Boolean | Whether to capture named expressions only or not (i.e. %{IP:ip} but not \${IP}) | 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 @@ -131,7 +131,7 @@ The component supports 6 options, which are listed below. | *camel.dataformat.grok.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.grok.enabled* | Whether to enable auto configuration of the grok data format. This is enabled by default. | | Boolean | *camel.dataformat.grok.flattened* | Turns on flattened mode. In flattened mode the exception is thrown when there are multiple pattern matches with same key. | false | Boolean -| *camel.dataformat.grok.named-only* | Whether to capture named expressions only or not (i.e. %{IP:ip} but not ${IP}) | false | Boolean +| *camel.dataformat.grok.named-only* | Whether to capture named expressions only or not (i.e. %{IP:ip} but not \${IP}) | false | Boolean | *camel.dataformat.grok.pattern* | The grok pattern to match lines of input | | String |=== // spring-boot-auto-configure options: END diff --git a/components/camel-grpc/src/main/docs/grpc-component.adoc b/components/camel-grpc/src/main/docs/grpc-component.adoc index baefd4b..6589da1 100644 --- a/components/camel-grpc/src/main/docs/grpc-component.adoc +++ b/components/camel-grpc/src/main/docs/grpc-component.adoc @@ -270,7 +270,7 @@ It's it is recommended to use Maven Protocol Buffers Plugin which calls Protocol Following steps are required: -Insert operating system and CPU architecture detection extension inside **<build>** tag of the project pom.xml or set ${os.detected.classifier} parameter manually +Insert operating system and CPU architecture detection extension inside **<build>** tag of the project pom.xml or set \${os.detected.classifier} parameter manually [source,xml] ------------------------------------------------------------------------- <extensions> diff --git a/components/camel-hipchat/src/main/docs/hipchat-component.adoc b/components/camel-hipchat/src/main/docs/hipchat-component.adoc index 2c42b54..f1cdd59 100644 --- a/components/camel-hipchat/src/main/docs/hipchat-component.adoc +++ b/components/camel-hipchat/src/main/docs/hipchat-component.adoc @@ -258,4 +258,4 @@ Maven users will need to add the following dependency to their pom.xml. </dependency> ------------------------------------------ -where `${camel-version}` must be replaced by the actual version of Camel. +where `\${camel-version}` must be replaced by the actual version of Camel. diff --git a/components/camel-jsch/src/main/docs/scp-component.adoc b/components/camel-jsch/src/main/docs/scp-component.adoc index e1d2796..6298a59 100644 --- a/components/camel-jsch/src/main/docs/scp-component.adoc +++ b/components/camel-jsch/src/main/docs/scp-component.adoc @@ -92,7 +92,7 @@ with the following path and query parameters: | Name | Description | Default | Type | *disconnect* (common) | Whether or not to disconnect from remote FTP server right after use. Disconnect will only disconnect the current connection to the FTP server. If you have a consumer which you want to stop, then you need to stop the consumer/route instead. | false | boolean | *chmod* (producer) | Allows you to set chmod on the stored file. For example chmod=664. | 664 | String -| *fileName* (producer) | Use Expression such as File Language to dynamically set the filename. For consumers, it's used as a filename filter. For producers, it's used to evaluate the filename to write. If an expression is set, it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type, it is always evaluated using the File Language. If the expre [...] +| *fileName* (producer) | Use Expression such as File Language to dynamically set the filename. For consumers, it's used as a filename filter. For producers, it's used to evaluate the filename to write. If an expression is set, it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type, it is always evaluated using the File Language. If the expre [...] | *flatten* (producer) | Flatten is used to flatten the file name path to strip any leading paths, so it's just the file name. This allows you to consume recursively into sub-directories, but when you eg write the files to another directory they will be written in a single directory. Setting this to true on the producer enforces that any file name in CamelFileName header will be stripped for any leading paths. | false | boolean | *jailStartingDirectory* (producer) | Used for jailing (restricting) writing files to the starting directory (and sub) only. This is enabled by default to not allow Camel to write files to outside directories (to be more secured out of the box). You can turn this off to allow writing files to directories outside the starting directory, such as parent or root folders. | true | boolean | *lazyStartProducer* (producer) | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and [...] diff --git a/components/camel-jsonpath/src/main/docs/jsonpath-language.adoc b/components/camel-jsonpath/src/main/docs/jsonpath-language.adoc index 92fbb12..e15dd12 100644 --- a/components/camel-jsonpath/src/main/docs/jsonpath-language.adoc +++ b/components/camel-jsonpath/src/main/docs/jsonpath-language.adoc @@ -212,7 +212,7 @@ This option is also available on the `@JsonPath` annotation. *Available as of Camel 2.18* -Its now possible to inlined Simple language expressions in the JSonPath expression using the simple syntax ${xxx}. +Its now possible to inlined Simple language expressions in the JSonPath expression using the simple syntax \${xxx}. An example is shown below: [source,java] diff --git a/components/camel-protobuf/src/main/docs/protobuf-dataformat.adoc b/components/camel-protobuf/src/main/docs/protobuf-dataformat.adoc index 1de8baa..200fd26 100644 --- a/components/camel-protobuf/src/main/docs/protobuf-dataformat.adoc +++ b/components/camel-protobuf/src/main/docs/protobuf-dataformat.adoc @@ -134,7 +134,7 @@ classes for the format we defined in our .proto file. If your operating system is supporting by https://www.xolstice.org/protobuf-maven-plugin[Protobuf Java code generator maven plugin], you can automate protobuf Java code generating by adding following configurations to your pom.xml: -Insert operating system and CPU architecture detection extension inside **<build>** tag of the project pom.xml or set ${os.detected.classifier} parameter manually +Insert operating system and CPU architecture detection extension inside **<build>** tag of the project pom.xml or set \${os.detected.classifier} parameter manually [source,xml] ------------------------------------------------------------------------- <extensions> diff --git a/docs/components/modules/ROOT/pages/aws-ddb-component.adoc b/docs/components/modules/ROOT/pages/aws-ddb-component.adoc index 30166d3..31b398d 100644 --- a/docs/components/modules/ROOT/pages/aws-ddb-component.adoc +++ b/docs/components/modules/ROOT/pages/aws-ddb-component.adoc @@ -383,7 +383,7 @@ Maven users will need to add the following dependency to their pom.xml. </dependency> --------------------------------------- -where `${camel-version}` must be replaced by the actual version of Camel. +where `\${camel-version}` must be replaced by the actual version of Camel. ### See Also diff --git a/docs/components/modules/ROOT/pages/aws-ddbstream-component.adoc b/docs/components/modules/ROOT/pages/aws-ddbstream-component.adoc index 10fa9df..6697a5d 100644 --- a/docs/components/modules/ROOT/pages/aws-ddbstream-component.adoc +++ b/docs/components/modules/ROOT/pages/aws-ddbstream-component.adoc @@ -240,7 +240,7 @@ Maven users will need to add the following dependency to their pom.xml. </dependency> --------------------------------------- -where `${camel-version}` must be replaced by the actual version of Camel. +where `\${camel-version}` must be replaced by the actual version of Camel. ### See Also diff --git a/docs/components/modules/ROOT/pages/aws-ec2-component.adoc b/docs/components/modules/ROOT/pages/aws-ec2-component.adoc index 8c30a3e..addc99b 100644 --- a/docs/components/modules/ROOT/pages/aws-ec2-component.adoc +++ b/docs/components/modules/ROOT/pages/aws-ec2-component.adoc @@ -181,7 +181,7 @@ Maven users will need to add the following dependency to their pom.xml. </dependency> --------------------------------------- -where `${camel-version}` must be replaced by the actual version of Camel. +where `\${camel-version}` must be replaced by the actual version of Camel. ### See Also diff --git a/docs/components/modules/ROOT/pages/aws-ecs-component.adoc b/docs/components/modules/ROOT/pages/aws-ecs-component.adoc index b6bd3f8..e34dc5c 100644 --- a/docs/components/modules/ROOT/pages/aws-ecs-component.adoc +++ b/docs/components/modules/ROOT/pages/aws-ecs-component.adoc @@ -175,7 +175,7 @@ Maven users will need to add the following dependency to their pom.xml. </dependency> --------------------------------------- -where `${camel-version}` must be replaced by the actual version of Camel. +where `\${camel-version}` must be replaced by the actual version of Camel. ### See Also diff --git a/docs/components/modules/ROOT/pages/aws-eks-component.adoc b/docs/components/modules/ROOT/pages/aws-eks-component.adoc index ca5c3d6..e753e0c 100644 --- a/docs/components/modules/ROOT/pages/aws-eks-component.adoc +++ b/docs/components/modules/ROOT/pages/aws-eks-component.adoc @@ -181,7 +181,7 @@ Maven users will need to add the following dependency to their pom.xml. </dependency> --------------------------------------- -where `${camel-version}` must be replaced by the actual version of Camel. +where `\${camel-version}` must be replaced by the actual version of Camel. ### See Also diff --git a/docs/components/modules/ROOT/pages/aws-iam-component.adoc b/docs/components/modules/ROOT/pages/aws-iam-component.adoc index 2e0ef3f..ee1f28b 100644 --- a/docs/components/modules/ROOT/pages/aws-iam-component.adoc +++ b/docs/components/modules/ROOT/pages/aws-iam-component.adoc @@ -190,7 +190,7 @@ Maven users will need to add the following dependency to their pom.xml. </dependency> --------------------------------------- -where `${camel-version}` must be replaced by the actual version of Camel. +where `\${camel-version}` must be replaced by the actual version of Camel. ### See Also diff --git a/docs/components/modules/ROOT/pages/aws-kinesis-component.adoc b/docs/components/modules/ROOT/pages/aws-kinesis-component.adoc index 2c7dff2..09ba7e2 100644 --- a/docs/components/modules/ROOT/pages/aws-kinesis-component.adoc +++ b/docs/components/modules/ROOT/pages/aws-kinesis-component.adoc @@ -270,7 +270,7 @@ Maven users will need to add the following dependency to their pom.xml. </dependency> --------------------------------------- -where `${camel-version}` must be replaced by the actual version of Camel. +where `\${camel-version}` must be replaced by the actual version of Camel. ### See Also diff --git a/docs/components/modules/ROOT/pages/aws-kinesis-firehose-component.adoc b/docs/components/modules/ROOT/pages/aws-kinesis-firehose-component.adoc index a0936bf..9224621 100644 --- a/docs/components/modules/ROOT/pages/aws-kinesis-firehose-component.adoc +++ b/docs/components/modules/ROOT/pages/aws-kinesis-firehose-component.adoc @@ -206,7 +206,7 @@ Maven users will need to add the following dependency to their pom.xml. </dependency> --------------------------------------- -where `${camel-version}` must be replaced by the actual version of Camel. +where `\${camel-version}` must be replaced by the actual version of Camel. ### See Also diff --git a/docs/components/modules/ROOT/pages/aws-kms-component.adoc b/docs/components/modules/ROOT/pages/aws-kms-component.adoc index c35994a..56f8ece 100644 --- a/docs/components/modules/ROOT/pages/aws-kms-component.adoc +++ b/docs/components/modules/ROOT/pages/aws-kms-component.adoc @@ -179,7 +179,7 @@ Maven users will need to add the following dependency to their pom.xml. </dependency> --------------------------------------- -where `${camel-version}` must be replaced by the actual version of Camel. +where `\${camel-version}` must be replaced by the actual version of Camel. ### See Also diff --git a/docs/components/modules/ROOT/pages/aws-lambda-component.adoc b/docs/components/modules/ROOT/pages/aws-lambda-component.adoc index 969af66..4c27217 100644 --- a/docs/components/modules/ROOT/pages/aws-lambda-component.adoc +++ b/docs/components/modules/ROOT/pages/aws-lambda-component.adoc @@ -241,7 +241,7 @@ Maven users will need to add the following dependency to their pom.xml. </dependency> --------------------------------------- -where `${camel-version}` must be replaced by the actual version of Camel. +where `\${camel-version}` must be replaced by the actual version of Camel. ### See Also diff --git a/docs/components/modules/ROOT/pages/aws-mq-component.adoc b/docs/components/modules/ROOT/pages/aws-mq-component.adoc index 3321493..94a0132 100644 --- a/docs/components/modules/ROOT/pages/aws-mq-component.adoc +++ b/docs/components/modules/ROOT/pages/aws-mq-component.adoc @@ -180,7 +180,7 @@ Maven users will need to add the following dependency to their pom.xml. </dependency> --------------------------------------- -where `${camel-version}` must be replaced by the actual version of Camel. +where `\${camel-version}` must be replaced by the actual version of Camel. ### See Also diff --git a/docs/components/modules/ROOT/pages/aws-msk-component.adoc b/docs/components/modules/ROOT/pages/aws-msk-component.adoc index 87ae252..f4f81a0 100644 --- a/docs/components/modules/ROOT/pages/aws-msk-component.adoc +++ b/docs/components/modules/ROOT/pages/aws-msk-component.adoc @@ -183,7 +183,7 @@ Maven users will need to add the following dependency to their pom.xml. </dependency> --------------------------------------- -where `${camel-version}` must be replaced by the actual version of Camel. +where `\${camel-version}` must be replaced by the actual version of Camel. ### See Also diff --git a/docs/components/modules/ROOT/pages/aws-s3-component.adoc b/docs/components/modules/ROOT/pages/aws-s3-component.adoc index 0f3220b..d4f3955 100644 --- a/docs/components/modules/ROOT/pages/aws-s3-component.adoc +++ b/docs/components/modules/ROOT/pages/aws-s3-component.adoc @@ -536,7 +536,7 @@ Maven users will need to add the following dependency to their pom.xml. </dependency> --------------------------------------- -where `${camel-version}` must be replaced by the actual version of Camel. +where `\${camel-version}` must be replaced by the actual version of Camel. ### See Also diff --git a/docs/components/modules/ROOT/pages/aws-sdb-component.adoc b/docs/components/modules/ROOT/pages/aws-sdb-component.adoc index e2e4975f..1e7535c 100644 --- a/docs/components/modules/ROOT/pages/aws-sdb-component.adoc +++ b/docs/components/modules/ROOT/pages/aws-sdb-component.adoc @@ -255,7 +255,7 @@ Maven users will need to add the following dependency to their pom.xml. </dependency> --------------------------------------- -where `${camel-version}` must be replaced by the actual version of Camel. +where `\${camel-version}` must be replaced by the actual version of Camel. ### See Also diff --git a/docs/components/modules/ROOT/pages/aws-ses-component.adoc b/docs/components/modules/ROOT/pages/aws-ses-component.adoc index 89ec05c..88a74b8 100644 --- a/docs/components/modules/ROOT/pages/aws-ses-component.adoc +++ b/docs/components/modules/ROOT/pages/aws-ses-component.adoc @@ -216,7 +216,7 @@ This may be really useful for smarter configuration of the endpoint. </dependency> --------------------------------------- -where `${camel-version}` must be replaced by the actual version of Camel. +where `\${camel-version}` must be replaced by the actual version of Camel. ### See Also diff --git a/docs/components/modules/ROOT/pages/aws-sns-component.adoc b/docs/components/modules/ROOT/pages/aws-sns-component.adoc index 6f14c39..5e491d5 100644 --- a/docs/components/modules/ROOT/pages/aws-sns-component.adoc +++ b/docs/components/modules/ROOT/pages/aws-sns-component.adoc @@ -251,7 +251,7 @@ Maven users will need to add the following dependency to their pom.xml. </dependency> --------------------------------------- -where `${camel-version}` must be replaced by the actual version of Camel. +where `\${camel-version}` must be replaced by the actual version of Camel. ### See Also diff --git a/docs/components/modules/ROOT/pages/aws-sqs-component.adoc b/docs/components/modules/ROOT/pages/aws-sqs-component.adoc index 6863f75..8399773 100644 --- a/docs/components/modules/ROOT/pages/aws-sqs-component.adoc +++ b/docs/components/modules/ROOT/pages/aws-sqs-component.adoc @@ -323,7 +323,7 @@ Maven users will need to add the following dependency to their pom.xml. </dependency> --------------------------------------- -where `${camel-version}` must be replaced by the actual version of Camel. +where `\${camel-version}` must be replaced by the actual version of Camel. ### JMS-style Selectors diff --git a/docs/components/modules/ROOT/pages/aws-swf-component.adoc b/docs/components/modules/ROOT/pages/aws-swf-component.adoc index 4aceaf5..12612ab 100644 --- a/docs/components/modules/ROOT/pages/aws-swf-component.adoc +++ b/docs/components/modules/ROOT/pages/aws-swf-component.adoc @@ -306,7 +306,7 @@ Maven users will need to add the following dependency to their pom.xml. </dependency> --------------------------------------- -where `${camel-version}` must be replaced by the actual version of Camel. +where `\${camel-version}` must be replaced by the actual version of Camel. ### See Also diff --git a/docs/components/modules/ROOT/pages/file-component.adoc b/docs/components/modules/ROOT/pages/file-component.adoc index 54ba798..1e75755 100644 --- a/docs/components/modules/ROOT/pages/file-component.adoc +++ b/docs/components/modules/ROOT/pages/file-component.adoc @@ -92,8 +92,8 @@ with the following path and query parameters: |=== | Name | Description | Default | Type | *charset* (common) | This option is used to specify the encoding of the file. You can use this on the consumer, to specify the encodings of the files, which allow Camel to know the charset it should load the file content in case the file content is being accessed. Likewise when writing a file, you can use this option to specify which charset to write the file as well. Do mind that when writing the file Camel may have to read the message content into memory to be able to convert the dat [...] -| *doneFileName* (common) | Producer: If provided, then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Consumer: If provided, Camel will only consume files if a done file exists. This option configures what file name to use. Either you ca [...] -| *fileName* (common) | Use Expression such as File Language to dynamically set the filename. For consumers, it's used as a filename filter. For producers, it's used to evaluate the filename to write. If an expression is set, it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type, it is always evaluated using the File Language. If the express [...] +| *doneFileName* (common) | Producer: If provided, then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Consumer: If provided, Camel will only consume files if a done file exists. This option configures what file name to use. Either you ca [...] +| *fileName* (common) | Use Expression such as File Language to dynamically set the filename. For consumers, it's used as a filename filter. For producers, it's used to evaluate the filename to write. If an expression is set, it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type, it is always evaluated using the File Language. If the express [...] | *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | false | boolean | *delete* (consumer) | If true, the file will be deleted after it is processed successfully. | false | boolean | *moveFailed* (consumer) | Sets the move failure expression based on Simple language. For example, to move files into a .error subdirectory use: .error. Note: When moving the files to the fail location Camel will handle the error and will not pick up the file again. | | String @@ -140,10 +140,10 @@ with the following path and query parameters: | *eagerMaxMessagesPerPoll* (filter) | Allows for controlling whether the limit from maxMessagesPerPoll is eager or not. If eager then the limit is during the scanning of files. Where as false would scan all files, and then perform sorting. Setting this option to false allows for sorting all files first, and then limit the poll. Mind that this requires a higher memory usage as all file details are in memory to perform the sorting. | true | boolean | *exclude* (filter) | Is used to exclude files, if filename matches the regex pattern (matching is case in-senstive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris | | String | *filter* (filter) | Pluggable filter as a org.apache.camel.component.file.GenericFileFilter class. Will skip files if filter returns false in its accept() method. | | GenericFileFilter -| *filterDirectory* (filter) | Filters the directory based on Simple language. For example to filter on current date, you can use a simple date pattern such as ${date:now:yyyMMdd} | | String -| *filterFile* (filter) | Filters the file based on Simple language. For example to filter on file size, you can use ${file:size} 5000 | | String +| *filterDirectory* (filter) | Filters the directory based on Simple language. For example to filter on current date, you can use a simple date pattern such as \${date:now:yyyMMdd} | | String +| *filterFile* (filter) | Filters the file based on Simple language. For example to filter on file size, you can use \${file:size} 5000 | | String | *idempotent* (filter) | Option to use the Idempotent Consumer EIP pattern to let Camel skip already processed files. Will by default use a memory based LRUCache that holds 1000 entries. If noop=true then idempotent will be enabled as well to avoid consuming the same files over and over again. | false | Boolean -| *idempotentKey* (filter) | To use a custom idempotent key. By default the absolute path of the file is used. You can use the File Language, for example to use the file name and file size, you can do: idempotentKey=${file:name}-${file:size} | | String +| *idempotentKey* (filter) | To use a custom idempotent key. By default the absolute path of the file is used. You can use the File Language, for example to use the file name and file size, you can do: idempotentKey=\${file:name}-\${file:size} | | String | *idempotentRepository* (filter) | A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryMessageIdRepository if none is specified and idempotent is true. | | IdempotentRepository | *include* (filter) | Is used to include files, if filename matches the regex pattern (matching is case in-sensitive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris | | String | *maxDepth* (filter) | The maximum depth to traverse when recursively processing a directory. | 2147483647 | int @@ -288,7 +288,7 @@ of the directory and name pattern. + Camel will, in fact, internally convert the directory name you enter into a xref:file-language.adoc[File Language] expression. So when we enter `move=.done` Camel will convert this into: -`${``file:parent``}/.done/${``file:onlyname`}. This is only done if +`\${file:parent}/.done/${file:onlyname}`. This is only done if Camel detects that you have not provided a $\{ } in the option value yourself. So when you enter a $\{ } Camel will *not* convert it and thus you have the full power. diff --git a/docs/components/modules/ROOT/pages/ftp-component.adoc b/docs/components/modules/ROOT/pages/ftp-component.adoc index 27a8d04..757e558 100644 --- a/docs/components/modules/ROOT/pages/ftp-component.adoc +++ b/docs/components/modules/ROOT/pages/ftp-component.adoc @@ -111,8 +111,8 @@ with the following path and query parameters: | *binary* (common) | Specifies the file transfer mode, BINARY or ASCII. Default is ASCII (false). | false | boolean | *charset* (common) | This option is used to specify the encoding of the file. You can use this on the consumer, to specify the encodings of the files, which allow Camel to know the charset it should load the file content in case the file content is being accessed. Likewise when writing a file, you can use this option to specify which charset to write the file as well. Do mind that when writing the file Camel may have to read the message content into memory to be able to convert the dat [...] | *disconnect* (common) | Whether or not to disconnect from remote FTP server right after use. Disconnect will only disconnect the current connection to the FTP server. If you have a consumer which you want to stop, then you need to stop the consumer/route instead. | false | boolean -| *doneFileName* (common) | Producer: If provided, then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Consumer: If provided, Camel will only consume files if a done file exists. This option configures what file name to use. Either you ca [...] -| *fileName* (common) | Use Expression such as File Language to dynamically set the filename. For consumers, it's used as a filename filter. For producers, it's used to evaluate the filename to write. If an expression is set, it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type, it is always evaluated using the File Language. If the express [...] +| *doneFileName* (common) | Producer: If provided, then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Consumer: If provided, Camel will only consume files if a done file exists. This option configures what file name to use. Either you ca [...] +| *fileName* (common) | Use Expression such as File Language to dynamically set the filename. For consumers, it's used as a filename filter. For producers, it's used to evaluate the filename to write. If an expression is set, it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type, it is always evaluated using the File Language. If the express [...] | *passiveMode* (common) | Sets passive mode connections. Default is active mode connections. | false | boolean | *separator* (common) | Sets the path separator to be used. UNIX = Uses unix style path separator Windows = Uses windows style path separator Auto = (is default) Use existing path separator in file name | UNIX | PathSeparator | *transferLoggingInterval Seconds* (common) | Configures the interval in seconds to use when logging the progress of upload and download operations that are in-flight. This is used for logging progress when operations takes longer time. | 5 | int @@ -178,10 +178,10 @@ with the following path and query parameters: | *eagerMaxMessagesPerPoll* (filter) | Allows for controlling whether the limit from maxMessagesPerPoll is eager or not. If eager then the limit is during the scanning of files. Where as false would scan all files, and then perform sorting. Setting this option to false allows for sorting all files first, and then limit the poll. Mind that this requires a higher memory usage as all file details are in memory to perform the sorting. | true | boolean | *exclude* (filter) | Is used to exclude files, if filename matches the regex pattern (matching is case in-senstive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris | | String | *filter* (filter) | Pluggable filter as a org.apache.camel.component.file.GenericFileFilter class. Will skip files if filter returns false in its accept() method. | | GenericFileFilter -| *filterDirectory* (filter) | Filters the directory based on Simple language. For example to filter on current date, you can use a simple date pattern such as ${date:now:yyyMMdd} | | String -| *filterFile* (filter) | Filters the file based on Simple language. For example to filter on file size, you can use ${file:size} 5000 | | String +| *filterDirectory* (filter) | Filters the directory based on Simple language. For example to filter on current date, you can use a simple date pattern such as \${date:now:yyyMMdd} | | String +| *filterFile* (filter) | Filters the file based on Simple language. For example to filter on file size, you can use \${file:size} 5000 | | String | *idempotent* (filter) | Option to use the Idempotent Consumer EIP pattern to let Camel skip already processed files. Will by default use a memory based LRUCache that holds 1000 entries. If noop=true then idempotent will be enabled as well to avoid consuming the same files over and over again. | false | Boolean -| *idempotentKey* (filter) | To use a custom idempotent key. By default the absolute path of the file is used. You can use the File Language, for example to use the file name and file size, you can do: idempotentKey=${file:name}-${file:size} | | String +| *idempotentKey* (filter) | To use a custom idempotent key. By default the absolute path of the file is used. You can use the File Language, for example to use the file name and file size, you can do: idempotentKey=\${file:name}-\${file:size} | | String | *idempotentRepository* (filter) | A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryMessageIdRepository if none is specified and idempotent is true. | | IdempotentRepository | *include* (filter) | Is used to include files, if filename matches the regex pattern (matching is case in-sensitive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris | | String | *maxDepth* (filter) | The maximum depth to traverse when recursively processing a directory. | 2147483647 | int diff --git a/docs/components/modules/ROOT/pages/ftps-component.adoc b/docs/components/modules/ROOT/pages/ftps-component.adoc index d605dca..38bdb9c 100644 --- a/docs/components/modules/ROOT/pages/ftps-component.adoc +++ b/docs/components/modules/ROOT/pages/ftps-component.adoc @@ -70,8 +70,8 @@ with the following path and query parameters: | *binary* (common) | Specifies the file transfer mode, BINARY or ASCII. Default is ASCII (false). | false | boolean | *charset* (common) | This option is used to specify the encoding of the file. You can use this on the consumer, to specify the encodings of the files, which allow Camel to know the charset it should load the file content in case the file content is being accessed. Likewise when writing a file, you can use this option to specify which charset to write the file as well. Do mind that when writing the file Camel may have to read the message content into memory to be able to convert the dat [...] | *disconnect* (common) | Whether or not to disconnect from remote FTP server right after use. Disconnect will only disconnect the current connection to the FTP server. If you have a consumer which you want to stop, then you need to stop the consumer/route instead. | false | boolean -| *doneFileName* (common) | Producer: If provided, then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Consumer: If provided, Camel will only consume files if a done file exists. This option configures what file name to use. Either you ca [...] -| *fileName* (common) | Use Expression such as File Language to dynamically set the filename. For consumers, it's used as a filename filter. For producers, it's used to evaluate the filename to write. If an expression is set, it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type, it is always evaluated using the File Language. If the express [...] +| *doneFileName* (common) | Producer: If provided, then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Consumer: If provided, Camel will only consume files if a done file exists. This option configures what file name to use. Either you ca [...] +| *fileName* (common) | Use Expression such as File Language to dynamically set the filename. For consumers, it's used as a filename filter. For producers, it's used to evaluate the filename to write. If an expression is set, it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type, it is always evaluated using the File Language. If the express [...] | *passiveMode* (common) | Sets passive mode connections. Default is active mode connections. | false | boolean | *separator* (common) | Sets the path separator to be used. UNIX = Uses unix style path separator Windows = Uses windows style path separator Auto = (is default) Use existing path separator in file name | UNIX | PathSeparator | *transferLoggingInterval Seconds* (common) | Configures the interval in seconds to use when logging the progress of upload and download operations that are in-flight. This is used for logging progress when operations takes longer time. | 5 | int @@ -137,10 +137,10 @@ with the following path and query parameters: | *eagerMaxMessagesPerPoll* (filter) | Allows for controlling whether the limit from maxMessagesPerPoll is eager or not. If eager then the limit is during the scanning of files. Where as false would scan all files, and then perform sorting. Setting this option to false allows for sorting all files first, and then limit the poll. Mind that this requires a higher memory usage as all file details are in memory to perform the sorting. | true | boolean | *exclude* (filter) | Is used to exclude files, if filename matches the regex pattern (matching is case in-senstive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris | | String | *filter* (filter) | Pluggable filter as a org.apache.camel.component.file.GenericFileFilter class. Will skip files if filter returns false in its accept() method. | | GenericFileFilter -| *filterDirectory* (filter) | Filters the directory based on Simple language. For example to filter on current date, you can use a simple date pattern such as ${date:now:yyyMMdd} | | String -| *filterFile* (filter) | Filters the file based on Simple language. For example to filter on file size, you can use ${file:size} 5000 | | String +| *filterDirectory* (filter) | Filters the directory based on Simple language. For example to filter on current date, you can use a simple date pattern such as \${date:now:yyyMMdd} | | String +| *filterFile* (filter) | Filters the file based on Simple language. For example to filter on file size, you can use \${file:size} 5000 | | String | *idempotent* (filter) | Option to use the Idempotent Consumer EIP pattern to let Camel skip already processed files. Will by default use a memory based LRUCache that holds 1000 entries. If noop=true then idempotent will be enabled as well to avoid consuming the same files over and over again. | false | Boolean -| *idempotentKey* (filter) | To use a custom idempotent key. By default the absolute path of the file is used. You can use the File Language, for example to use the file name and file size, you can do: idempotentKey=${file:name}-${file:size} | | String +| *idempotentKey* (filter) | To use a custom idempotent key. By default the absolute path of the file is used. You can use the File Language, for example to use the file name and file size, you can do: idempotentKey=\${file:name}-\${file:size} | | String | *idempotentRepository* (filter) | A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryMessageIdRepository if none is specified and idempotent is true. | | IdempotentRepository | *include* (filter) | Is used to include files, if filename matches the regex pattern (matching is case in-sensitive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris | | String | *maxDepth* (filter) | The maximum depth to traverse when recursively processing a directory. | 2147483647 | int diff --git a/docs/components/modules/ROOT/pages/google-bigquery-sql-component.adoc b/docs/components/modules/ROOT/pages/google-bigquery-sql-component.adoc index 5673e1d..f2afc85 100644 --- a/docs/components/modules/ROOT/pages/google-bigquery-sql-component.adoc +++ b/docs/components/modules/ROOT/pages/google-bigquery-sql-component.adoc @@ -60,7 +60,7 @@ Examples: -------------------------------------------------------- where - * parameters in form ${name} are extracted from message headers and formed the translated query + * parameters in form \${name} are extracted from message headers and formed the translated query * parameters in form @name are extracted from body or message headers and sent to Google Bigquery You can externalize your SQL queries to files in the classpath or file system as shown: diff --git a/docs/components/modules/ROOT/pages/grok-dataformat.adoc b/docs/components/modules/ROOT/pages/grok-dataformat.adoc index eb71f040..b1413af 100644 --- a/docs/components/modules/ROOT/pages/grok-dataformat.adoc +++ b/docs/components/modules/ROOT/pages/grok-dataformat.adoc @@ -100,7 +100,7 @@ The Grok dataformat supports 5 options, which are listed below. | pattern | | String | The grok pattern to match lines of input | flattened | false | Boolean | Turns on flattened mode. In flattened mode the exception is thrown when there are multiple pattern matches with same key. | allowMultipleMatchesPerLine | true | Boolean | If false, every line of input is matched for pattern only once. Otherwise the line can be scanned multiple times when non-terminal pattern is used. -| namedOnly | false | Boolean | Whether to capture named expressions only or not (i.e. %{IP:ip} but not ${IP}) +| namedOnly | false | Boolean | Whether to capture named expressions only or not (i.e. %{IP:ip} but not \${IP}) | 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 @@ -131,7 +131,7 @@ The component supports 6 options, which are listed below. | *camel.dataformat.grok.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.grok.enabled* | Whether to enable auto configuration of the grok data format. This is enabled by default. | | Boolean | *camel.dataformat.grok.flattened* | Turns on flattened mode. In flattened mode the exception is thrown when there are multiple pattern matches with same key. | false | Boolean -| *camel.dataformat.grok.named-only* | Whether to capture named expressions only or not (i.e. %{IP:ip} but not ${IP}) | false | Boolean +| *camel.dataformat.grok.named-only* | Whether to capture named expressions only or not (i.e. %{IP:ip} but not \${IP}) | false | Boolean | *camel.dataformat.grok.pattern* | The grok pattern to match lines of input | | String |=== // spring-boot-auto-configure options: END diff --git a/docs/components/modules/ROOT/pages/grpc-component.adoc b/docs/components/modules/ROOT/pages/grpc-component.adoc index baefd4b..6589da1 100644 --- a/docs/components/modules/ROOT/pages/grpc-component.adoc +++ b/docs/components/modules/ROOT/pages/grpc-component.adoc @@ -270,7 +270,7 @@ It's it is recommended to use Maven Protocol Buffers Plugin which calls Protocol Following steps are required: -Insert operating system and CPU architecture detection extension inside **<build>** tag of the project pom.xml or set ${os.detected.classifier} parameter manually +Insert operating system and CPU architecture detection extension inside **<build>** tag of the project pom.xml or set \${os.detected.classifier} parameter manually [source,xml] ------------------------------------------------------------------------- <extensions> diff --git a/docs/components/modules/ROOT/pages/hipchat-component.adoc b/docs/components/modules/ROOT/pages/hipchat-component.adoc index 2c42b54..f1cdd59 100644 --- a/docs/components/modules/ROOT/pages/hipchat-component.adoc +++ b/docs/components/modules/ROOT/pages/hipchat-component.adoc @@ -258,4 +258,4 @@ Maven users will need to add the following dependency to their pom.xml. </dependency> ------------------------------------------ -where `${camel-version}` must be replaced by the actual version of Camel. +where `\${camel-version}` must be replaced by the actual version of Camel. diff --git a/docs/components/modules/ROOT/pages/jsonpath-language.adoc b/docs/components/modules/ROOT/pages/jsonpath-language.adoc index 92fbb12..e15dd12 100644 --- a/docs/components/modules/ROOT/pages/jsonpath-language.adoc +++ b/docs/components/modules/ROOT/pages/jsonpath-language.adoc @@ -212,7 +212,7 @@ This option is also available on the `@JsonPath` annotation. *Available as of Camel 2.18* -Its now possible to inlined Simple language expressions in the JSonPath expression using the simple syntax ${xxx}. +Its now possible to inlined Simple language expressions in the JSonPath expression using the simple syntax \${xxx}. An example is shown below: [source,java] diff --git a/docs/components/modules/ROOT/pages/protobuf-dataformat.adoc b/docs/components/modules/ROOT/pages/protobuf-dataformat.adoc index 1de8baa..200fd26 100644 --- a/docs/components/modules/ROOT/pages/protobuf-dataformat.adoc +++ b/docs/components/modules/ROOT/pages/protobuf-dataformat.adoc @@ -134,7 +134,7 @@ classes for the format we defined in our .proto file. If your operating system is supporting by https://www.xolstice.org/protobuf-maven-plugin[Protobuf Java code generator maven plugin], you can automate protobuf Java code generating by adding following configurations to your pom.xml: -Insert operating system and CPU architecture detection extension inside **<build>** tag of the project pom.xml or set ${os.detected.classifier} parameter manually +Insert operating system and CPU architecture detection extension inside **<build>** tag of the project pom.xml or set \${os.detected.classifier} parameter manually [source,xml] ------------------------------------------------------------------------- <extensions> diff --git a/docs/components/modules/ROOT/pages/scp-component.adoc b/docs/components/modules/ROOT/pages/scp-component.adoc index e1d2796..6298a59 100644 --- a/docs/components/modules/ROOT/pages/scp-component.adoc +++ b/docs/components/modules/ROOT/pages/scp-component.adoc @@ -92,7 +92,7 @@ with the following path and query parameters: | Name | Description | Default | Type | *disconnect* (common) | Whether or not to disconnect from remote FTP server right after use. Disconnect will only disconnect the current connection to the FTP server. If you have a consumer which you want to stop, then you need to stop the consumer/route instead. | false | boolean | *chmod* (producer) | Allows you to set chmod on the stored file. For example chmod=664. | 664 | String -| *fileName* (producer) | Use Expression such as File Language to dynamically set the filename. For consumers, it's used as a filename filter. For producers, it's used to evaluate the filename to write. If an expression is set, it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type, it is always evaluated using the File Language. If the expre [...] +| *fileName* (producer) | Use Expression such as File Language to dynamically set the filename. For consumers, it's used as a filename filter. For producers, it's used to evaluate the filename to write. If an expression is set, it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type, it is always evaluated using the File Language. If the expre [...] | *flatten* (producer) | Flatten is used to flatten the file name path to strip any leading paths, so it's just the file name. This allows you to consume recursively into sub-directories, but when you eg write the files to another directory they will be written in a single directory. Setting this to true on the producer enforces that any file name in CamelFileName header will be stripped for any leading paths. | false | boolean | *jailStartingDirectory* (producer) | Used for jailing (restricting) writing files to the starting directory (and sub) only. This is enabled by default to not allow Camel to write files to outside directories (to be more secured out of the box). You can turn this off to allow writing files to directories outside the starting directory, such as parent or root folders. | true | boolean | *lazyStartProducer* (producer) | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and [...] diff --git a/docs/components/modules/ROOT/pages/sftp-component.adoc b/docs/components/modules/ROOT/pages/sftp-component.adoc index 5052fb4..ebd3d23 100644 --- a/docs/components/modules/ROOT/pages/sftp-component.adoc +++ b/docs/components/modules/ROOT/pages/sftp-component.adoc @@ -68,8 +68,8 @@ with the following path and query parameters: | Name | Description | Default | Type | *charset* (common) | This option is used to specify the encoding of the file. You can use this on the consumer, to specify the encodings of the files, which allow Camel to know the charset it should load the file content in case the file content is being accessed. Likewise when writing a file, you can use this option to specify which charset to write the file as well. Do mind that when writing the file Camel may have to read the message content into memory to be able to convert the dat [...] | *disconnect* (common) | Whether or not to disconnect from remote FTP server right after use. Disconnect will only disconnect the current connection to the FTP server. If you have a consumer which you want to stop, then you need to stop the consumer/route instead. | false | boolean -| *doneFileName* (common) | Producer: If provided, then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Consumer: If provided, Camel will only consume files if a done file exists. This option configures what file name to use. Either you ca [...] -| *fileName* (common) | Use Expression such as File Language to dynamically set the filename. For consumers, it's used as a filename filter. For producers, it's used to evaluate the filename to write. If an expression is set, it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type, it is always evaluated using the File Language. If the express [...] +| *doneFileName* (common) | Producer: If provided, then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Consumer: If provided, Camel will only consume files if a done file exists. This option configures what file name to use. Either you ca [...] +| *fileName* (common) | Use Expression such as File Language to dynamically set the filename. For consumers, it's used as a filename filter. For producers, it's used to evaluate the filename to write. If an expression is set, it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type, it is always evaluated using the File Language. If the express [...] | *jschLoggingLevel* (common) | The logging level to use for JSCH activity logging. As JSCH is verbose at by default at INFO level the threshold is WARN by default. | WARN | LoggingLevel | *separator* (common) | Sets the path separator to be used. UNIX = Uses unix style path separator Windows = Uses windows style path separator Auto = (is default) Use existing path separator in file name | UNIX | PathSeparator | *fastExistsCheck* (common) | If set this option to be true, camel-ftp will use the list file directly to check if the file exists. Since some FTP server may not support to list the file directly, if the option is false, camel-ftp will use the old way to list the directory and check if the file exists. This option also influences readLock=changed to control whether it performs a fast check to update file information or not. This can be used to speed up the process if the FTP server has [...] @@ -129,10 +129,10 @@ with the following path and query parameters: | *eagerMaxMessagesPerPoll* (filter) | Allows for controlling whether the limit from maxMessagesPerPoll is eager or not. If eager then the limit is during the scanning of files. Where as false would scan all files, and then perform sorting. Setting this option to false allows for sorting all files first, and then limit the poll. Mind that this requires a higher memory usage as all file details are in memory to perform the sorting. | true | boolean | *exclude* (filter) | Is used to exclude files, if filename matches the regex pattern (matching is case in-senstive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris | | String | *filter* (filter) | Pluggable filter as a org.apache.camel.component.file.GenericFileFilter class. Will skip files if filter returns false in its accept() method. | | GenericFileFilter -| *filterDirectory* (filter) | Filters the directory based on Simple language. For example to filter on current date, you can use a simple date pattern such as ${date:now:yyyMMdd} | | String -| *filterFile* (filter) | Filters the file based on Simple language. For example to filter on file size, you can use ${file:size} 5000 | | String +| *filterDirectory* (filter) | Filters the directory based on Simple language. For example to filter on current date, you can use a simple date pattern such as \${date:now:yyyMMdd} | | String +| *filterFile* (filter) | Filters the file based on Simple language. For example to filter on file size, you can use \${file:size} 5000 | | String | *idempotent* (filter) | Option to use the Idempotent Consumer EIP pattern to let Camel skip already processed files. Will by default use a memory based LRUCache that holds 1000 entries. If noop=true then idempotent will be enabled as well to avoid consuming the same files over and over again. | false | Boolean -| *idempotentKey* (filter) | To use a custom idempotent key. By default the absolute path of the file is used. You can use the File Language, for example to use the file name and file size, you can do: idempotentKey=${file:name}-${file:size} | | String +| *idempotentKey* (filter) | To use a custom idempotent key. By default the absolute path of the file is used. You can use the File Language, for example to use the file name and file size, you can do: idempotentKey=\${file:name}-\${file:size} | | String | *idempotentRepository* (filter) | A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryMessageIdRepository if none is specified and idempotent is true. | | IdempotentRepository | *include* (filter) | Is used to include files, if filename matches the regex pattern (matching is case in-sensitive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris | | String | *maxDepth* (filter) | The maximum depth to traverse when recursively processing a directory. | 2147483647 | int diff --git a/tooling/maven/camel-package-maven-plugin/src/main/resources/component-options.mvel b/tooling/maven/camel-package-maven-plugin/src/main/resources/component-options.mvel index be58b7a..1faaccf 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/resources/component-options.mvel +++ b/tooling/maven/camel-package-maven-plugin/src/main/resources/component-options.mvel @@ -8,6 +8,6 @@ The @{title} component supports @{componentOptions.size()} options, which are li [width="100%",cols="2,5,^1,2",options="header"] |=== | Name | Description | Default | Type -@foreach{row : componentOptions}| *@{row.getShortName(25)}* (@{row.shortGroup}) | @{row.description} | @{row.getShortDefaultValue(20)} | @{row.getShortJavaType(25)} +@foreach{row : componentOptions}| *@{row.getShortName(25)}* (@{row.shortGroup}) | @{row.description.replaceAll("\\$", "\\\\\\$")} | @{row.getShortDefaultValue(20)} | @{row.getShortJavaType(25)} @end{}|=== -@end{} \ No newline at end of file +@end{} diff --git a/tooling/maven/camel-package-maven-plugin/src/main/resources/dataformat-options.mvel b/tooling/maven/camel-package-maven-plugin/src/main/resources/dataformat-options.mvel index db6bc27..c957b75 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/resources/dataformat-options.mvel +++ b/tooling/maven/camel-package-maven-plugin/src/main/resources/dataformat-options.mvel @@ -8,6 +8,6 @@ The @{title} dataformat supports @{dataFormatOptions.size()} options, which are [width="100%",cols="2s,1m,1m,6",options="header"] |=== | Name | Default | Java Type | Description -@foreach{row : dataFormatOptions}| @{row.name} | @{row.defaultValue} | @{row.shortJavaType} | @{row.description} +@foreach{row : dataFormatOptions}| @{row.name} | @{row.defaultValue} | @{row.shortJavaType} | @{row.description.replaceAll("\\$", "\\\\\\$")} @end{}|=== @end{} \ No newline at end of file diff --git a/tooling/maven/camel-package-maven-plugin/src/main/resources/eip-options.mvel b/tooling/maven/camel-package-maven-plugin/src/main/resources/eip-options.mvel index ee51c62..3ad7508 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/resources/eip-options.mvel +++ b/tooling/maven/camel-package-maven-plugin/src/main/resources/eip-options.mvel @@ -6,6 +6,6 @@ The @{title} EIP supports @{eipOptions.size()} options which are listed below: [width="100%",cols="2,5,^1,2",options="header"] |=== | Name | Description | Default | Type -@foreach{row : eipOptions}| *@{row.getShortName(30)}* | @{row.description} | @{row.getShortDefaultValue(20)} | @{row.getShortJavaType(25)} +@foreach{row : eipOptions}| *@{row.getShortName(30)}* | @{row.description.replaceAll("\\$", "\\\\\\$")} | @{row.getShortDefaultValue(20)} | @{row.getShortJavaType(25)} @end{}|=== @end{} \ No newline at end of file diff --git a/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel b/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel index 217313f..6cec166 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel +++ b/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel @@ -14,7 +14,7 @@ The @{title} endpoint has no path parameters. [width="100%",cols="2,5,^1,2",options="header"] |=== | Name | Description | Default | Type -@foreach{row : endpointPathOptions}| *@{row.getShortName(30)}* | @{row.description} | @{row.getShortDefaultValue(20)} | @{row.getShortJavaType(25)} +@foreach{row : endpointPathOptions}| *@{row.getShortName(30)}* | @{row.description.replaceAll("\\$", "\\\\\\$")} | @{row.getShortDefaultValue(20)} | @{row.getShortJavaType(25)} @end{}|=== @end{} @@ -26,6 +26,6 @@ The @{title} endpoint has no query parameters. [width="100%",cols="2,5,^1,2",options="header"] |=== | Name | Description | Default | Type -@foreach{row : endpointOptions}| *@{row.getShortName(30)}* (@{row.shortGroup}) | @{row.description} | @{row.getShortDefaultValue(20)} | @{row.getShortJavaType(25)} +@foreach{row : endpointOptions}| *@{row.getShortName(30)}* (@{row.shortGroup}) | @{row.description.replaceAll("\\$", "\\\\\\$")} | @{row.getShortDefaultValue(20)} | @{row.getShortJavaType(25)} @end{}|=== @end{} diff --git a/tooling/maven/camel-package-maven-plugin/src/main/resources/language-options.mvel b/tooling/maven/camel-package-maven-plugin/src/main/resources/language-options.mvel index 4c37a62..01ea4d8 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/resources/language-options.mvel +++ b/tooling/maven/camel-package-maven-plugin/src/main/resources/language-options.mvel @@ -8,6 +8,6 @@ The @{title} language supports @{languageOptions.size()} options, which are list [width="100%",cols="2,1m,1m,6",options="header"] |=== | Name | Default | Java Type | Description -@foreach{row : languageOptions}| @{row.name} | @{row.defaultValue} | @{row.shortJavaType} | @{row.description} +@foreach{row : languageOptions}| @{row.name} | @{row.defaultValue} | @{row.shortJavaType} | @{row.description.replaceAll("\\$", "\\\\\\$")} @end{}|=== @end{} \ No newline at end of file diff --git a/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-components.mvel b/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-components.mvel index fdc08e0..765a66e2 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-components.mvel +++ b/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-components.mvel @@ -7,7 +7,7 @@ Number of Components: @{components.size} in @{numberOfArtifacts} JAR artifacts ( | Component | Available From | Description @foreach{row : components} | link:@{row.docLink}/${row.scheme}-component.adoc[@{row.title}] (@{row.artifactId}) + -`@{row.syntax}` | @{row.firstVersionShort} | @if{row.deprecated == "true"}*deprecated* @end{}@{row.description} +`@{row.syntax}` | @{row.firstVersionShort} | @if{row.deprecated == "true"}*deprecated* @end{}@{row.description.replaceAll("\\$", "\\\\\\$")} @end{} |=== diff --git a/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-dataformats.mvel b/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-dataformats.mvel index fbe0987..3790e21 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-dataformats.mvel +++ b/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-dataformats.mvel @@ -6,7 +6,7 @@ Number of Data Formats: @{dataformats.size} in @{numberOfArtifacts} JAR artifact |=== | Data Format | Available From | Description @foreach{row : dataformats} -| link:@{row.docLink}/${row.name}-dataformat.adoc[@{row.title}] (@{row.artifactId}) | @{row.firstVersionShort} | @if{row.deprecated == "true"}*deprecated* @end{}@{row.description} +| link:@{row.docLink}/${row.name}-dataformat.adoc[@{row.title}] (@{row.artifactId}) | @{row.firstVersionShort} | @if{row.deprecated == "true"}*deprecated* @end{}@{row.description.replaceAll("\\$", "\\\\\\$")} @end{}|=== @end{} \ No newline at end of file diff --git a/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-eips.mvel b/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-eips.mvel index 1ba3a04..0869927 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-eips.mvel +++ b/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-eips.mvel @@ -7,7 +7,7 @@ Number of EIPs: @{eips.size} (@{numberOfDeprecated} deprecated) | EIP | Description @foreach{row : eips} | link:@{row.docLink}/${row.name}-eip.adoc[@{row.title}] + -`<@{row.name}>` | @if{row.deprecated == "true"}*deprecated* @end{}@{row.description} +`<@{row.name}>` | @if{row.deprecated == "true"}*deprecated* @end{}@{row.description.replaceAll("\\$", "\\\\\\$")} @end{} |=== diff --git a/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-examples.mvel b/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-examples.mvel index 770e519..72a3667 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-examples.mvel +++ b/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-examples.mvel @@ -6,7 +6,7 @@ Number of Examples: @{examples.size} (@{numberOfDeprecated} deprecated) |=== | Example | Category | Description @foreach{row : examples} -| link:@{row.docLink}[@{row.title}] (@{row.fileName}) | @{row.category} | @if{row.deprecated == "true"}*deprecated* @end{}@{row.description} +| link:@{row.docLink}[@{row.title}] (@{row.fileName}) | @{row.category} | @if{row.deprecated == "true"}*deprecated* @end{}@{row.description.replaceAll("\\$", "\\\\\\$")} @end{}|=== @end{} \ No newline at end of file diff --git a/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-languages.mvel b/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-languages.mvel index 3694975..120662f 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-languages.mvel +++ b/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-languages.mvel @@ -6,7 +6,7 @@ Number of Languages: @{languages.size} in @{numberOfArtifacts} JAR artifacts (@{ |=== | Language | Available From | Description @foreach{row : languages} -| link:@{row.docLink}/${row.name}-language.adoc[@{row.title}] (@{row.artifactId}) | @{row.firstVersionShort} | @if{row.deprecated == "true"}*deprecated* @end{}@{row.description} +| link:@{row.docLink}/${row.name}-language.adoc[@{row.title}] (@{row.artifactId}) | @{row.firstVersionShort} | @if{row.deprecated == "true"}*deprecated* @end{}@{row.description.replaceAll("\\$", "\\\\\\$")} @end{}|=== @end{} \ No newline at end of file diff --git a/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-others.mvel b/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-others.mvel index ccb02e1..7ae9c31 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-others.mvel +++ b/tooling/maven/camel-package-maven-plugin/src/main/resources/readme-others.mvel @@ -6,7 +6,7 @@ Number of Miscellaneous Components: @{others.size} in @{numberOfArtifacts} JAR a |=== | Component | Available From | Description @foreach{row : others} -| link:@{row.docLink}/${row.name}.adoc[@{row.title}] (@{row.artifactId}) | @{row.firstVersionShort} | @if{row.deprecated == "true"}*deprecated* @end{}@{row.description} +| link:@{row.docLink}/${row.name}.adoc[@{row.title}] (@{row.artifactId}) | @{row.firstVersionShort} | @if{row.deprecated == "true"}*deprecated* @end{}@{row.description.replaceAll("\\$", "\\\\\\$")} @end{}|=== @end{} \ No newline at end of file diff --git a/tooling/maven/camel-package-maven-plugin/src/main/resources/spring-boot-auto-configure-options.mvel b/tooling/maven/camel-package-maven-plugin/src/main/resources/spring-boot-auto-configure-options.mvel index 3b41a93..df18714 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/resources/spring-boot-auto-configure-options.mvel +++ b/tooling/maven/camel-package-maven-plugin/src/main/resources/spring-boot-auto-configure-options.mvel @@ -22,6 +22,6 @@ The component supports @{options.size()} options, which are listed below. [width="100%",cols="2,5,^1,2",options="header"] |=== | Name | Description | Default | Type -@foreach{row : options}| *@{row.name}* | @{row.description} | @{row.getShortDefaultValue(20)} | @{row.getShortJavaType(25)} +@foreach{row : options}| *@{row.name}* | @{row.description.replaceAll("\\$", "\\\\\\$")} | @{row.getShortDefaultValue(20)} | @{row.getShortJavaType(25)} @end{}|=== @end{} \ No newline at end of file diff --git a/tooling/maven/camel-restdsl-swagger-plugin/src/main/docs/camel-restdsl-swagger-plugin.adoc b/tooling/maven/camel-restdsl-swagger-plugin/src/main/docs/camel-restdsl-swagger-plugin.adoc index 356c0ba..4f73c4d 100644 --- a/tooling/maven/camel-restdsl-swagger-plugin/src/main/docs/camel-restdsl-swagger-plugin.adoc +++ b/tooling/maven/camel-restdsl-swagger-plugin/src/main/docs/camel-restdsl-swagger-plugin.adoc @@ -110,7 +110,7 @@ The plugin supports the following *additional* options |======================================== | Parameter | Default Value | Description | `swaggerCodegenMavenPluginVersion` | 2.3.1 | The version of the `io.swagger:swagger-codegen-maven-plugin` maven plugin to be used. -| `modelOutput` | | Target output path (default is ${project.build.directory}/generated-sources/swagger) +| `modelOutput` | | Target output path (default is \${project.build.directory}/generated-sources/swagger) | `modelPackage` | `io.swagger.client.model` | The package to use for generated model objects/classes | `modelNamePrefix` | | Sets the pre- or suffix for model classes and enums | `modelNameSuffix` | | Sets the pre- or suffix for model classes and enums @@ -176,7 +176,7 @@ The plugin supports the following *additional* options |======================================== | Parameter | Default Value | Description | `swaggerCodegenMavenPluginVersion` | 2.3.1 | The version of the `io.swagger:swagger-codegen-maven-plugin` maven plugin to be used. -| `modelOutput` | | Target output path (default is ${project.build.directory}/generated-sources/swagger) +| `modelOutput` | | Target output path (default is \${project.build.directory}/generated-sources/swagger) | `modelPackage` | `io.swagger.client.model` | The package to use for generated model objects/classes | `modelNamePrefix` | | Sets the pre- or suffix for model classes and enums | `modelNameSuffix` | | Sets the pre- or suffix for model classes and enums