You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by ac...@apache.org on 2023/06/28 10:54:34 UTC
[camel] 06/06: CAMEL-19279 - Added Azure-files component to kit
This is an automated email from the ASF dual-hosted git repository.
acosentino pushed a commit to branch CAMEL-19279-4.x
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 383b0dfa4497728c9b570f06d1d772f7f0e433b2
Author: Andrea Cosentino <an...@gmail.com>
AuthorDate: Wed Jun 28 12:52:35 2023 +0200
CAMEL-19279 - Added Azure-files component to kit
Signed-off-by: Andrea Cosentino <an...@gmail.com>
---
catalog/camel-allcomponents/pom.xml | 10 +-
.../org/apache/camel/catalog/components.properties | 1 +
.../camel/catalog/components/azure-files.json | 142 +
.../services/org/apache/camel/component.properties | 4 +-
.../camel/component/file/azure/azure-files.json | 228 +-
.../src/main/docs/azure-files-component.adoc | 5 +-
.../camel/component/file/azure/FilesEndpoint.java | 2 +-
.../camel/component/file/azure/FilesPath.java | 16 +
.../camel/component/file/azure/FilesProducer.java | 16 +
.../camel/component/file/azure/FilesToken.java | 18 +-
.../component/file/azure/FilesURIStrings.java | 16 +
.../component/file/azure/NormalizedOperations.java | 16 +
.../file/azure/FilesConfigurationTests.java | 16 +
.../component/file/azure/FilesEndpointTests.java | 18 +-
.../camel/component/file/azure/FilesPathTests.java | 16 +
.../component/file/azure/FilesURIStringsTests.java | 16 +
.../org/apache/camel/main/components.properties | 1 +
.../camel/converter/stream/InputStreamCache.java | 7 +-
.../modules/ROOT/examples/json/azure-files.json | 1 +
docs/components/modules/ROOT/nav.adoc | 1 +
.../modules/ROOT/pages/azure-files-component.adoc | 1 +
.../component/ComponentsBuilderFactory.java | 13 +
.../dsl/AzureFilesComponentBuilderFactory.java | 144 +
.../src/generated/resources/metadata.json | 23 +
.../builder/endpoint/EndpointBuilderFactory.java | 1 +
.../camel/builder/endpoint/EndpointBuilders.java | 1 +
.../builder/endpoint/StaticEndpointBuilders.java | 55 +
.../endpoint/dsl/FilesEndpointBuilderFactory.java | 4335 ++++++++++++++++++++
.../camel-component-known-dependencies.properties | 1 +
29 files changed, 4994 insertions(+), 130 deletions(-)
diff --git a/catalog/camel-allcomponents/pom.xml b/catalog/camel-allcomponents/pom.xml
index 44c63dcb343..e1cca1a01ee 100644
--- a/catalog/camel-allcomponents/pom.xml
+++ b/catalog/camel-allcomponents/pom.xml
@@ -228,11 +228,11 @@
<artifactId>camel-azure-eventhubs</artifactId>
<version>${project.version}</version>
</dependency>
- <dependency>
- <groupId>org.apache.camel</groupId>
- <artifactId>camel-azure-files</artifactId>
- <version>${project.version}</version>
- </dependency>
+ <dependency>
+ <groupId>org.apache.camel</groupId>
+ <artifactId>camel-azure-files</artifactId>
+ <version>${project.version}</version>
+ </dependency>
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-azure-key-vault</artifactId>
diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components.properties b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components.properties
index faac2add28a..b9d1583d995 100644
--- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components.properties
+++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components.properties
@@ -32,6 +32,7 @@ aws2-sts
aws2-translate
azure-cosmosdb
azure-eventhubs
+azure-files
azure-key-vault
azure-servicebus
azure-storage-blob
diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/azure-files.json b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/azure-files.json
new file mode 100644
index 00000000000..42fa178ac60
--- /dev/null
+++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/azure-files.json
@@ -0,0 +1,142 @@
+{
+ "component": {
+ "kind": "component",
+ "name": "azure-files",
+ "title": "Azure Files",
+ "description": "Camel Azure Files Component",
+ "deprecated": false,
+ "deprecationNote": "",
+ "firstVersion": "3.21.0",
+ "label": "cloud,file",
+ "javaType": "org.apache.camel.component.file.azure.FilesComponent",
+ "supportLevel": "Stable",
+ "groupId": "org.apache.camel",
+ "artifactId": "camel-azure-files",
+ "version": "4.0.0-SNAPSHOT",
+ "scheme": "azure-files",
+ "extendsScheme": "file",
+ "syntax": "azure-files:\/\/account[.host]\/share[\/dir]",
+ "async": false,
+ "api": false,
+ "consumerOnly": false,
+ "producerOnly": false,
+ "lenientProperties": false
+ },
+ "componentProperties": {
+ "bridgeErrorHandler": { "index": 0, "kind": "property", "displayName": "Bridge Error Handler", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "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 proce [...]
+ "lazyStartProducer": { "index": 1, "kind": "property", "displayName": "Lazy Start Producer", "group": "producer", "label": "producer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "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 [...]
+ "autowiredEnabled": { "index": 2, "kind": "property", "displayName": "Autowired Enabled", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching t [...]
+ },
+ "headers": {
+ "CamelFileLength": { "index": 0, "kind": "header", "displayName": "", "group": "both", "label": "both", "required": false, "javaType": "long", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "A long value containing the file size. For producer, known length helps if the body converts to InputStream more efficiently than to bytes array.", "constantName": "org.apache.camel.component.file.azure.FilesHeaders#FILE_LENGTH" },
+ "CamelFileLastModified": { "index": 1, "kind": "header", "displayName": "", "group": "consumer", "label": "consumer", "required": false, "javaType": "long", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "A Long value containing the last modified timestamp of the file.", "constantName": "org.apache.camel.component.file.azure.FilesHeaders#FILE_LAST_MODIFIED" },
+ "CamelFileName": { "index": 2, "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Specifies the output file name (relative to the endpoint directory) to be used for the output message when sending to the endpoint. If this is not present and no expression either, then a generated message ID is used as the filename instead.", "const [...]
+ "CamelFileNameOnly": { "index": 3, "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Only the file name (the name with no leading paths).", "constantName": "org.apache.camel.component.file.azure.FilesHeaders#FILE_NAME_ONLY" },
+ "CamelFileParent": { "index": 4, "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The parent path.", "constantName": "org.apache.camel.component.file.azure.FilesHeaders#FILE_PARENT" },
+ "CamelRemoteFileInputStream": { "index": 5, "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "java.io.InputStream", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The remote file input stream.", "constantName": "org.apache.camel.component.file.azure.FilesHeaders#REMOTE_FILE_INPUT_STREAM" },
+ "CamelFileLocalWorkPath": { "index": 6, "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Path to the local work file, if local work directory is used.", "constantName": "org.apache.camel.component.file.azure.FilesHeaders#FILE_LOCAL_WORK_PATH" },
+ "CamelFileHost": { "index": 7, "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The remote hostname.", "constantName": "org.apache.camel.component.file.azure.FilesHeaders#FILE_HOST" }
+ },
+ "properties": {
+ "host": { "index": 0, "kind": "path", "displayName": "Host", "group": "common", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.file.azure.FilesConfiguration", "configurationField": "configuration", "description": "Hostname of the FTP server" },
+ "port": { "index": 1, "kind": "path", "displayName": "Port", "group": "common", "label": "", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.file.azure.FilesConfiguration", "configurationField": "configuration", "description": "Port of the FTP server" },
+ "directoryName": { "index": 2, "kind": "path", "displayName": "Directory Name", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.file.azure.FilesConfiguration", "configurationField": "configuration", "description": "The starting directory" },
+ "disconnect": { "index": 3, "kind": "parameter", "displayName": "Disconnect", "group": "common", "label": "common", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "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 th [...]
+ "doneFileName": { "index": 4, "kind": "parameter", "displayName": "Done File Name", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "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 [...]
+ "fileName": { "index": 5, "kind": "parameter", "displayName": "File Name", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "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 CamelFil [...]
+ "delete": { "index": 6, "kind": "parameter", "displayName": "Delete", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "If true, the file will be deleted after it is processed successfully." },
+ "moveFailed": { "index": 7, "kind": "parameter", "displayName": "Move Failed", "group": "consumer", "label": "consumer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "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 [...]
+ "noop": { "index": 8, "kind": "parameter", "displayName": "Noop", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "If true, the file is not moved or deleted in any way. This option is good for readonly data, or for ETL type requirements. If noop=true, Camel will set idempotent=true as well, to avoid consuming the same files over and ov [...]
+ "preMove": { "index": 9, "kind": "parameter", "displayName": "Pre Move", "group": "consumer", "label": "consumer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Expression (such as File Language) used to dynamically set the filename when moving it before processing. For example to move in-progress files into the order directory set this value to order." },
+ "preSort": { "index": 10, "kind": "parameter", "displayName": "Pre Sort", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "When pre-sort is enabled then the consumer will sort the file and directory names during polling, that was retrieved from the file system. You may want to do this in case you need to operate on the files in a sorte [...]
+ "recursive": { "index": 11, "kind": "parameter", "displayName": "Recursive", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "If a directory, will look for files in all the sub-directories as well." },
+ "resumeDownload": { "index": 12, "kind": "parameter", "displayName": "Resume Download", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Configures whether resume download is enabled. In addition the options localWorkDirectory must be configured so downloaded files are stored in a local directory, which is required to support resuming [...]
+ "sendEmptyMessageWhenIdle": { "index": 13, "kind": "parameter", "displayName": "Send Empty Message When Idle", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead." },
+ "streamDownload": { "index": 14, "kind": "parameter", "displayName": "Stream Download", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.file.azure.FilesConfiguration", "configurationField": "configuration", "description": "Sets the download method to use when not using a local working directory. If se [...]
+ "bridgeErrorHandler": { "index": 15, "kind": "parameter", "displayName": "Bridge Error Handler", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "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 li [...]
+ "download": { "index": 16, "kind": "parameter", "displayName": "Download", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Whether the FTP consumer should download the file. If this option is set to false, then the message body will be null, but the consumer will still trigger a Camel Exchange that has details abou [...]
+ "exceptionHandler": { "index": 17, "kind": "parameter", "displayName": "Exception Handler", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.spi.ExceptionHandler", "optionalPrefix": "consumer.", "deprecated": false, "autowired": false, "secret": false, "description": "To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By de [...]
+ "exchangePattern": { "index": 18, "kind": "parameter", "displayName": "Exchange Pattern", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.ExchangePattern", "enum": [ "InOnly", "InOut" ], "deprecated": false, "autowired": false, "secret": false, "description": "Sets the exchange pattern when the consumer creates an exchange." },
+ "inProgressRepository": { "index": 19, "kind": "parameter", "displayName": "In Progress Repository", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.spi.IdempotentRepository", "deprecated": false, "autowired": false, "secret": false, "description": "A pluggable in-progress repository org.apache.camel.spi.IdempotentRepository. The in-progress repository is used to account the current in progress files bei [...]
+ "localWorkDirectory": { "index": 20, "kind": "parameter", "displayName": "Local Work Directory", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "When consuming, a local work directory can be used to store the remote file content directly in local files, to avoid loading the content into memory. This is beneficial, if you consume [...]
+ "onCompletionExceptionHandler": { "index": 21, "kind": "parameter", "displayName": "On Completion Exception Handler", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.spi.ExceptionHandler", "deprecated": false, "autowired": false, "secret": false, "description": "To use a custom org.apache.camel.spi.ExceptionHandler to handle any thrown exceptions that happens during the file on completion process where t [...]
+ "pollStrategy": { "index": 22, "kind": "parameter", "displayName": "Poll Strategy", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.spi.PollingConsumerPollStrategy", "deprecated": false, "autowired": false, "secret": false, "description": "A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the po [...]
+ "processStrategy": { "index": 23, "kind": "parameter", "displayName": "Process Strategy", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.component.file.GenericFileProcessStrategy<com.azure.storage.file.share.models.ShareFileItem>", "deprecated": false, "autowired": false, "secret": false, "description": "A pluggable org.apache.camel.component.file.GenericFileProcessStrategy allowing you to implement you [...]
+ "fileExist": { "index": 24, "kind": "parameter", "displayName": "File Exist", "group": "producer", "label": "producer", "required": false, "type": "object", "javaType": "org.apache.camel.component.file.GenericFileExist", "enum": [ "Override", "Append", "Fail", "Ignore", "Move", "TryRename" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "Override", "description": "What to do if a file already exists with the same name. Override, which is the default, repl [...]
+ "flatten": { "index": 25, "kind": "parameter", "displayName": "Flatten", "group": "producer", "label": "producer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "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 [...]
+ "jailStartingDirectory": { "index": 26, "kind": "parameter", "displayName": "Jail Starting Directory", "group": "producer", "label": "producer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "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 sec [...]
+ "tempFileName": { "index": 27, "kind": "parameter", "displayName": "Temp File Name", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "The same as tempPrefix option but offering a more fine grained control on the naming of the temporary filename as it uses the File Language. The location for tempFilename is relative to the final file location in the o [...]
+ "tempPrefix": { "index": 28, "kind": "parameter", "displayName": "Temp Prefix", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "This option is used to write the file using a temporary name and then, after the write is complete, rename it to the real name. Can be used to identify files being written and also avoid consumers (not using exclusive read [...]
+ "allowNullBody": { "index": 29, "kind": "parameter", "displayName": "Allow Null Body", "group": "producer (advanced)", "label": "producer,advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Used to specify if a null body is allowed during file writing. If set to true then an empty file will be created, when set to false, and attempting to send a null body to the file c [...]
+ "disconnectOnBatchComplete": { "index": 30, "kind": "parameter", "displayName": "Disconnect On Batch Complete", "group": "producer (advanced)", "label": "producer,advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Whether or not to disconnect from remote FTP server right after a Batch upload is complete. disconnectOnBatchComplete will only disconnect the current conne [...]
+ "eagerDeleteTargetFile": { "index": 31, "kind": "parameter", "displayName": "Eager Delete Target File", "group": "producer (advanced)", "label": "producer,advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether or not to eagerly delete any existing target file. This option only applies when you use fileExists=Override and the tempFileName option as well. You can use [...]
+ "keepLastModified": { "index": 32, "kind": "parameter", "displayName": "Keep Last Modified", "group": "producer (advanced)", "label": "producer,advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Will keep the last modified timestamp from the source file (if any). Will use the FileConstants.FILE_LAST_MODIFIED header to located the timestamp. This header can contain eit [...]
+ "lazyStartProducer": { "index": 33, "kind": "parameter", "displayName": "Lazy Start Producer", "group": "producer (advanced)", "label": "producer,advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "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 produ [...]
+ "moveExistingFileStrategy": { "index": 34, "kind": "parameter", "displayName": "Move Existing File Strategy", "group": "producer (advanced)", "label": "producer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.component.file.strategy.FileMoveExistingStrategy", "deprecated": false, "autowired": false, "secret": false, "description": "Strategy (Custom Strategy) used to move file with special naming token to use when fileExist=Move is configured. By default, [...]
+ "autoCreate": { "index": 35, "kind": "parameter", "displayName": "Auto Create", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Automatically create missing directories in the file's pathname. For the file consumer, that means creating the starting directory. For the file producer, it means the directory the files should be written to." },
+ "connectTimeout": { "index": 36, "kind": "parameter", "displayName": "Connect Timeout", "group": "advanced", "label": "advanced", "required": false, "type": "duration", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "10000", "configurationClass": "org.apache.camel.component.file.azure.FilesConfiguration", "configurationField": "configuration", "description": "Sets the connect timeout for waiting for a connection to be established Used by [...]
+ "maximumReconnectAttempts": { "index": 37, "kind": "parameter", "displayName": "Maximum Reconnect Attempts", "group": "advanced", "label": "advanced", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "description": "Specifies the maximum reconnect attempts Camel performs when it tries to connect to the remote FTP server. Use 0 to disable this behavior." },
+ "reconnectDelay": { "index": 38, "kind": "parameter", "displayName": "Reconnect Delay", "group": "advanced", "label": "advanced", "required": false, "type": "duration", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "1000", "description": "Delay in millis Camel will wait before performing a reconnect attempt." },
+ "throwExceptionOnConnectFailed": { "index": 39, "kind": "parameter", "displayName": "Throw Exception On Connect Failed", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.file.azure.FilesConfiguration", "configurationField": "configuration", "description": "Should an exception be thrown if connection fa [...]
+ "timeout": { "index": 40, "kind": "parameter", "displayName": "Timeout", "group": "advanced", "label": "advanced", "required": false, "type": "duration", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "30000", "configurationClass": "org.apache.camel.component.file.azure.FilesConfiguration", "configurationField": "configuration", "description": "Sets the data timeout for waiting for reply Used only by FTPClient" },
+ "sdd": { "index": 41, "kind": "parameter", "displayName": "Sdd", "group": "both", "label": "both", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.file.azure.FilesToken", "configurationField": "token", "description": "part of service SAS token" },
+ "se": { "index": 42, "kind": "parameter", "displayName": "Se", "group": "both", "label": "both", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.file.azure.FilesToken", "configurationField": "token", "description": "part of SAS token" },
+ "sharedKey": { "index": 43, "kind": "parameter", "displayName": "Shared Key", "group": "both", "label": "both", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.file.azure.FilesConfiguration", "configurationField": "configuration", "description": "Shared key (storage account key)" },
+ "si": { "index": 44, "kind": "parameter", "displayName": "Si", "group": "both", "label": "both", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.file.azure.FilesToken", "configurationField": "token", "description": "part of service SAS token" },
+ "sig": { "index": 45, "kind": "parameter", "displayName": "Sig", "group": "both", "label": "both", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.file.azure.FilesToken", "configurationField": "token", "description": "part of SAS token" },
+ "sip": { "index": 46, "kind": "parameter", "displayName": "Sip", "group": "both", "label": "both", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.file.azure.FilesToken", "configurationField": "token", "description": "part of SAS token" },
+ "sp": { "index": 47, "kind": "parameter", "displayName": "Sp", "group": "both", "label": "both", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.file.azure.FilesToken", "configurationField": "token", "description": "part of SAS token" },
+ "spr": { "index": 48, "kind": "parameter", "displayName": "Spr", "group": "both", "label": "both", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.file.azure.FilesToken", "configurationField": "token", "description": "part of SAS token" },
+ "sr": { "index": 49, "kind": "parameter", "displayName": "Sr", "group": "both", "label": "both", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.file.azure.FilesToken", "configurationField": "token", "description": "part of service SAS token" },
+ "srt": { "index": 50, "kind": "parameter", "displayName": "Srt", "group": "both", "label": "both", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.file.azure.FilesToken", "configurationField": "token", "description": "part of SAS token" },
+ "ss": { "index": 51, "kind": "parameter", "displayName": "Ss", "group": "both", "label": "both", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.file.azure.FilesToken", "configurationField": "token", "description": "part of account SAS token" },
+ "st": { "index": 52, "kind": "parameter", "displayName": "St", "group": "both", "label": "both", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.file.azure.FilesToken", "configurationField": "token", "description": "part of SAS token" },
+ "sv": { "index": 53, "kind": "parameter", "displayName": "Sv", "group": "both", "label": "both", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.file.azure.FilesToken", "configurationField": "token", "description": "part of SAS token" },
+ "antExclude": { "index": 54, "kind": "parameter", "displayName": "Ant Exclude", "group": "filter", "label": "consumer,filter", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Ant style filter exclusion. If both antInclude and antExclude are used, antExclude takes precedence over antInclude. Multiple exclusions may be specified in comma-delimited format." },
+ "antFilterCaseSensitive": { "index": 55, "kind": "parameter", "displayName": "Ant Filter Case Sensitive", "group": "filter", "label": "consumer,filter", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Sets case sensitive flag on ant filter." },
+ "antInclude": { "index": 56, "kind": "parameter", "displayName": "Ant Include", "group": "filter", "label": "consumer,filter", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Ant style filter inclusion. Multiple inclusions may be specified in comma-delimited format." },
+ "eagerMaxMessagesPerPoll": { "index": 57, "kind": "parameter", "displayName": "Eager Max Messages Per Poll", "group": "filter", "label": "consumer,filter", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "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, [...]
+ "exclude": { "index": 58, "kind": "parameter", "displayName": "Exclude", "group": "filter", "label": "consumer,filter", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Is used to exclude 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 th [...]
+ "excludeExt": { "index": 59, "kind": "parameter", "displayName": "Exclude Ext", "group": "filter", "label": "consumer,filter", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Is used to exclude files matching file extension name (case insensitive). For example to exclude bak files, then use excludeExt=bak. Multiple extensions can be separated by comma, for example to exclude bak and dat fil [...]
+ "filter": { "index": 60, "kind": "parameter", "displayName": "Filter", "group": "filter", "label": "consumer,filter", "required": false, "type": "object", "javaType": "org.apache.camel.component.file.GenericFileFilter<com.azure.storage.file.share.models.ShareFileItem>", "deprecated": false, "autowired": false, "secret": false, "description": "Pluggable filter as a org.apache.camel.component.file.GenericFileFilter class. Will skip files if filter returns false in its accept() method." },
+ "filterDirectory": { "index": 61, "kind": "parameter", "displayName": "Filter Directory", "group": "filter", "label": "consumer,filter", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "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}" },
+ "filterFile": { "index": 62, "kind": "parameter", "displayName": "Filter File", "group": "filter", "label": "consumer,filter", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Filters the file based on Simple language. For example to filter on file size, you can use ${file:size} 5000" },
+ "idempotent": { "index": 63, "kind": "parameter", "displayName": "Idempotent", "group": "filter", "label": "consumer,filter", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "false", "description": "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 w [...]
+ "idempotentKey": { "index": 64, "kind": "parameter", "displayName": "Idempotent Key", "group": "filter", "label": "consumer,filter", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "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}" },
+ "idempotentRepository": { "index": 65, "kind": "parameter", "displayName": "Idempotent Repository", "group": "filter", "label": "consumer,filter", "required": false, "type": "object", "javaType": "org.apache.camel.spi.IdempotentRepository", "deprecated": false, "autowired": false, "secret": false, "description": "A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryIdempotentRepository if none is specified and idempotent is true." },
+ "include": { "index": 66, "kind": "parameter", "displayName": "Include", "group": "filter", "label": "consumer,filter", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "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 th [...]
+ "includeExt": { "index": 67, "kind": "parameter", "displayName": "Include Ext", "group": "filter", "label": "consumer,filter", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Is used to include files matching file extension name (case insensitive). For example to include txt files, then use includeExt=txt. Multiple extensions can be separated by comma, for example to include txt and xml fil [...]
+ "maxDepth": { "index": 68, "kind": "parameter", "displayName": "Max Depth", "group": "filter", "label": "consumer,filter", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 2147483647, "description": "The maximum depth to traverse when recursively processing a directory." },
+ "maxMessagesPerPoll": { "index": 69, "kind": "parameter", "displayName": "Max Messages Per Poll", "group": "filter", "label": "consumer,filter", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "description": "To define a maximum messages to gather per poll. By default no maximum is set. Can be used to set a limit of e.g. 1000 to avoid when starting up the server that there are thousands of files. Set a value of 0 or n [...]
+ "minDepth": { "index": 70, "kind": "parameter", "displayName": "Min Depth", "group": "filter", "label": "consumer,filter", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "description": "The minimum depth to start processing when recursively processing a directory. Using minDepth=1 means the base directory. Using minDepth=2 means the first sub directory." },
+ "move": { "index": 71, "kind": "parameter", "displayName": "Move", "group": "filter", "label": "consumer,filter", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Expression (such as Simple Language) used to dynamically set the filename when moving it after processing. To move files into a .done subdirectory just enter .done." },
+ "exclusiveReadLockStrategy": { "index": 72, "kind": "parameter", "displayName": "Exclusive Read Lock Strategy", "group": "lock", "label": "consumer,lock", "required": false, "type": "object", "javaType": "org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy<com.azure.storage.file.share.models.ShareFileItem>", "deprecated": false, "autowired": false, "secret": false, "description": "Pluggable read-lock as a org.apache.camel.component.file.GenericFileExclusiveReadLockSt [...]
+ "readLock": { "index": 73, "kind": "parameter", "displayName": "Read Lock", "group": "lock", "label": "consumer,lock", "required": false, "type": "string", "javaType": "java.lang.String", "enum": [ "none", "markerFile", "fileLock", "rename", "changed", "idempotent", "idempotent-changed", "idempotent-rename" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "none", "description": "Used by consumer, to only poll the files if it has exclusive read-lock on the [...]
+ "readLockCheckInterval": { "index": 74, "kind": "parameter", "displayName": "Read Lock Check Interval", "group": "lock", "label": "consumer,lock", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 1000, "description": "Interval in millis for the read-lock, if supported by the read lock. This interval is used for sleeping between attempts to acquire the read lock. For example when using the changed read [...]
+ "readLockDeleteOrphanLockFiles": { "index": 75, "kind": "parameter", "displayName": "Read Lock Delete Orphan Lock Files", "group": "lock", "label": "consumer,lock", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether or not read lock with marker files should upon startup delete any orphan read lock files, which may have been left on the file system, if Camel was not proper [...]
+ "readLockLoggingLevel": { "index": 76, "kind": "parameter", "displayName": "Read Lock Logging Level", "group": "lock", "label": "consumer,lock", "required": false, "type": "object", "javaType": "org.apache.camel.LoggingLevel", "enum": [ "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "OFF" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "DEBUG", "description": "Logging level used when a read lock could not be acquired. By default a DEBUG is logged. You can cha [...]
+ "readLockMarkerFile": { "index": 77, "kind": "parameter", "displayName": "Read Lock Marker File", "group": "lock", "label": "consumer,lock", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether to use marker file with the changed, rename, or exclusive read lock types. By default a marker file is used as well to guard against other processes picking up the same files. This b [...]
+ "readLockMinAge": { "index": 78, "kind": "parameter", "displayName": "Read Lock Min Age", "group": "lock", "label": "consumer,lock", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 0, "description": "This option is applied only for readLock=changed. It allows to specify a minimum age the file must be before attempting to acquire the read lock. For example use readLockMinAge=300s to require the file is [...]
+ "readLockMinLength": { "index": 79, "kind": "parameter", "displayName": "Read Lock Min Length", "group": "lock", "label": "consumer,lock", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 1, "description": "This option is applied only for readLock=changed. It allows you to configure a minimum file length. By default Camel expects the file to contain data, and thus the default value is 1. You can set th [...]
+ "readLockRemoveOnCommit": { "index": 80, "kind": "parameter", "displayName": "Read Lock Remove On Commit", "group": "lock", "label": "consumer,lock", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "This option is applied only for readLock=idempotent. It allows to specify whether to remove the file name entry from the idempotent repository when processing the file is succeeded [...]
+ "readLockRemoveOnRollback": { "index": 81, "kind": "parameter", "displayName": "Read Lock Remove On Rollback", "group": "lock", "label": "consumer,lock", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "This option is applied only for readLock=idempotent. It allows to specify whether to remove the file name entry from the idempotent repository when processing the file failed an [...]
+ "readLockTimeout": { "index": 82, "kind": "parameter", "displayName": "Read Lock Timeout", "group": "lock", "label": "consumer,lock", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 10000, "description": "Optional timeout in millis for the read-lock, if supported by the read-lock. If the read-lock could not be granted and the timeout triggered, then Camel will skip the file. At next poll Camel, will t [...]
+ "backoffErrorThreshold": { "index": 83, "kind": "parameter", "displayName": "Backoff Error Threshold", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "description": "The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in." },
+ "backoffIdleThreshold": { "index": 84, "kind": "parameter", "displayName": "Backoff Idle Threshold", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "description": "The number of subsequent idle polls that should happen before the backoffMultipler should kick-in." },
+ "backoffMultiplier": { "index": 85, "kind": "parameter", "displayName": "Backoff Multiplier", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "description": "To let the scheduled polling consumer backoff if there has been a number of subsequent idles\/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is h [...]
+ "delay": { "index": 86, "kind": "parameter", "displayName": "Delay", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 500, "description": "Milliseconds before the next poll." },
+ "greedy": { "index": 87, "kind": "parameter", "displayName": "Greedy", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages." },
+ "initialDelay": { "index": 88, "kind": "parameter", "displayName": "Initial Delay", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 1000, "description": "Milliseconds before the first poll starts." },
+ "repeatCount": { "index": 89, "kind": "parameter", "displayName": "Repeat Count", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 0, "description": "Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever." },
+ "runLoggingLevel": { "index": 90, "kind": "parameter", "displayName": "Run Logging Level", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "org.apache.camel.LoggingLevel", "enum": [ "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "OFF" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "TRACE", "description": "The consumer logs a start\/complete log line when it polls. This option allows you to configure the l [...]
+ "scheduledExecutorService": { "index": 91, "kind": "parameter", "displayName": "Scheduled Executor Service", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "java.util.concurrent.ScheduledExecutorService", "deprecated": false, "autowired": false, "secret": false, "description": "Allows for configuring a custom\/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool." },
+ "scheduler": { "index": 92, "kind": "parameter", "displayName": "Scheduler", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "java.lang.Object", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "none", "description": "To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler" },
+ "schedulerProperties": { "index": 93, "kind": "parameter", "displayName": "Scheduler Properties", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "java.util.Map<java.lang.String, java.lang.Object>", "prefix": "scheduler.", "multiValue": true, "deprecated": false, "autowired": false, "secret": false, "description": "To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler." },
+ "startScheduler": { "index": 94, "kind": "parameter", "displayName": "Start Scheduler", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether the scheduler should be auto started." },
+ "timeUnit": { "index": 95, "kind": "parameter", "displayName": "Time Unit", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "java.util.concurrent.TimeUnit", "enum": [ "NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "MILLISECONDS", "description": "Time unit for initialDelay and delay options." },
+ "useFixedDelay": { "index": 96, "kind": "parameter", "displayName": "Use Fixed Delay", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details." },
+ "shuffle": { "index": 97, "kind": "parameter", "displayName": "Shuffle", "group": "sort", "label": "consumer,sort", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "To shuffle the list of files (sort in random order)" },
+ "sortBy": { "index": 98, "kind": "parameter", "displayName": "Sort By", "group": "sort", "label": "consumer,sort", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Built-in sort by using the File Language. Supports nested sorts, so you can have a sort by file name and as a 2nd group sort by modified date." },
+ "sorter": { "index": 99, "kind": "parameter", "displayName": "Sorter", "group": "sort", "label": "consumer,sort", "required": false, "type": "object", "javaType": "java.util.Comparator<org.apache.camel.component.file.GenericFile<com.azure.storage.file.share.models.ShareFileItem>>", "deprecated": false, "autowired": false, "secret": false, "description": "Pluggable sorter as a java.util.Comparator class." }
+ }
+}
diff --git a/components/camel-azure/camel-azure-files/src/generated/resources/META-INF/services/org/apache/camel/component.properties b/components/camel-azure/camel-azure-files/src/generated/resources/META-INF/services/org/apache/camel/component.properties
index 233a27d7d20..82524d8815e 100644
--- a/components/camel-azure/camel-azure-files/src/generated/resources/META-INF/services/org/apache/camel/component.properties
+++ b/components/camel-azure/camel-azure-files/src/generated/resources/META-INF/services/org/apache/camel/component.properties
@@ -2,6 +2,6 @@
components=azure-files
groupId=org.apache.camel
artifactId=camel-azure-files
-version=3.21.0-SNAPSHOT
+version=4.0.0-SNAPSHOT
projectName=Camel :: Azure Files
-projectDescription=Camel Azure Files Component (Preview)
+projectDescription=Camel Azure Files Component
diff --git a/components/camel-azure/camel-azure-files/src/generated/resources/org/apache/camel/component/file/azure/azure-files.json b/components/camel-azure/camel-azure-files/src/generated/resources/org/apache/camel/component/file/azure/azure-files.json
index 8ed1db2fe4e..42fa178ac60 100644
--- a/components/camel-azure/camel-azure-files/src/generated/resources/org/apache/camel/component/file/azure/azure-files.json
+++ b/components/camel-azure/camel-azure-files/src/generated/resources/org/apache/camel/component/file/azure/azure-files.json
@@ -3,16 +3,16 @@
"kind": "component",
"name": "azure-files",
"title": "Azure Files",
- "description": "Camel Azure Files Component (Preview)",
+ "description": "Camel Azure Files Component",
"deprecated": false,
"deprecationNote": "",
"firstVersion": "3.21.0",
"label": "cloud,file",
"javaType": "org.apache.camel.component.file.azure.FilesComponent",
- "supportLevel": "Preview",
+ "supportLevel": "Stable",
"groupId": "org.apache.camel",
"artifactId": "camel-azure-files",
- "version": "3.21.0-SNAPSHOT",
+ "version": "4.0.0-SNAPSHOT",
"scheme": "azure-files",
"extendsScheme": "file",
"syntax": "azure-files:\/\/account[.host]\/share[\/dir]",
@@ -23,120 +23,120 @@
"lenientProperties": false
},
"componentProperties": {
- "bridgeErrorHandler": { "kind": "property", "displayName": "Bridge Error Handler", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "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 me [...]
- "lazyStartProducer": { "kind": "property", "displayName": "Lazy Start Producer", "group": "producer", "label": "producer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "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 star [...]
- "autowiredEnabled": { "kind": "property", "displayName": "Autowired Enabled", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which t [...]
+ "bridgeErrorHandler": { "index": 0, "kind": "property", "displayName": "Bridge Error Handler", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "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 proce [...]
+ "lazyStartProducer": { "index": 1, "kind": "property", "displayName": "Lazy Start Producer", "group": "producer", "label": "producer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "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 [...]
+ "autowiredEnabled": { "index": 2, "kind": "property", "displayName": "Autowired Enabled", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching t [...]
},
"headers": {
- "CamelFileLength": { "kind": "header", "displayName": "", "group": "both", "label": "both", "required": false, "javaType": "long", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "A long value containing the file size. For producer, known length helps if the body converts to InputStream more efficiently than to bytes array.", "constantName": "org.apache.camel.component.file.azure.FilesHeaders#FILE_LENGTH" },
- "CamelFileLastModified": { "kind": "header", "displayName": "", "group": "consumer", "label": "consumer", "required": false, "javaType": "long", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "A Long value containing the last modified timestamp of the file.", "constantName": "org.apache.camel.component.file.azure.FilesHeaders#FILE_LAST_MODIFIED" },
- "CamelFileName": { "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Specifies the output file name (relative to the endpoint directory) to be used for the output message when sending to the endpoint. If this is not present and no expression either, then a generated message ID is used as the filename instead.", "constantName": "o [...]
- "CamelFileNameOnly": { "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Only the file name (the name with no leading paths).", "constantName": "org.apache.camel.component.file.azure.FilesHeaders#FILE_NAME_ONLY" },
- "CamelFileParent": { "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The parent path.", "constantName": "org.apache.camel.component.file.azure.FilesHeaders#FILE_PARENT" },
- "CamelRemoteFileInputStream": { "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "java.io.InputStream", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The remote file input stream.", "constantName": "org.apache.camel.component.file.azure.FilesHeaders#REMOTE_FILE_INPUT_STREAM" },
- "CamelFileLocalWorkPath": { "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Path to the local work file, if local work directory is used.", "constantName": "org.apache.camel.component.file.azure.FilesHeaders#FILE_LOCAL_WORK_PATH" },
- "CamelFileHost": { "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The remote hostname.", "constantName": "org.apache.camel.component.file.azure.FilesHeaders#FILE_HOST" }
+ "CamelFileLength": { "index": 0, "kind": "header", "displayName": "", "group": "both", "label": "both", "required": false, "javaType": "long", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "A long value containing the file size. For producer, known length helps if the body converts to InputStream more efficiently than to bytes array.", "constantName": "org.apache.camel.component.file.azure.FilesHeaders#FILE_LENGTH" },
+ "CamelFileLastModified": { "index": 1, "kind": "header", "displayName": "", "group": "consumer", "label": "consumer", "required": false, "javaType": "long", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "A Long value containing the last modified timestamp of the file.", "constantName": "org.apache.camel.component.file.azure.FilesHeaders#FILE_LAST_MODIFIED" },
+ "CamelFileName": { "index": 2, "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Specifies the output file name (relative to the endpoint directory) to be used for the output message when sending to the endpoint. If this is not present and no expression either, then a generated message ID is used as the filename instead.", "const [...]
+ "CamelFileNameOnly": { "index": 3, "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Only the file name (the name with no leading paths).", "constantName": "org.apache.camel.component.file.azure.FilesHeaders#FILE_NAME_ONLY" },
+ "CamelFileParent": { "index": 4, "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The parent path.", "constantName": "org.apache.camel.component.file.azure.FilesHeaders#FILE_PARENT" },
+ "CamelRemoteFileInputStream": { "index": 5, "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "java.io.InputStream", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The remote file input stream.", "constantName": "org.apache.camel.component.file.azure.FilesHeaders#REMOTE_FILE_INPUT_STREAM" },
+ "CamelFileLocalWorkPath": { "index": 6, "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Path to the local work file, if local work directory is used.", "constantName": "org.apache.camel.component.file.azure.FilesHeaders#FILE_LOCAL_WORK_PATH" },
+ "CamelFileHost": { "index": 7, "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The remote hostname.", "constantName": "org.apache.camel.component.file.azure.FilesHeaders#FILE_HOST" }
},
"properties": {
- "host": { "kind": "path", "displayName": "Host", "group": "common", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.file.azure.FilesConfiguration", "configurationField": "configuration", "description": "Hostname of the FTP server" },
- "port": { "kind": "path", "displayName": "Port", "group": "common", "label": "", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.file.azure.FilesConfiguration", "configurationField": "configuration", "description": "Port of the FTP server" },
- "directoryName": { "kind": "path", "displayName": "Directory Name", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.file.azure.FilesConfiguration", "configurationField": "configuration", "description": "The starting directory" },
- "disconnect": { "kind": "parameter", "displayName": "Disconnect", "group": "common", "label": "common", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "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\/ [...]
- "doneFileName": { "kind": "parameter", "displayName": "Done File Name", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "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 plac [...]
- "fileName": { "kind": "parameter", "displayName": "File Name", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "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 [...]
- "delete": { "kind": "parameter", "displayName": "Delete", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "If true, the file will be deleted after it is processed successfully." },
- "moveFailed": { "kind": "parameter", "displayName": "Move Failed", "group": "consumer", "label": "consumer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "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." },
- "noop": { "kind": "parameter", "displayName": "Noop", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "If true, the file is not moved or deleted in any way. This option is good for readonly data, or for ETL type requirements. If noop=true, Camel will set idempotent=true as well, to avoid consuming the same files over and over again." },
- "preMove": { "kind": "parameter", "displayName": "Pre Move", "group": "consumer", "label": "consumer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Expression (such as File Language) used to dynamically set the filename when moving it before processing. For example to move in-progress files into the order directory set this value to order." },
- "preSort": { "kind": "parameter", "displayName": "Pre Sort", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "When pre-sort is enabled then the consumer will sort the file and directory names during polling, that was retrieved from the file system. You may want to do this in case you need to operate on the files in a sorted order. The [...]
- "recursive": { "kind": "parameter", "displayName": "Recursive", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "If a directory, will look for files in all the sub-directories as well." },
- "resumeDownload": { "kind": "parameter", "displayName": "Resume Download", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Configures whether resume download is enabled. In addition the options localWorkDirectory must be configured so downloaded files are stored in a local directory, which is required to support resuming of downloads." },
- "sendEmptyMessageWhenIdle": { "kind": "parameter", "displayName": "Send Empty Message When Idle", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead." },
- "streamDownload": { "kind": "parameter", "displayName": "Stream Download", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.file.azure.FilesConfiguration", "configurationField": "configuration", "description": "Sets the download method to use when not using a local working directory. If set to true, th [...]
- "bridgeErrorHandler": { "kind": "parameter", "displayName": "Bridge Error Handler", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "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 [...]
- "download": { "kind": "parameter", "displayName": "Download", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Whether the FTP consumer should download the file. If this option is set to false, then the message body will be null, but the consumer will still trigger a Camel Exchange that has details about the file su [...]
- "exceptionHandler": { "kind": "parameter", "displayName": "Exception Handler", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.spi.ExceptionHandler", "optionalPrefix": "consumer.", "deprecated": false, "autowired": false, "secret": false, "description": "To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the con [...]
- "exchangePattern": { "kind": "parameter", "displayName": "Exchange Pattern", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.ExchangePattern", "enum": [ "InOnly", "InOut", "InOptionalOut" ], "deprecated": false, "autowired": false, "secret": false, "description": "Sets the exchange pattern when the consumer creates an exchange." },
- "inProgressRepository": { "kind": "parameter", "displayName": "In Progress Repository", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.spi.IdempotentRepository", "deprecated": false, "autowired": false, "secret": false, "description": "A pluggable in-progress repository org.apache.camel.spi.IdempotentRepository. The in-progress repository is used to account the current in progress files being consumed. [...]
- "localWorkDirectory": { "kind": "parameter", "displayName": "Local Work Directory", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "When consuming, a local work directory can be used to store the remote file content directly in local files, to avoid loading the content into memory. This is beneficial, if you consume a very big re [...]
- "onCompletionExceptionHandler": { "kind": "parameter", "displayName": "On Completion Exception Handler", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.spi.ExceptionHandler", "deprecated": false, "autowired": false, "secret": false, "description": "To use a custom org.apache.camel.spi.ExceptionHandler to handle any thrown exceptions that happens during the file on completion process where the consumer d [...]
- "pollStrategy": { "kind": "parameter", "displayName": "Poll Strategy", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.spi.PollingConsumerPollStrategy", "deprecated": false, "autowired": false, "secret": false, "description": "A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation [...]
- "processStrategy": { "kind": "parameter", "displayName": "Process Strategy", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.component.file.GenericFileProcessStrategy<com.azure.storage.file.share.models.ShareFileItem>", "deprecated": false, "autowired": false, "secret": false, "description": "A pluggable org.apache.camel.component.file.GenericFileProcessStrategy allowing you to implement your own readLoc [...]
- "fileExist": { "kind": "parameter", "displayName": "File Exist", "group": "producer", "label": "producer", "required": false, "type": "object", "javaType": "org.apache.camel.component.file.GenericFileExist", "enum": [ "Override", "Append", "Fail", "Ignore", "Move", "TryRename" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "Override", "description": "What to do if a file already exists with the same name. Override, which is the default, replaces the exis [...]
- "flatten": { "kind": "parameter", "displayName": "Flatten", "group": "producer", "label": "producer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "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 [...]
- "jailStartingDirectory": { "kind": "parameter", "displayName": "Jail Starting Directory", "group": "producer", "label": "producer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "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 t [...]
- "tempFileName": { "kind": "parameter", "displayName": "Temp File Name", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "The same as tempPrefix option but offering a more fine grained control on the naming of the temporary filename as it uses the File Language. The location for tempFilename is relative to the final file location in the option 'fileNa [...]
- "tempPrefix": { "kind": "parameter", "displayName": "Temp Prefix", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "This option is used to write the file using a temporary name and then, after the write is complete, rename it to the real name. Can be used to identify files being written and also avoid consumers (not using exclusive read locks) readin [...]
- "allowNullBody": { "kind": "parameter", "displayName": "Allow Null Body", "group": "producer (advanced)", "label": "producer,advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Used to specify if a null body is allowed during file writing. If set to true then an empty file will be created, when set to false, and attempting to send a null body to the file component, a G [...]
- "disconnectOnBatchComplete": { "kind": "parameter", "displayName": "Disconnect On Batch Complete", "group": "producer (advanced)", "label": "producer,advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Whether or not to disconnect from remote FTP server right after a Batch upload is complete. disconnectOnBatchComplete will only disconnect the current connection to the [...]
- "eagerDeleteTargetFile": { "kind": "parameter", "displayName": "Eager Delete Target File", "group": "producer (advanced)", "label": "producer,advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether or not to eagerly delete any existing target file. This option only applies when you use fileExists=Override and the tempFileName option as well. You can use this to disa [...]
- "keepLastModified": { "kind": "parameter", "displayName": "Keep Last Modified", "group": "producer (advanced)", "label": "producer,advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Will keep the last modified timestamp from the source file (if any). Will use the FileConstants.FILE_LAST_MODIFIED header to located the timestamp. This header can contain either a java.ut [...]
- "lazyStartProducer": { "kind": "parameter", "displayName": "Lazy Start Producer", "group": "producer (advanced)", "label": "producer,advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "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 other [...]
- "moveExistingFileStrategy": { "kind": "parameter", "displayName": "Move Existing File Strategy", "group": "producer (advanced)", "label": "producer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.component.file.strategy.FileMoveExistingStrategy", "deprecated": false, "autowired": false, "secret": false, "description": "Strategy (Custom Strategy) used to move file with special naming token to use when fileExist=Move is configured. By default, there is an [...]
- "autoCreate": { "kind": "parameter", "displayName": "Auto Create", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Automatically create missing directories in the file's pathname. For the file consumer, that means creating the starting directory. For the file producer, it means the directory the files should be written to." },
- "connectTimeout": { "kind": "parameter", "displayName": "Connect Timeout", "group": "advanced", "label": "advanced", "required": false, "type": "duration", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "10000", "configurationClass": "org.apache.camel.component.file.azure.FilesConfiguration", "configurationField": "configuration", "description": "Sets the connect timeout for waiting for a connection to be established Used by both FTPClien [...]
- "maximumReconnectAttempts": { "kind": "parameter", "displayName": "Maximum Reconnect Attempts", "group": "advanced", "label": "advanced", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "description": "Specifies the maximum reconnect attempts Camel performs when it tries to connect to the remote FTP server. Use 0 to disable this behavior." },
- "reconnectDelay": { "kind": "parameter", "displayName": "Reconnect Delay", "group": "advanced", "label": "advanced", "required": false, "type": "duration", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "1000", "description": "Delay in millis Camel will wait before performing a reconnect attempt." },
- "throwExceptionOnConnectFailed": { "kind": "parameter", "displayName": "Throw Exception On Connect Failed", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.file.azure.FilesConfiguration", "configurationField": "configuration", "description": "Should an exception be thrown if connection failed (exhaust [...]
- "timeout": { "kind": "parameter", "displayName": "Timeout", "group": "advanced", "label": "advanced", "required": false, "type": "duration", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "30000", "configurationClass": "org.apache.camel.component.file.azure.FilesConfiguration", "configurationField": "configuration", "description": "Sets the data timeout for waiting for reply Used only by FTPClient" },
- "sdd": { "kind": "parameter", "displayName": "Sdd", "group": "both", "label": "both", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.file.azure.FilesToken", "configurationField": "token", "description": "part of service SAS token" },
- "se": { "kind": "parameter", "displayName": "Se", "group": "both", "label": "both", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.file.azure.FilesToken", "configurationField": "token", "description": "part of SAS token" },
- "sharedKey": { "kind": "parameter", "displayName": "Shared Key", "group": "both", "label": "both", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.file.azure.FilesConfiguration", "configurationField": "configuration", "description": "Shared key (storage account key)" },
- "si": { "kind": "parameter", "displayName": "Si", "group": "both", "label": "both", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.file.azure.FilesToken", "configurationField": "token", "description": "part of service SAS token" },
- "sig": { "kind": "parameter", "displayName": "Sig", "group": "both", "label": "both", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.file.azure.FilesToken", "configurationField": "token", "description": "part of SAS token" },
- "sip": { "kind": "parameter", "displayName": "Sip", "group": "both", "label": "both", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.file.azure.FilesToken", "configurationField": "token", "description": "part of SAS token" },
- "sp": { "kind": "parameter", "displayName": "Sp", "group": "both", "label": "both", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.file.azure.FilesToken", "configurationField": "token", "description": "part of SAS token" },
- "spr": { "kind": "parameter", "displayName": "Spr", "group": "both", "label": "both", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.file.azure.FilesToken", "configurationField": "token", "description": "part of SAS token" },
- "sr": { "kind": "parameter", "displayName": "Sr", "group": "both", "label": "both", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.file.azure.FilesToken", "configurationField": "token", "description": "part of service SAS token" },
- "srt": { "kind": "parameter", "displayName": "Srt", "group": "both", "label": "both", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.file.azure.FilesToken", "configurationField": "token", "description": "part of SAS token" },
- "ss": { "kind": "parameter", "displayName": "Ss", "group": "both", "label": "both", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.file.azure.FilesToken", "configurationField": "token", "description": "part of account SAS token" },
- "st": { "kind": "parameter", "displayName": "St", "group": "both", "label": "both", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.file.azure.FilesToken", "configurationField": "token", "description": "part of SAS token" },
- "sv": { "kind": "parameter", "displayName": "Sv", "group": "both", "label": "both", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.file.azure.FilesToken", "configurationField": "token", "description": "part of SAS token" },
- "antExclude": { "kind": "parameter", "displayName": "Ant Exclude", "group": "filter", "label": "consumer,filter", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Ant style filter exclusion. If both antInclude and antExclude are used, antExclude takes precedence over antInclude. Multiple exclusions may be specified in comma-delimited format." },
- "antFilterCaseSensitive": { "kind": "parameter", "displayName": "Ant Filter Case Sensitive", "group": "filter", "label": "consumer,filter", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Sets case sensitive flag on ant filter." },
- "antInclude": { "kind": "parameter", "displayName": "Ant Include", "group": "filter", "label": "consumer,filter", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Ant style filter inclusion. Multiple inclusions may be specified in comma-delimited format." },
- "eagerMaxMessagesPerPoll": { "kind": "parameter", "displayName": "Eager Max Messages Per Poll", "group": "filter", "label": "consumer,filter", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "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 per [...]
- "exclude": { "kind": "parameter", "displayName": "Exclude", "group": "filter", "label": "consumer,filter", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Is used to exclude 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 endp [...]
- "excludeExt": { "kind": "parameter", "displayName": "Exclude Ext", "group": "filter", "label": "consumer,filter", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Is used to exclude files matching file extension name (case insensitive). For example to exclude bak files, then use excludeExt=bak. Multiple extensions can be separated by comma, for example to exclude bak and dat files, use exclu [...]
- "filter": { "kind": "parameter", "displayName": "Filter", "group": "filter", "label": "consumer,filter", "required": false, "type": "object", "javaType": "org.apache.camel.component.file.GenericFileFilter<com.azure.storage.file.share.models.ShareFileItem>", "deprecated": false, "autowired": false, "secret": false, "description": "Pluggable filter as a org.apache.camel.component.file.GenericFileFilter class. Will skip files if filter returns false in its accept() method." },
- "filterDirectory": { "kind": "parameter", "displayName": "Filter Directory", "group": "filter", "label": "consumer,filter", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "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}" },
- "filterFile": { "kind": "parameter", "displayName": "Filter File", "group": "filter", "label": "consumer,filter", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Filters the file based on Simple language. For example to filter on file size, you can use ${file:size} 5000" },
- "idempotent": { "kind": "parameter", "displayName": "Idempotent", "group": "filter", "label": "consumer,filter", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "false", "description": "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 enable [...]
- "idempotentKey": { "kind": "parameter", "displayName": "Idempotent Key", "group": "filter", "label": "consumer,filter", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "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}" },
- "idempotentRepository": { "kind": "parameter", "displayName": "Idempotent Repository", "group": "filter", "label": "consumer,filter", "required": false, "type": "object", "javaType": "org.apache.camel.spi.IdempotentRepository", "deprecated": false, "autowired": false, "secret": false, "description": "A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryIdempotentRepository if none is specified and idempotent is true." },
- "include": { "kind": "parameter", "displayName": "Include", "group": "filter", "label": "consumer,filter", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "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 endp [...]
- "includeExt": { "kind": "parameter", "displayName": "Include Ext", "group": "filter", "label": "consumer,filter", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Is used to include files matching file extension name (case insensitive). For example to include txt files, then use includeExt=txt. Multiple extensions can be separated by comma, for example to include txt and xml files, use inclu [...]
- "maxDepth": { "kind": "parameter", "displayName": "Max Depth", "group": "filter", "label": "consumer,filter", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 2147483647, "description": "The maximum depth to traverse when recursively processing a directory." },
- "maxMessagesPerPoll": { "kind": "parameter", "displayName": "Max Messages Per Poll", "group": "filter", "label": "consumer,filter", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "description": "To define a maximum messages to gather per poll. By default no maximum is set. Can be used to set a limit of e.g. 1000 to avoid when starting up the server that there are thousands of files. Set a value of 0 or negative to di [...]
- "minDepth": { "kind": "parameter", "displayName": "Min Depth", "group": "filter", "label": "consumer,filter", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "description": "The minimum depth to start processing when recursively processing a directory. Using minDepth=1 means the base directory. Using minDepth=2 means the first sub directory." },
- "move": { "kind": "parameter", "displayName": "Move", "group": "filter", "label": "consumer,filter", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Expression (such as Simple Language) used to dynamically set the filename when moving it after processing. To move files into a .done subdirectory just enter .done." },
- "exclusiveReadLockStrategy": { "kind": "parameter", "displayName": "Exclusive Read Lock Strategy", "group": "lock", "label": "consumer,lock", "required": false, "type": "object", "javaType": "org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy<com.azure.storage.file.share.models.ShareFileItem>", "deprecated": false, "autowired": false, "secret": false, "description": "Pluggable read-lock as a org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy implem [...]
- "readLock": { "kind": "parameter", "displayName": "Read Lock", "group": "lock", "label": "consumer,lock", "required": false, "type": "string", "javaType": "java.lang.String", "enum": [ "none", "markerFile", "fileLock", "rename", "changed", "idempotent", "idempotent-changed", "idempotent-rename" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "none", "description": "Used by consumer, to only poll the files if it has exclusive read-lock on the file (i.e. th [...]
- "readLockCheckInterval": { "kind": "parameter", "displayName": "Read Lock Check Interval", "group": "lock", "label": "consumer,lock", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 1000, "description": "Interval in millis for the read-lock, if supported by the read lock. This interval is used for sleeping between attempts to acquire the read lock. For example when using the changed read lock, you can [...]
- "readLockDeleteOrphanLockFiles": { "kind": "parameter", "displayName": "Read Lock Delete Orphan Lock Files", "group": "lock", "label": "consumer,lock", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether or not read lock with marker files should upon startup delete any orphan read lock files, which may have been left on the file system, if Camel was not properly shutdown ( [...]
- "readLockLoggingLevel": { "kind": "parameter", "displayName": "Read Lock Logging Level", "group": "lock", "label": "consumer,lock", "required": false, "type": "object", "javaType": "org.apache.camel.LoggingLevel", "enum": [ "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "OFF" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "DEBUG", "description": "Logging level used when a read lock could not be acquired. By default a DEBUG is logged. You can change this leve [...]
- "readLockMarkerFile": { "kind": "parameter", "displayName": "Read Lock Marker File", "group": "lock", "label": "consumer,lock", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether to use marker file with the changed, rename, or exclusive read lock types. By default a marker file is used as well to guard against other processes picking up the same files. This behavior can b [...]
- "readLockMinAge": { "kind": "parameter", "displayName": "Read Lock Min Age", "group": "lock", "label": "consumer,lock", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 0, "description": "This option is applied only for readLock=changed. It allows to specify a minimum age the file must be before attempting to acquire the read lock. For example use readLockMinAge=300s to require the file is at last 5 mi [...]
- "readLockMinLength": { "kind": "parameter", "displayName": "Read Lock Min Length", "group": "lock", "label": "consumer,lock", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 1, "description": "This option is applied only for readLock=changed. It allows you to configure a minimum file length. By default Camel expects the file to contain data, and thus the default value is 1. You can set this option to [...]
- "readLockRemoveOnCommit": { "kind": "parameter", "displayName": "Read Lock Remove On Commit", "group": "lock", "label": "consumer,lock", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "This option is applied only for readLock=idempotent. It allows to specify whether to remove the file name entry from the idempotent repository when processing the file is succeeded and a commit [...]
- "readLockRemoveOnRollback": { "kind": "parameter", "displayName": "Read Lock Remove On Rollback", "group": "lock", "label": "consumer,lock", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "This option is applied only for readLock=idempotent. It allows to specify whether to remove the file name entry from the idempotent repository when processing the file failed and a rollback [...]
- "readLockTimeout": { "kind": "parameter", "displayName": "Read Lock Timeout", "group": "lock", "label": "consumer,lock", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 10000, "description": "Optional timeout in millis for the read-lock, if supported by the read-lock. If the read-lock could not be granted and the timeout triggered, then Camel will skip the file. At next poll Camel, will try the file a [...]
- "backoffErrorThreshold": { "kind": "parameter", "displayName": "Backoff Error Threshold", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "description": "The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in." },
- "backoffIdleThreshold": { "kind": "parameter", "displayName": "Backoff Idle Threshold", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "description": "The number of subsequent idle polls that should happen before the backoffMultipler should kick-in." },
- "backoffMultiplier": { "kind": "parameter", "displayName": "Backoff Multiplier", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "description": "To let the scheduled polling consumer backoff if there has been a number of subsequent idles\/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening agai [...]
- "delay": { "kind": "parameter", "displayName": "Delay", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 500, "description": "Milliseconds before the next poll." },
- "greedy": { "kind": "parameter", "displayName": "Greedy", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages." },
- "initialDelay": { "kind": "parameter", "displayName": "Initial Delay", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 1000, "description": "Milliseconds before the first poll starts." },
- "repeatCount": { "kind": "parameter", "displayName": "Repeat Count", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 0, "description": "Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever." },
- "runLoggingLevel": { "kind": "parameter", "displayName": "Run Logging Level", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "org.apache.camel.LoggingLevel", "enum": [ "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "OFF" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "TRACE", "description": "The consumer logs a start\/complete log line when it polls. This option allows you to configure the logging level [...]
- "scheduledExecutorService": { "kind": "parameter", "displayName": "Scheduled Executor Service", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "java.util.concurrent.ScheduledExecutorService", "deprecated": false, "autowired": false, "secret": false, "description": "Allows for configuring a custom\/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool." },
- "scheduler": { "kind": "parameter", "displayName": "Scheduler", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "java.lang.Object", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "none", "description": "To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler" },
- "schedulerProperties": { "kind": "parameter", "displayName": "Scheduler Properties", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "java.util.Map<java.lang.String, java.lang.Object>", "prefix": "scheduler.", "multiValue": true, "deprecated": false, "autowired": false, "secret": false, "description": "To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler." },
- "startScheduler": { "kind": "parameter", "displayName": "Start Scheduler", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether the scheduler should be auto started." },
- "timeUnit": { "kind": "parameter", "displayName": "Time Unit", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "java.util.concurrent.TimeUnit", "enum": [ "NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "MILLISECONDS", "description": "Time unit for initialDelay and delay options." },
- "useFixedDelay": { "kind": "parameter", "displayName": "Use Fixed Delay", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details." },
- "shuffle": { "kind": "parameter", "displayName": "Shuffle", "group": "sort", "label": "consumer,sort", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "To shuffle the list of files (sort in random order)" },
- "sortBy": { "kind": "parameter", "displayName": "Sort By", "group": "sort", "label": "consumer,sort", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Built-in sort by using the File Language. Supports nested sorts, so you can have a sort by file name and as a 2nd group sort by modified date." },
- "sorter": { "kind": "parameter", "displayName": "Sorter", "group": "sort", "label": "consumer,sort", "required": false, "type": "object", "javaType": "java.util.Comparator<org.apache.camel.component.file.GenericFile<com.azure.storage.file.share.models.ShareFileItem>>", "deprecated": false, "autowired": false, "secret": false, "description": "Pluggable sorter as a java.util.Comparator class." }
+ "host": { "index": 0, "kind": "path", "displayName": "Host", "group": "common", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.file.azure.FilesConfiguration", "configurationField": "configuration", "description": "Hostname of the FTP server" },
+ "port": { "index": 1, "kind": "path", "displayName": "Port", "group": "common", "label": "", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.file.azure.FilesConfiguration", "configurationField": "configuration", "description": "Port of the FTP server" },
+ "directoryName": { "index": 2, "kind": "path", "displayName": "Directory Name", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.file.azure.FilesConfiguration", "configurationField": "configuration", "description": "The starting directory" },
+ "disconnect": { "index": 3, "kind": "parameter", "displayName": "Disconnect", "group": "common", "label": "common", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "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 th [...]
+ "doneFileName": { "index": 4, "kind": "parameter", "displayName": "Done File Name", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "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 [...]
+ "fileName": { "index": 5, "kind": "parameter", "displayName": "File Name", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "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 CamelFil [...]
+ "delete": { "index": 6, "kind": "parameter", "displayName": "Delete", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "If true, the file will be deleted after it is processed successfully." },
+ "moveFailed": { "index": 7, "kind": "parameter", "displayName": "Move Failed", "group": "consumer", "label": "consumer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "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 [...]
+ "noop": { "index": 8, "kind": "parameter", "displayName": "Noop", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "If true, the file is not moved or deleted in any way. This option is good for readonly data, or for ETL type requirements. If noop=true, Camel will set idempotent=true as well, to avoid consuming the same files over and ov [...]
+ "preMove": { "index": 9, "kind": "parameter", "displayName": "Pre Move", "group": "consumer", "label": "consumer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Expression (such as File Language) used to dynamically set the filename when moving it before processing. For example to move in-progress files into the order directory set this value to order." },
+ "preSort": { "index": 10, "kind": "parameter", "displayName": "Pre Sort", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "When pre-sort is enabled then the consumer will sort the file and directory names during polling, that was retrieved from the file system. You may want to do this in case you need to operate on the files in a sorte [...]
+ "recursive": { "index": 11, "kind": "parameter", "displayName": "Recursive", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "If a directory, will look for files in all the sub-directories as well." },
+ "resumeDownload": { "index": 12, "kind": "parameter", "displayName": "Resume Download", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Configures whether resume download is enabled. In addition the options localWorkDirectory must be configured so downloaded files are stored in a local directory, which is required to support resuming [...]
+ "sendEmptyMessageWhenIdle": { "index": 13, "kind": "parameter", "displayName": "Send Empty Message When Idle", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead." },
+ "streamDownload": { "index": 14, "kind": "parameter", "displayName": "Stream Download", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.file.azure.FilesConfiguration", "configurationField": "configuration", "description": "Sets the download method to use when not using a local working directory. If se [...]
+ "bridgeErrorHandler": { "index": 15, "kind": "parameter", "displayName": "Bridge Error Handler", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "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 li [...]
+ "download": { "index": 16, "kind": "parameter", "displayName": "Download", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Whether the FTP consumer should download the file. If this option is set to false, then the message body will be null, but the consumer will still trigger a Camel Exchange that has details abou [...]
+ "exceptionHandler": { "index": 17, "kind": "parameter", "displayName": "Exception Handler", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.spi.ExceptionHandler", "optionalPrefix": "consumer.", "deprecated": false, "autowired": false, "secret": false, "description": "To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By de [...]
+ "exchangePattern": { "index": 18, "kind": "parameter", "displayName": "Exchange Pattern", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.ExchangePattern", "enum": [ "InOnly", "InOut" ], "deprecated": false, "autowired": false, "secret": false, "description": "Sets the exchange pattern when the consumer creates an exchange." },
+ "inProgressRepository": { "index": 19, "kind": "parameter", "displayName": "In Progress Repository", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.spi.IdempotentRepository", "deprecated": false, "autowired": false, "secret": false, "description": "A pluggable in-progress repository org.apache.camel.spi.IdempotentRepository. The in-progress repository is used to account the current in progress files bei [...]
+ "localWorkDirectory": { "index": 20, "kind": "parameter", "displayName": "Local Work Directory", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "When consuming, a local work directory can be used to store the remote file content directly in local files, to avoid loading the content into memory. This is beneficial, if you consume [...]
+ "onCompletionExceptionHandler": { "index": 21, "kind": "parameter", "displayName": "On Completion Exception Handler", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.spi.ExceptionHandler", "deprecated": false, "autowired": false, "secret": false, "description": "To use a custom org.apache.camel.spi.ExceptionHandler to handle any thrown exceptions that happens during the file on completion process where t [...]
+ "pollStrategy": { "index": 22, "kind": "parameter", "displayName": "Poll Strategy", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.spi.PollingConsumerPollStrategy", "deprecated": false, "autowired": false, "secret": false, "description": "A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the po [...]
+ "processStrategy": { "index": 23, "kind": "parameter", "displayName": "Process Strategy", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.component.file.GenericFileProcessStrategy<com.azure.storage.file.share.models.ShareFileItem>", "deprecated": false, "autowired": false, "secret": false, "description": "A pluggable org.apache.camel.component.file.GenericFileProcessStrategy allowing you to implement you [...]
+ "fileExist": { "index": 24, "kind": "parameter", "displayName": "File Exist", "group": "producer", "label": "producer", "required": false, "type": "object", "javaType": "org.apache.camel.component.file.GenericFileExist", "enum": [ "Override", "Append", "Fail", "Ignore", "Move", "TryRename" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "Override", "description": "What to do if a file already exists with the same name. Override, which is the default, repl [...]
+ "flatten": { "index": 25, "kind": "parameter", "displayName": "Flatten", "group": "producer", "label": "producer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "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 [...]
+ "jailStartingDirectory": { "index": 26, "kind": "parameter", "displayName": "Jail Starting Directory", "group": "producer", "label": "producer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "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 sec [...]
+ "tempFileName": { "index": 27, "kind": "parameter", "displayName": "Temp File Name", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "The same as tempPrefix option but offering a more fine grained control on the naming of the temporary filename as it uses the File Language. The location for tempFilename is relative to the final file location in the o [...]
+ "tempPrefix": { "index": 28, "kind": "parameter", "displayName": "Temp Prefix", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "This option is used to write the file using a temporary name and then, after the write is complete, rename it to the real name. Can be used to identify files being written and also avoid consumers (not using exclusive read [...]
+ "allowNullBody": { "index": 29, "kind": "parameter", "displayName": "Allow Null Body", "group": "producer (advanced)", "label": "producer,advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Used to specify if a null body is allowed during file writing. If set to true then an empty file will be created, when set to false, and attempting to send a null body to the file c [...]
+ "disconnectOnBatchComplete": { "index": 30, "kind": "parameter", "displayName": "Disconnect On Batch Complete", "group": "producer (advanced)", "label": "producer,advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Whether or not to disconnect from remote FTP server right after a Batch upload is complete. disconnectOnBatchComplete will only disconnect the current conne [...]
+ "eagerDeleteTargetFile": { "index": 31, "kind": "parameter", "displayName": "Eager Delete Target File", "group": "producer (advanced)", "label": "producer,advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether or not to eagerly delete any existing target file. This option only applies when you use fileExists=Override and the tempFileName option as well. You can use [...]
+ "keepLastModified": { "index": 32, "kind": "parameter", "displayName": "Keep Last Modified", "group": "producer (advanced)", "label": "producer,advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Will keep the last modified timestamp from the source file (if any). Will use the FileConstants.FILE_LAST_MODIFIED header to located the timestamp. This header can contain eit [...]
+ "lazyStartProducer": { "index": 33, "kind": "parameter", "displayName": "Lazy Start Producer", "group": "producer (advanced)", "label": "producer,advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "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 produ [...]
+ "moveExistingFileStrategy": { "index": 34, "kind": "parameter", "displayName": "Move Existing File Strategy", "group": "producer (advanced)", "label": "producer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.component.file.strategy.FileMoveExistingStrategy", "deprecated": false, "autowired": false, "secret": false, "description": "Strategy (Custom Strategy) used to move file with special naming token to use when fileExist=Move is configured. By default, [...]
+ "autoCreate": { "index": 35, "kind": "parameter", "displayName": "Auto Create", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Automatically create missing directories in the file's pathname. For the file consumer, that means creating the starting directory. For the file producer, it means the directory the files should be written to." },
+ "connectTimeout": { "index": 36, "kind": "parameter", "displayName": "Connect Timeout", "group": "advanced", "label": "advanced", "required": false, "type": "duration", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "10000", "configurationClass": "org.apache.camel.component.file.azure.FilesConfiguration", "configurationField": "configuration", "description": "Sets the connect timeout for waiting for a connection to be established Used by [...]
+ "maximumReconnectAttempts": { "index": 37, "kind": "parameter", "displayName": "Maximum Reconnect Attempts", "group": "advanced", "label": "advanced", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "description": "Specifies the maximum reconnect attempts Camel performs when it tries to connect to the remote FTP server. Use 0 to disable this behavior." },
+ "reconnectDelay": { "index": 38, "kind": "parameter", "displayName": "Reconnect Delay", "group": "advanced", "label": "advanced", "required": false, "type": "duration", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "1000", "description": "Delay in millis Camel will wait before performing a reconnect attempt." },
+ "throwExceptionOnConnectFailed": { "index": 39, "kind": "parameter", "displayName": "Throw Exception On Connect Failed", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.file.azure.FilesConfiguration", "configurationField": "configuration", "description": "Should an exception be thrown if connection fa [...]
+ "timeout": { "index": 40, "kind": "parameter", "displayName": "Timeout", "group": "advanced", "label": "advanced", "required": false, "type": "duration", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "30000", "configurationClass": "org.apache.camel.component.file.azure.FilesConfiguration", "configurationField": "configuration", "description": "Sets the data timeout for waiting for reply Used only by FTPClient" },
+ "sdd": { "index": 41, "kind": "parameter", "displayName": "Sdd", "group": "both", "label": "both", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.file.azure.FilesToken", "configurationField": "token", "description": "part of service SAS token" },
+ "se": { "index": 42, "kind": "parameter", "displayName": "Se", "group": "both", "label": "both", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.file.azure.FilesToken", "configurationField": "token", "description": "part of SAS token" },
+ "sharedKey": { "index": 43, "kind": "parameter", "displayName": "Shared Key", "group": "both", "label": "both", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.file.azure.FilesConfiguration", "configurationField": "configuration", "description": "Shared key (storage account key)" },
+ "si": { "index": 44, "kind": "parameter", "displayName": "Si", "group": "both", "label": "both", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.file.azure.FilesToken", "configurationField": "token", "description": "part of service SAS token" },
+ "sig": { "index": 45, "kind": "parameter", "displayName": "Sig", "group": "both", "label": "both", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.file.azure.FilesToken", "configurationField": "token", "description": "part of SAS token" },
+ "sip": { "index": 46, "kind": "parameter", "displayName": "Sip", "group": "both", "label": "both", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.file.azure.FilesToken", "configurationField": "token", "description": "part of SAS token" },
+ "sp": { "index": 47, "kind": "parameter", "displayName": "Sp", "group": "both", "label": "both", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.file.azure.FilesToken", "configurationField": "token", "description": "part of SAS token" },
+ "spr": { "index": 48, "kind": "parameter", "displayName": "Spr", "group": "both", "label": "both", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.file.azure.FilesToken", "configurationField": "token", "description": "part of SAS token" },
+ "sr": { "index": 49, "kind": "parameter", "displayName": "Sr", "group": "both", "label": "both", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.file.azure.FilesToken", "configurationField": "token", "description": "part of service SAS token" },
+ "srt": { "index": 50, "kind": "parameter", "displayName": "Srt", "group": "both", "label": "both", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.file.azure.FilesToken", "configurationField": "token", "description": "part of SAS token" },
+ "ss": { "index": 51, "kind": "parameter", "displayName": "Ss", "group": "both", "label": "both", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.file.azure.FilesToken", "configurationField": "token", "description": "part of account SAS token" },
+ "st": { "index": 52, "kind": "parameter", "displayName": "St", "group": "both", "label": "both", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.file.azure.FilesToken", "configurationField": "token", "description": "part of SAS token" },
+ "sv": { "index": 53, "kind": "parameter", "displayName": "Sv", "group": "both", "label": "both", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.file.azure.FilesToken", "configurationField": "token", "description": "part of SAS token" },
+ "antExclude": { "index": 54, "kind": "parameter", "displayName": "Ant Exclude", "group": "filter", "label": "consumer,filter", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Ant style filter exclusion. If both antInclude and antExclude are used, antExclude takes precedence over antInclude. Multiple exclusions may be specified in comma-delimited format." },
+ "antFilterCaseSensitive": { "index": 55, "kind": "parameter", "displayName": "Ant Filter Case Sensitive", "group": "filter", "label": "consumer,filter", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Sets case sensitive flag on ant filter." },
+ "antInclude": { "index": 56, "kind": "parameter", "displayName": "Ant Include", "group": "filter", "label": "consumer,filter", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Ant style filter inclusion. Multiple inclusions may be specified in comma-delimited format." },
+ "eagerMaxMessagesPerPoll": { "index": 57, "kind": "parameter", "displayName": "Eager Max Messages Per Poll", "group": "filter", "label": "consumer,filter", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "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, [...]
+ "exclude": { "index": 58, "kind": "parameter", "displayName": "Exclude", "group": "filter", "label": "consumer,filter", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Is used to exclude 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 th [...]
+ "excludeExt": { "index": 59, "kind": "parameter", "displayName": "Exclude Ext", "group": "filter", "label": "consumer,filter", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Is used to exclude files matching file extension name (case insensitive). For example to exclude bak files, then use excludeExt=bak. Multiple extensions can be separated by comma, for example to exclude bak and dat fil [...]
+ "filter": { "index": 60, "kind": "parameter", "displayName": "Filter", "group": "filter", "label": "consumer,filter", "required": false, "type": "object", "javaType": "org.apache.camel.component.file.GenericFileFilter<com.azure.storage.file.share.models.ShareFileItem>", "deprecated": false, "autowired": false, "secret": false, "description": "Pluggable filter as a org.apache.camel.component.file.GenericFileFilter class. Will skip files if filter returns false in its accept() method." },
+ "filterDirectory": { "index": 61, "kind": "parameter", "displayName": "Filter Directory", "group": "filter", "label": "consumer,filter", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "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}" },
+ "filterFile": { "index": 62, "kind": "parameter", "displayName": "Filter File", "group": "filter", "label": "consumer,filter", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Filters the file based on Simple language. For example to filter on file size, you can use ${file:size} 5000" },
+ "idempotent": { "index": 63, "kind": "parameter", "displayName": "Idempotent", "group": "filter", "label": "consumer,filter", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "false", "description": "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 w [...]
+ "idempotentKey": { "index": 64, "kind": "parameter", "displayName": "Idempotent Key", "group": "filter", "label": "consumer,filter", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "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}" },
+ "idempotentRepository": { "index": 65, "kind": "parameter", "displayName": "Idempotent Repository", "group": "filter", "label": "consumer,filter", "required": false, "type": "object", "javaType": "org.apache.camel.spi.IdempotentRepository", "deprecated": false, "autowired": false, "secret": false, "description": "A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryIdempotentRepository if none is specified and idempotent is true." },
+ "include": { "index": 66, "kind": "parameter", "displayName": "Include", "group": "filter", "label": "consumer,filter", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "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 th [...]
+ "includeExt": { "index": 67, "kind": "parameter", "displayName": "Include Ext", "group": "filter", "label": "consumer,filter", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Is used to include files matching file extension name (case insensitive). For example to include txt files, then use includeExt=txt. Multiple extensions can be separated by comma, for example to include txt and xml fil [...]
+ "maxDepth": { "index": 68, "kind": "parameter", "displayName": "Max Depth", "group": "filter", "label": "consumer,filter", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 2147483647, "description": "The maximum depth to traverse when recursively processing a directory." },
+ "maxMessagesPerPoll": { "index": 69, "kind": "parameter", "displayName": "Max Messages Per Poll", "group": "filter", "label": "consumer,filter", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "description": "To define a maximum messages to gather per poll. By default no maximum is set. Can be used to set a limit of e.g. 1000 to avoid when starting up the server that there are thousands of files. Set a value of 0 or n [...]
+ "minDepth": { "index": 70, "kind": "parameter", "displayName": "Min Depth", "group": "filter", "label": "consumer,filter", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "description": "The minimum depth to start processing when recursively processing a directory. Using minDepth=1 means the base directory. Using minDepth=2 means the first sub directory." },
+ "move": { "index": 71, "kind": "parameter", "displayName": "Move", "group": "filter", "label": "consumer,filter", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Expression (such as Simple Language) used to dynamically set the filename when moving it after processing. To move files into a .done subdirectory just enter .done." },
+ "exclusiveReadLockStrategy": { "index": 72, "kind": "parameter", "displayName": "Exclusive Read Lock Strategy", "group": "lock", "label": "consumer,lock", "required": false, "type": "object", "javaType": "org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy<com.azure.storage.file.share.models.ShareFileItem>", "deprecated": false, "autowired": false, "secret": false, "description": "Pluggable read-lock as a org.apache.camel.component.file.GenericFileExclusiveReadLockSt [...]
+ "readLock": { "index": 73, "kind": "parameter", "displayName": "Read Lock", "group": "lock", "label": "consumer,lock", "required": false, "type": "string", "javaType": "java.lang.String", "enum": [ "none", "markerFile", "fileLock", "rename", "changed", "idempotent", "idempotent-changed", "idempotent-rename" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "none", "description": "Used by consumer, to only poll the files if it has exclusive read-lock on the [...]
+ "readLockCheckInterval": { "index": 74, "kind": "parameter", "displayName": "Read Lock Check Interval", "group": "lock", "label": "consumer,lock", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 1000, "description": "Interval in millis for the read-lock, if supported by the read lock. This interval is used for sleeping between attempts to acquire the read lock. For example when using the changed read [...]
+ "readLockDeleteOrphanLockFiles": { "index": 75, "kind": "parameter", "displayName": "Read Lock Delete Orphan Lock Files", "group": "lock", "label": "consumer,lock", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether or not read lock with marker files should upon startup delete any orphan read lock files, which may have been left on the file system, if Camel was not proper [...]
+ "readLockLoggingLevel": { "index": 76, "kind": "parameter", "displayName": "Read Lock Logging Level", "group": "lock", "label": "consumer,lock", "required": false, "type": "object", "javaType": "org.apache.camel.LoggingLevel", "enum": [ "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "OFF" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "DEBUG", "description": "Logging level used when a read lock could not be acquired. By default a DEBUG is logged. You can cha [...]
+ "readLockMarkerFile": { "index": 77, "kind": "parameter", "displayName": "Read Lock Marker File", "group": "lock", "label": "consumer,lock", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether to use marker file with the changed, rename, or exclusive read lock types. By default a marker file is used as well to guard against other processes picking up the same files. This b [...]
+ "readLockMinAge": { "index": 78, "kind": "parameter", "displayName": "Read Lock Min Age", "group": "lock", "label": "consumer,lock", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 0, "description": "This option is applied only for readLock=changed. It allows to specify a minimum age the file must be before attempting to acquire the read lock. For example use readLockMinAge=300s to require the file is [...]
+ "readLockMinLength": { "index": 79, "kind": "parameter", "displayName": "Read Lock Min Length", "group": "lock", "label": "consumer,lock", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 1, "description": "This option is applied only for readLock=changed. It allows you to configure a minimum file length. By default Camel expects the file to contain data, and thus the default value is 1. You can set th [...]
+ "readLockRemoveOnCommit": { "index": 80, "kind": "parameter", "displayName": "Read Lock Remove On Commit", "group": "lock", "label": "consumer,lock", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "This option is applied only for readLock=idempotent. It allows to specify whether to remove the file name entry from the idempotent repository when processing the file is succeeded [...]
+ "readLockRemoveOnRollback": { "index": 81, "kind": "parameter", "displayName": "Read Lock Remove On Rollback", "group": "lock", "label": "consumer,lock", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "This option is applied only for readLock=idempotent. It allows to specify whether to remove the file name entry from the idempotent repository when processing the file failed an [...]
+ "readLockTimeout": { "index": 82, "kind": "parameter", "displayName": "Read Lock Timeout", "group": "lock", "label": "consumer,lock", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 10000, "description": "Optional timeout in millis for the read-lock, if supported by the read-lock. If the read-lock could not be granted and the timeout triggered, then Camel will skip the file. At next poll Camel, will t [...]
+ "backoffErrorThreshold": { "index": 83, "kind": "parameter", "displayName": "Backoff Error Threshold", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "description": "The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in." },
+ "backoffIdleThreshold": { "index": 84, "kind": "parameter", "displayName": "Backoff Idle Threshold", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "description": "The number of subsequent idle polls that should happen before the backoffMultipler should kick-in." },
+ "backoffMultiplier": { "index": 85, "kind": "parameter", "displayName": "Backoff Multiplier", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "description": "To let the scheduled polling consumer backoff if there has been a number of subsequent idles\/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is h [...]
+ "delay": { "index": 86, "kind": "parameter", "displayName": "Delay", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 500, "description": "Milliseconds before the next poll." },
+ "greedy": { "index": 87, "kind": "parameter", "displayName": "Greedy", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages." },
+ "initialDelay": { "index": 88, "kind": "parameter", "displayName": "Initial Delay", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 1000, "description": "Milliseconds before the first poll starts." },
+ "repeatCount": { "index": 89, "kind": "parameter", "displayName": "Repeat Count", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 0, "description": "Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever." },
+ "runLoggingLevel": { "index": 90, "kind": "parameter", "displayName": "Run Logging Level", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "org.apache.camel.LoggingLevel", "enum": [ "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "OFF" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "TRACE", "description": "The consumer logs a start\/complete log line when it polls. This option allows you to configure the l [...]
+ "scheduledExecutorService": { "index": 91, "kind": "parameter", "displayName": "Scheduled Executor Service", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "java.util.concurrent.ScheduledExecutorService", "deprecated": false, "autowired": false, "secret": false, "description": "Allows for configuring a custom\/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool." },
+ "scheduler": { "index": 92, "kind": "parameter", "displayName": "Scheduler", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "java.lang.Object", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "none", "description": "To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler" },
+ "schedulerProperties": { "index": 93, "kind": "parameter", "displayName": "Scheduler Properties", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "java.util.Map<java.lang.String, java.lang.Object>", "prefix": "scheduler.", "multiValue": true, "deprecated": false, "autowired": false, "secret": false, "description": "To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler." },
+ "startScheduler": { "index": 94, "kind": "parameter", "displayName": "Start Scheduler", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether the scheduler should be auto started." },
+ "timeUnit": { "index": 95, "kind": "parameter", "displayName": "Time Unit", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "java.util.concurrent.TimeUnit", "enum": [ "NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "MILLISECONDS", "description": "Time unit for initialDelay and delay options." },
+ "useFixedDelay": { "index": 96, "kind": "parameter", "displayName": "Use Fixed Delay", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details." },
+ "shuffle": { "index": 97, "kind": "parameter", "displayName": "Shuffle", "group": "sort", "label": "consumer,sort", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "To shuffle the list of files (sort in random order)" },
+ "sortBy": { "index": 98, "kind": "parameter", "displayName": "Sort By", "group": "sort", "label": "consumer,sort", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Built-in sort by using the File Language. Supports nested sorts, so you can have a sort by file name and as a 2nd group sort by modified date." },
+ "sorter": { "index": 99, "kind": "parameter", "displayName": "Sorter", "group": "sort", "label": "consumer,sort", "required": false, "type": "object", "javaType": "java.util.Comparator<org.apache.camel.component.file.GenericFile<com.azure.storage.file.share.models.ShareFileItem>>", "deprecated": false, "autowired": false, "secret": false, "description": "Pluggable sorter as a java.util.Comparator class." }
}
}
diff --git a/components/camel-azure/camel-azure-files/src/main/docs/azure-files-component.adoc b/components/camel-azure/camel-azure-files/src/main/docs/azure-files-component.adoc
index ea446bd8f08..0d070851379 100644
--- a/components/camel-azure/camel-azure-files/src/main/docs/azure-files-component.adoc
+++ b/components/camel-azure/camel-azure-files/src/main/docs/azure-files-component.adoc
@@ -2,9 +2,10 @@
:doctitle: Azure Files
:shortname: azure-files
:artifactid: camel-azure-files
-:description: Camel Azure Files Component (Preview)
+:description: Camel Azure Files Component
:since: 3.21
-:supportlevel: Preview
+:supportlevel: Stable
+:tabs-sync-option:
:component-header: Both producer and consumer are supported
//Manually maintained attributes
:camel-spring-boot-name: azure-files
diff --git a/components/camel-azure/camel-azure-files/src/main/java/org/apache/camel/component/file/azure/FilesEndpoint.java b/components/camel-azure/camel-azure-files/src/main/java/org/apache/camel/component/file/azure/FilesEndpoint.java
index 53dedf411c9..9867eb8f75c 100644
--- a/components/camel-azure/camel-azure-files/src/main/java/org/apache/camel/component/file/azure/FilesEndpoint.java
+++ b/components/camel-azure/camel-azure-files/src/main/java/org/apache/camel/component/file/azure/FilesEndpoint.java
@@ -50,7 +50,7 @@ import org.apache.camel.util.ObjectHelper;
public class FilesEndpoint extends RemoteFileEndpoint<ShareFileItem> {
// without hiding configuration field from type GenericFileEndpoint<ShareFileItem>
- // camel-package-maven-plugin: Missing @UriPath on endpoint
+ // camel-package-maven-plugin: Missing @UriPath on endpoint
@UriParam
protected FilesConfiguration configuration;
diff --git a/components/camel-azure/camel-azure-files/src/main/java/org/apache/camel/component/file/azure/FilesPath.java b/components/camel-azure/camel-azure-files/src/main/java/org/apache/camel/component/file/azure/FilesPath.java
index 9cd32b1e309..141e95a07de 100644
--- a/components/camel-azure/camel-azure-files/src/main/java/org/apache/camel/component/file/azure/FilesPath.java
+++ b/components/camel-azure/camel-azure-files/src/main/java/org/apache/camel/component/file/azure/FilesPath.java
@@ -1,3 +1,19 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
package org.apache.camel.component.file.azure;
/**
diff --git a/components/camel-azure/camel-azure-files/src/main/java/org/apache/camel/component/file/azure/FilesProducer.java b/components/camel-azure/camel-azure-files/src/main/java/org/apache/camel/component/file/azure/FilesProducer.java
index d1d3b507454..e529300e030 100644
--- a/components/camel-azure/camel-azure-files/src/main/java/org/apache/camel/component/file/azure/FilesProducer.java
+++ b/components/camel-azure/camel-azure-files/src/main/java/org/apache/camel/component/file/azure/FilesProducer.java
@@ -1,3 +1,19 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
package org.apache.camel.component.file.azure;
import com.azure.storage.file.share.models.ShareFileItem;
diff --git a/components/camel-azure/camel-azure-files/src/main/java/org/apache/camel/component/file/azure/FilesToken.java b/components/camel-azure/camel-azure-files/src/main/java/org/apache/camel/component/file/azure/FilesToken.java
index 23627708933..bfcd61ae89c 100644
--- a/components/camel-azure/camel-azure-files/src/main/java/org/apache/camel/component/file/azure/FilesToken.java
+++ b/components/camel-azure/camel-azure-files/src/main/java/org/apache/camel/component/file/azure/FilesToken.java
@@ -1,3 +1,19 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
package org.apache.camel.component.file.azure;
import java.net.URISyntaxException;
@@ -12,7 +28,7 @@ import org.apache.camel.spi.UriParams;
* Azure Files account or service SAS token.
* <p>
* The user delegation SAS token is not specified for Azure Files.
- *
+ *
* @see com.azure.storage.common.implementation.Constants.UrlConstants
* @see <a href="https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas">Azure account SAS</a>
* @see <a href="https://learn.microsoft.com/en-us/rest/api/storageservices/create-service-sas">Azure service SAS</a>
diff --git a/components/camel-azure/camel-azure-files/src/main/java/org/apache/camel/component/file/azure/FilesURIStrings.java b/components/camel-azure/camel-azure-files/src/main/java/org/apache/camel/component/file/azure/FilesURIStrings.java
index aeab897e143..5a3268e70fb 100644
--- a/components/camel-azure/camel-azure-files/src/main/java/org/apache/camel/component/file/azure/FilesURIStrings.java
+++ b/components/camel-azure/camel-azure-files/src/main/java/org/apache/camel/component/file/azure/FilesURIStrings.java
@@ -1,3 +1,19 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
package org.apache.camel.component.file.azure;
import java.net.URI;
diff --git a/components/camel-azure/camel-azure-files/src/main/java/org/apache/camel/component/file/azure/NormalizedOperations.java b/components/camel-azure/camel-azure-files/src/main/java/org/apache/camel/component/file/azure/NormalizedOperations.java
index 156bea13e91..05b6cbbe24c 100644
--- a/components/camel-azure/camel-azure-files/src/main/java/org/apache/camel/component/file/azure/NormalizedOperations.java
+++ b/components/camel-azure/camel-azure-files/src/main/java/org/apache/camel/component/file/azure/NormalizedOperations.java
@@ -1,3 +1,19 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
package org.apache.camel.component.file.azure;
import com.azure.storage.file.share.models.ShareFileItem;
diff --git a/components/camel-azure/camel-azure-files/src/test/java/org/apache/camel/component/file/azure/FilesConfigurationTests.java b/components/camel-azure/camel-azure-files/src/test/java/org/apache/camel/component/file/azure/FilesConfigurationTests.java
index 98fd801c7ba..5b2e47d3a07 100644
--- a/components/camel-azure/camel-azure-files/src/test/java/org/apache/camel/component/file/azure/FilesConfigurationTests.java
+++ b/components/camel-azure/camel-azure-files/src/test/java/org/apache/camel/component/file/azure/FilesConfigurationTests.java
@@ -1,3 +1,19 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
package org.apache.camel.component.file.azure;
import org.apache.camel.test.junit5.CamelTestSupport;
diff --git a/components/camel-azure/camel-azure-files/src/test/java/org/apache/camel/component/file/azure/FilesEndpointTests.java b/components/camel-azure/camel-azure-files/src/test/java/org/apache/camel/component/file/azure/FilesEndpointTests.java
index 46d1bae7516..c9aefe75e3e 100644
--- a/components/camel-azure/camel-azure-files/src/test/java/org/apache/camel/component/file/azure/FilesEndpointTests.java
+++ b/components/camel-azure/camel-azure-files/src/test/java/org/apache/camel/component/file/azure/FilesEndpointTests.java
@@ -1,3 +1,19 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
package org.apache.camel.component.file.azure;
import org.apache.camel.test.junit5.CamelTestSupport;
@@ -15,7 +31,7 @@ public class FilesEndpointTests extends CamelTestSupport {
// by observation Camel decoded sig=gj UKSiCWSHmcubvGhyJhatkP8hkbXkrmV Zme CxI=
// using URISupport sig=gj+UKSiCWSHmcubvGhyJhatkP8hkbXkrmV++Zme+CxI=
// leads to "Signature size is invalid" response from server
- // likely need to post-process replacing + by %2B
+ // likely need to post-process replacing + by %2B
// Camel also sorted params before calling setters
var endpoint = context.getEndpoint(
"azure-files://account/share?" + plainToken, FilesEndpoint.class);
diff --git a/components/camel-azure/camel-azure-files/src/test/java/org/apache/camel/component/file/azure/FilesPathTests.java b/components/camel-azure/camel-azure-files/src/test/java/org/apache/camel/component/file/azure/FilesPathTests.java
index a063652604b..4932d2be1b0 100644
--- a/components/camel-azure/camel-azure-files/src/test/java/org/apache/camel/component/file/azure/FilesPathTests.java
+++ b/components/camel-azure/camel-azure-files/src/test/java/org/apache/camel/component/file/azure/FilesPathTests.java
@@ -1,3 +1,19 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
package org.apache.camel.component.file.azure;
import org.junit.jupiter.api.Test;
diff --git a/components/camel-azure/camel-azure-files/src/test/java/org/apache/camel/component/file/azure/FilesURIStringsTests.java b/components/camel-azure/camel-azure-files/src/test/java/org/apache/camel/component/file/azure/FilesURIStringsTests.java
index bb7e7c0c940..7e77baeede5 100644
--- a/components/camel-azure/camel-azure-files/src/test/java/org/apache/camel/component/file/azure/FilesURIStringsTests.java
+++ b/components/camel-azure/camel-azure-files/src/test/java/org/apache/camel/component/file/azure/FilesURIStringsTests.java
@@ -1,3 +1,19 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
package org.apache.camel.component.file.azure;
import org.junit.jupiter.api.Test;
diff --git a/core/camel-main/src/generated/resources/org/apache/camel/main/components.properties b/core/camel-main/src/generated/resources/org/apache/camel/main/components.properties
index faac2add28a..b9d1583d995 100644
--- a/core/camel-main/src/generated/resources/org/apache/camel/main/components.properties
+++ b/core/camel-main/src/generated/resources/org/apache/camel/main/components.properties
@@ -32,6 +32,7 @@ aws2-sts
aws2-translate
azure-cosmosdb
azure-eventhubs
+azure-files
azure-key-vault
azure-servicebus
azure-storage-blob
diff --git a/core/camel-support/src/main/java/org/apache/camel/converter/stream/InputStreamCache.java b/core/camel-support/src/main/java/org/apache/camel/converter/stream/InputStreamCache.java
index 112a8070763..4831e1adee4 100644
--- a/core/camel-support/src/main/java/org/apache/camel/converter/stream/InputStreamCache.java
+++ b/core/camel-support/src/main/java/org/apache/camel/converter/stream/InputStreamCache.java
@@ -26,10 +26,9 @@ import org.apache.camel.StreamCache;
/**
* A {@link StreamCache} for caching using an in-memory byte array.
* <p/>
- * <b>Important:</b>
- * All the classes from the Camel release that implements {@link StreamCache} is NOT intended for end users
- * to create as instances, but they are part of
- * Camels <a href="https://camel.apache.org/manual/stream-caching.html">stream-caching</a> functionality.
+ * <b>Important:</b> All the classes from the Camel release that implements {@link StreamCache} is NOT intended for end
+ * users to create as instances, but they are part of Camels
+ * <a href="https://camel.apache.org/manual/stream-caching.html">stream-caching</a> functionality.
*/
public final class InputStreamCache extends ByteArrayInputStream implements StreamCache {
diff --git a/docs/components/modules/ROOT/examples/json/azure-files.json b/docs/components/modules/ROOT/examples/json/azure-files.json
new file mode 120000
index 00000000000..4385b78b958
--- /dev/null
+++ b/docs/components/modules/ROOT/examples/json/azure-files.json
@@ -0,0 +1 @@
+../../../../../../components/camel-azure/camel-azure-files/src/generated/resources/org/apache/camel/component/file/azure/azure-files.json
\ No newline at end of file
diff --git a/docs/components/modules/ROOT/nav.adoc b/docs/components/modules/ROOT/nav.adoc
index 0e5d47bbddc..648517804e5 100644
--- a/docs/components/modules/ROOT/nav.adoc
+++ b/docs/components/modules/ROOT/nav.adoc
@@ -43,6 +43,7 @@
*** xref:azure-storage-blob-component.adoc[Azure Storage Blob Service]
*** xref:azure-storage-datalake-component.adoc[Azure Storage Datalake Service]
*** xref:azure-storage-queue-component.adoc[Azure Storage Queue Service]
+** xref:azure-files-component.adoc[Azure Files]
** xref:bean-component.adoc[Bean]
** xref:bean-validator-component.adoc[Bean Validator]
** xref:bonita-component.adoc[Bonita]
diff --git a/docs/components/modules/ROOT/pages/azure-files-component.adoc b/docs/components/modules/ROOT/pages/azure-files-component.adoc
new file mode 120000
index 00000000000..d20b2ac0a8c
--- /dev/null
+++ b/docs/components/modules/ROOT/pages/azure-files-component.adoc
@@ -0,0 +1 @@
+../../../../../components/camel-azure/camel-azure-files/src/main/docs/azure-files-component.adoc
\ No newline at end of file
diff --git a/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/ComponentsBuilderFactory.java b/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/ComponentsBuilderFactory.java
index d97545fc0ae..7863ddf7e2d 100644
--- a/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/ComponentsBuilderFactory.java
+++ b/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/ComponentsBuilderFactory.java
@@ -494,6 +494,19 @@ public interface ComponentsBuilderFactory {
static org.apache.camel.builder.component.dsl.AzureEventhubsComponentBuilderFactory.AzureEventhubsComponentBuilder azureEventhubs() {
return org.apache.camel.builder.component.dsl.AzureEventhubsComponentBuilderFactory.azureEventhubs();
}
+ /**
+ * Azure Files (camel-azure-files)
+ * Camel Azure Files Component
+ *
+ * Category: cloud,file
+ * Since: 3.21
+ * Maven coordinates: org.apache.camel:camel-azure-files
+ *
+ * @return the dsl builder
+ */
+ static org.apache.camel.builder.component.dsl.AzureFilesComponentBuilderFactory.AzureFilesComponentBuilder azureFiles() {
+ return org.apache.camel.builder.component.dsl.AzureFilesComponentBuilderFactory.azureFiles();
+ }
/**
* Azure Key Vault (camel-azure-key-vault)
* Manage secrets and keys in Azure Key Vault Service
diff --git a/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/AzureFilesComponentBuilderFactory.java b/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/AzureFilesComponentBuilderFactory.java
new file mode 100644
index 00000000000..28ea303b260
--- /dev/null
+++ b/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/AzureFilesComponentBuilderFactory.java
@@ -0,0 +1,144 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.camel.builder.component.dsl;
+
+import javax.annotation.processing.Generated;
+import org.apache.camel.Component;
+import org.apache.camel.builder.component.AbstractComponentBuilder;
+import org.apache.camel.builder.component.ComponentBuilder;
+import org.apache.camel.component.file.azure.FilesComponent;
+
+/**
+ * Camel Azure Files Component
+ *
+ * Generated by camel-package-maven-plugin - do not edit this file!
+ */
+@Generated("org.apache.camel.maven.packaging.ComponentDslMojo")
+public interface AzureFilesComponentBuilderFactory {
+
+ /**
+ * Azure Files (camel-azure-files)
+ * Camel Azure Files Component
+ *
+ * Category: cloud,file
+ * Since: 3.21
+ * Maven coordinates: org.apache.camel:camel-azure-files
+ *
+ * @return the dsl builder
+ */
+ static AzureFilesComponentBuilder azureFiles() {
+ return new AzureFilesComponentBuilderImpl();
+ }
+
+ /**
+ * Builder for the Azure Files component.
+ */
+ interface AzureFilesComponentBuilder
+ extends
+ ComponentBuilder<FilesComponent> {
+ /**
+ * 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.
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: false
+ * Group: consumer
+ *
+ * @param bridgeErrorHandler the value to set
+ * @return the dsl builder
+ */
+ default AzureFilesComponentBuilder bridgeErrorHandler(
+ boolean bridgeErrorHandler) {
+ doSetProperty("bridgeErrorHandler", bridgeErrorHandler);
+ return this;
+ }
+ /**
+ * 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 starting the
+ * producer may take a little time and prolong the total processing time
+ * of the processing.
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: false
+ * Group: producer
+ *
+ * @param lazyStartProducer the value to set
+ * @return the dsl builder
+ */
+ default AzureFilesComponentBuilder lazyStartProducer(
+ boolean lazyStartProducer) {
+ doSetProperty("lazyStartProducer", lazyStartProducer);
+ return this;
+ }
+ /**
+ * Whether autowiring is enabled. This is used for automatic autowiring
+ * options (the option must be marked as autowired) by looking up in the
+ * registry to find if there is a single instance of matching type,
+ * which then gets configured on the component. This can be used for
+ * automatic configuring JDBC data sources, JMS connection factories,
+ * AWS Clients, etc.
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: true
+ * Group: advanced
+ *
+ * @param autowiredEnabled the value to set
+ * @return the dsl builder
+ */
+ default AzureFilesComponentBuilder autowiredEnabled(
+ boolean autowiredEnabled) {
+ doSetProperty("autowiredEnabled", autowiredEnabled);
+ return this;
+ }
+ }
+
+ class AzureFilesComponentBuilderImpl
+ extends
+ AbstractComponentBuilder<FilesComponent>
+ implements
+ AzureFilesComponentBuilder {
+ @Override
+ protected FilesComponent buildConcreteComponent() {
+ return new FilesComponent();
+ }
+ @Override
+ protected boolean setPropertyOnComponent(
+ Component component,
+ String name,
+ Object value) {
+ switch (name) {
+ case "bridgeErrorHandler": ((FilesComponent) component).setBridgeErrorHandler((boolean) value); return true;
+ case "lazyStartProducer": ((FilesComponent) component).setLazyStartProducer((boolean) value); return true;
+ case "autowiredEnabled": ((FilesComponent) component).setAutowiredEnabled((boolean) value); return true;
+ default: return false;
+ }
+ }
+ }
+}
\ No newline at end of file
diff --git a/dsl/camel-componentdsl/src/generated/resources/metadata.json b/dsl/camel-componentdsl/src/generated/resources/metadata.json
index 67b17e1fa89..e0e3b95fb8c 100644
--- a/dsl/camel-componentdsl/src/generated/resources/metadata.json
+++ b/dsl/camel-componentdsl/src/generated/resources/metadata.json
@@ -750,6 +750,29 @@
"producerOnly": false,
"lenientProperties": false
},
+ "AzureFilesComponentBuilderFactory": {
+ "kind": "component",
+ "name": "azure-files",
+ "title": "Azure Files",
+ "description": "Camel Azure Files Component",
+ "deprecated": false,
+ "deprecationNote": "",
+ "firstVersion": "3.21.0",
+ "label": "cloud,file",
+ "javaType": "org.apache.camel.component.file.azure.FilesComponent",
+ "supportLevel": "Stable",
+ "groupId": "org.apache.camel",
+ "artifactId": "camel-azure-files",
+ "version": "4.0.0-SNAPSHOT",
+ "scheme": "azure-files",
+ "extendsScheme": "file",
+ "syntax": "azure-files:\/\/account[.host]\/share[\/dir]",
+ "async": false,
+ "api": false,
+ "consumerOnly": false,
+ "producerOnly": false,
+ "lenientProperties": false
+ },
"AzureKeyVaultComponentBuilderFactory": {
"kind": "component",
"name": "azure-key-vault",
diff --git a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/EndpointBuilderFactory.java b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/EndpointBuilderFactory.java
index 7cdc76e76fa..9c9c1c60303 100644
--- a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/EndpointBuilderFactory.java
+++ b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/EndpointBuilderFactory.java
@@ -107,6 +107,7 @@ public interface EndpointBuilderFactory
org.apache.camel.builder.endpoint.dsl.FhirEndpointBuilderFactory.FhirBuilders,
org.apache.camel.builder.endpoint.dsl.FileEndpointBuilderFactory.FileBuilders,
org.apache.camel.builder.endpoint.dsl.FileWatchEndpointBuilderFactory.FileWatchBuilders,
+ org.apache.camel.builder.endpoint.dsl.FilesEndpointBuilderFactory.FilesBuilders,
org.apache.camel.builder.endpoint.dsl.FlatpackEndpointBuilderFactory.FlatpackBuilders,
org.apache.camel.builder.endpoint.dsl.FlinkEndpointBuilderFactory.FlinkBuilders,
org.apache.camel.builder.endpoint.dsl.FopEndpointBuilderFactory.FopBuilders,
diff --git a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/EndpointBuilders.java b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/EndpointBuilders.java
index 77e3454252c..67f73172ea7 100644
--- a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/EndpointBuilders.java
+++ b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/EndpointBuilders.java
@@ -104,6 +104,7 @@ public interface EndpointBuilders
org.apache.camel.builder.endpoint.dsl.FhirEndpointBuilderFactory,
org.apache.camel.builder.endpoint.dsl.FileEndpointBuilderFactory,
org.apache.camel.builder.endpoint.dsl.FileWatchEndpointBuilderFactory,
+ org.apache.camel.builder.endpoint.dsl.FilesEndpointBuilderFactory,
org.apache.camel.builder.endpoint.dsl.FlatpackEndpointBuilderFactory,
org.apache.camel.builder.endpoint.dsl.FlinkEndpointBuilderFactory,
org.apache.camel.builder.endpoint.dsl.FopEndpointBuilderFactory,
diff --git a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/StaticEndpointBuilders.java b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/StaticEndpointBuilders.java
index a17bd194553..f5ca1e1cce2 100644
--- a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/StaticEndpointBuilders.java
+++ b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/StaticEndpointBuilders.java
@@ -1584,6 +1584,61 @@ public class StaticEndpointBuilders {
String path) {
return org.apache.camel.builder.endpoint.dsl.EventHubsEndpointBuilderFactory.endpointBuilder(componentName, path);
}
+ /**
+ * Azure Files (camel-azure-files)
+ * Camel Azure Files Component
+ *
+ * Category: cloud,file
+ * Since: 3.21
+ * Maven coordinates: org.apache.camel:camel-azure-files
+ *
+ * Syntax: <code>azure-files://account[.host]/share[/dir]</code>
+ *
+ * Path parameter: host (required)
+ * Hostname of the FTP server
+ *
+ * Path parameter: port
+ * Port of the FTP server
+ *
+ * Path parameter: directoryName
+ * The starting directory
+ *
+ * @param path //account[.host]/share[/dir]
+ * @return the dsl builder
+ */
+ public static org.apache.camel.builder.endpoint.dsl.FilesEndpointBuilderFactory.FilesEndpointBuilder azureFiles(
+ String path) {
+ return org.apache.camel.builder.endpoint.dsl.FilesEndpointBuilderFactory.endpointBuilder("azure-files", path);
+ }
+ /**
+ * Azure Files (camel-azure-files)
+ * Camel Azure Files Component
+ *
+ * Category: cloud,file
+ * Since: 3.21
+ * Maven coordinates: org.apache.camel:camel-azure-files
+ *
+ * Syntax: <code>azure-files://account[.host]/share[/dir]</code>
+ *
+ * Path parameter: host (required)
+ * Hostname of the FTP server
+ *
+ * Path parameter: port
+ * Port of the FTP server
+ *
+ * Path parameter: directoryName
+ * The starting directory
+ *
+ * @param componentName to use a custom component name for the endpoint
+ * instead of the default name
+ * @param path //account[.host]/share[/dir]
+ * @return the dsl builder
+ */
+ public static org.apache.camel.builder.endpoint.dsl.FilesEndpointBuilderFactory.FilesEndpointBuilder azureFiles(
+ String componentName,
+ String path) {
+ return org.apache.camel.builder.endpoint.dsl.FilesEndpointBuilderFactory.endpointBuilder(componentName, path);
+ }
/**
* Azure Key Vault (camel-azure-key-vault)
* Manage secrets and keys in Azure Key Vault Service
diff --git a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/FilesEndpointBuilderFactory.java b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/FilesEndpointBuilderFactory.java
new file mode 100644
index 00000000000..af9619e4c90
--- /dev/null
+++ b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/FilesEndpointBuilderFactory.java
@@ -0,0 +1,4335 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.camel.builder.endpoint.dsl;
+
+import java.util.*;
+import java.util.Map;
+import java.util.concurrent.*;
+import java.util.function.*;
+import java.util.stream.*;
+import javax.annotation.processing.Generated;
+import org.apache.camel.builder.EndpointConsumerBuilder;
+import org.apache.camel.builder.EndpointProducerBuilder;
+import org.apache.camel.builder.endpoint.AbstractEndpointBuilder;
+
+/**
+ * Camel Azure Files Component
+ *
+ * Generated by camel build tools - do NOT edit this file!
+ */
+@Generated("org.apache.camel.maven.packaging.EndpointDslMojo")
+public interface FilesEndpointBuilderFactory {
+
+
+ /**
+ * Builder for endpoint consumers for the Azure Files component.
+ */
+ public interface FilesEndpointConsumerBuilder
+ extends
+ EndpointConsumerBuilder {
+ default AdvancedFilesEndpointConsumerBuilder advanced() {
+ return (AdvancedFilesEndpointConsumerBuilder) this;
+ }
+ /**
+ * 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.
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: false
+ * Group: common
+ *
+ * @param disconnect the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder disconnect(boolean disconnect) {
+ doSetProperty("disconnect", disconnect);
+ return this;
+ }
+ /**
+ * 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.
+ *
+ * The option will be converted to a <code>boolean</code>
+ * type.
+ *
+ * Default: false
+ * Group: common
+ *
+ * @param disconnect the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder disconnect(String disconnect) {
+ doSetProperty("disconnect", disconnect);
+ return this;
+ }
+ /**
+ * 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 can specify
+ * a fixed name. Or you can use dynamic placeholders.The done file is
+ * always expected in the same folder as the original file. Only
+ * ${file.name} and ${file.name.next} is supported as dynamic
+ * placeholders.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: common
+ *
+ * @param doneFileName the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder doneFileName(String doneFileName) {
+ doSetProperty("doneFileName", doneFileName);
+ return this;
+ }
+ /**
+ * Use Expression such as File Language to dynamically set the filename.
+ * For consumers, it's used as a filename filter. For producers, it's
+ * used to evaluate the filename to write. If an expression is set, it
+ * take precedence over the CamelFileName header. (Note: The header
+ * itself can also be an Expression). The expression options support
+ * both String and Expression types. If the expression is a String type,
+ * it is always evaluated using the File Language. If the expression is
+ * an Expression type, the specified Expression type is used - this
+ * allows you, for instance, to use OGNL expressions. For the consumer,
+ * you can use it to filter filenames, so you can for instance consume
+ * today's file using the File Language syntax:
+ * mydata-${date:now:yyyyMMdd}.txt. The producers support the
+ * CamelOverruleFileName header which takes precedence over any existing
+ * CamelFileName header; the CamelOverruleFileName is a header that is
+ * used only once, and makes it easier as this avoids to temporary store
+ * CamelFileName and have to restore it afterwards.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: common
+ *
+ * @param fileName the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder fileName(String fileName) {
+ doSetProperty("fileName", fileName);
+ return this;
+ }
+ /**
+ * If true, the file will be deleted after it is processed successfully.
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: false
+ * Group: consumer
+ *
+ * @param delete the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder delete(boolean delete) {
+ doSetProperty("delete", delete);
+ return this;
+ }
+ /**
+ * If true, the file will be deleted after it is processed successfully.
+ *
+ * The option will be converted to a <code>boolean</code>
+ * type.
+ *
+ * Default: false
+ * Group: consumer
+ *
+ * @param delete the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder delete(String delete) {
+ doSetProperty("delete", delete);
+ return this;
+ }
+ /**
+ * 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.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: consumer
+ *
+ * @param moveFailed the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder moveFailed(String moveFailed) {
+ doSetProperty("moveFailed", moveFailed);
+ return this;
+ }
+ /**
+ * If true, the file is not moved or deleted in any way. This option is
+ * good for readonly data, or for ETL type requirements. If noop=true,
+ * Camel will set idempotent=true as well, to avoid consuming the same
+ * files over and over again.
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: false
+ * Group: consumer
+ *
+ * @param noop the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder noop(boolean noop) {
+ doSetProperty("noop", noop);
+ return this;
+ }
+ /**
+ * If true, the file is not moved or deleted in any way. This option is
+ * good for readonly data, or for ETL type requirements. If noop=true,
+ * Camel will set idempotent=true as well, to avoid consuming the same
+ * files over and over again.
+ *
+ * The option will be converted to a <code>boolean</code>
+ * type.
+ *
+ * Default: false
+ * Group: consumer
+ *
+ * @param noop the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder noop(String noop) {
+ doSetProperty("noop", noop);
+ return this;
+ }
+ /**
+ * Expression (such as File Language) used to dynamically set the
+ * filename when moving it before processing. For example to move
+ * in-progress files into the order directory set this value to order.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: consumer
+ *
+ * @param preMove the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder preMove(String preMove) {
+ doSetProperty("preMove", preMove);
+ return this;
+ }
+ /**
+ * When pre-sort is enabled then the consumer will sort the file and
+ * directory names during polling, that was retrieved from the file
+ * system. You may want to do this in case you need to operate on the
+ * files in a sorted order. The pre-sort is executed before the consumer
+ * starts to filter, and accept files to process by Camel. This option
+ * is default=false meaning disabled.
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: false
+ * Group: consumer
+ *
+ * @param preSort the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder preSort(boolean preSort) {
+ doSetProperty("preSort", preSort);
+ return this;
+ }
+ /**
+ * When pre-sort is enabled then the consumer will sort the file and
+ * directory names during polling, that was retrieved from the file
+ * system. You may want to do this in case you need to operate on the
+ * files in a sorted order. The pre-sort is executed before the consumer
+ * starts to filter, and accept files to process by Camel. This option
+ * is default=false meaning disabled.
+ *
+ * The option will be converted to a <code>boolean</code>
+ * type.
+ *
+ * Default: false
+ * Group: consumer
+ *
+ * @param preSort the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder preSort(String preSort) {
+ doSetProperty("preSort", preSort);
+ return this;
+ }
+ /**
+ * If a directory, will look for files in all the sub-directories as
+ * well.
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: false
+ * Group: consumer
+ *
+ * @param recursive the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder recursive(boolean recursive) {
+ doSetProperty("recursive", recursive);
+ return this;
+ }
+ /**
+ * If a directory, will look for files in all the sub-directories as
+ * well.
+ *
+ * The option will be converted to a <code>boolean</code>
+ * type.
+ *
+ * Default: false
+ * Group: consumer
+ *
+ * @param recursive the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder recursive(String recursive) {
+ doSetProperty("recursive", recursive);
+ return this;
+ }
+ /**
+ * Configures whether resume download is enabled. In addition the
+ * options localWorkDirectory must be configured so downloaded files are
+ * stored in a local directory, which is required to support resuming of
+ * downloads.
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: false
+ * Group: consumer
+ *
+ * @param resumeDownload the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder resumeDownload(
+ boolean resumeDownload) {
+ doSetProperty("resumeDownload", resumeDownload);
+ return this;
+ }
+ /**
+ * Configures whether resume download is enabled. In addition the
+ * options localWorkDirectory must be configured so downloaded files are
+ * stored in a local directory, which is required to support resuming of
+ * downloads.
+ *
+ * The option will be converted to a <code>boolean</code>
+ * type.
+ *
+ * Default: false
+ * Group: consumer
+ *
+ * @param resumeDownload the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder resumeDownload(
+ String resumeDownload) {
+ doSetProperty("resumeDownload", resumeDownload);
+ return this;
+ }
+ /**
+ * If the polling consumer did not poll any files, you can enable this
+ * option to send an empty message (no body) instead.
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: false
+ * Group: consumer
+ *
+ * @param sendEmptyMessageWhenIdle the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder sendEmptyMessageWhenIdle(
+ boolean sendEmptyMessageWhenIdle) {
+ doSetProperty("sendEmptyMessageWhenIdle", sendEmptyMessageWhenIdle);
+ return this;
+ }
+ /**
+ * If the polling consumer did not poll any files, you can enable this
+ * option to send an empty message (no body) instead.
+ *
+ * The option will be converted to a <code>boolean</code>
+ * type.
+ *
+ * Default: false
+ * Group: consumer
+ *
+ * @param sendEmptyMessageWhenIdle the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder sendEmptyMessageWhenIdle(
+ String sendEmptyMessageWhenIdle) {
+ doSetProperty("sendEmptyMessageWhenIdle", sendEmptyMessageWhenIdle);
+ return this;
+ }
+ /**
+ * Sets the download method to use when not using a local working
+ * directory. If set to true, the remote files are streamed to the route
+ * as they are read. When set to false, the remote files are loaded into
+ * memory before being sent into the route. If enabling this option then
+ * you must set stepwise=false as both cannot be enabled at the same
+ * time.
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: false
+ * Group: consumer
+ *
+ * @param streamDownload the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder streamDownload(
+ boolean streamDownload) {
+ doSetProperty("streamDownload", streamDownload);
+ return this;
+ }
+ /**
+ * Sets the download method to use when not using a local working
+ * directory. If set to true, the remote files are streamed to the route
+ * as they are read. When set to false, the remote files are loaded into
+ * memory before being sent into the route. If enabling this option then
+ * you must set stepwise=false as both cannot be enabled at the same
+ * time.
+ *
+ * The option will be converted to a <code>boolean</code>
+ * type.
+ *
+ * Default: false
+ * Group: consumer
+ *
+ * @param streamDownload the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder streamDownload(
+ String streamDownload) {
+ doSetProperty("streamDownload", streamDownload);
+ return this;
+ }
+ /**
+ * part of service SAS token.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: both
+ *
+ * @param sdd the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder sdd(String sdd) {
+ doSetProperty("sdd", sdd);
+ return this;
+ }
+ /**
+ * part of SAS token.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: both
+ *
+ * @param se the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder se(String se) {
+ doSetProperty("se", se);
+ return this;
+ }
+ /**
+ * Shared key (storage account key).
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: both
+ *
+ * @param sharedKey the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder sharedKey(String sharedKey) {
+ doSetProperty("sharedKey", sharedKey);
+ return this;
+ }
+ /**
+ * part of service SAS token.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: both
+ *
+ * @param si the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder si(String si) {
+ doSetProperty("si", si);
+ return this;
+ }
+ /**
+ * part of SAS token.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: both
+ *
+ * @param sig the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder sig(String sig) {
+ doSetProperty("sig", sig);
+ return this;
+ }
+ /**
+ * part of SAS token.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: both
+ *
+ * @param sip the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder sip(String sip) {
+ doSetProperty("sip", sip);
+ return this;
+ }
+ /**
+ * part of SAS token.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: both
+ *
+ * @param sp the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder sp(String sp) {
+ doSetProperty("sp", sp);
+ return this;
+ }
+ /**
+ * part of SAS token.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: both
+ *
+ * @param spr the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder spr(String spr) {
+ doSetProperty("spr", spr);
+ return this;
+ }
+ /**
+ * part of service SAS token.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: both
+ *
+ * @param sr the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder sr(String sr) {
+ doSetProperty("sr", sr);
+ return this;
+ }
+ /**
+ * part of SAS token.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: both
+ *
+ * @param srt the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder srt(String srt) {
+ doSetProperty("srt", srt);
+ return this;
+ }
+ /**
+ * part of account SAS token.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: both
+ *
+ * @param ss the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder ss(String ss) {
+ doSetProperty("ss", ss);
+ return this;
+ }
+ /**
+ * part of SAS token.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: both
+ *
+ * @param st the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder st(String st) {
+ doSetProperty("st", st);
+ return this;
+ }
+ /**
+ * part of SAS token.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: both
+ *
+ * @param sv the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder sv(String sv) {
+ doSetProperty("sv", sv);
+ return this;
+ }
+ /**
+ * Ant style filter exclusion. If both antInclude and antExclude are
+ * used, antExclude takes precedence over antInclude. Multiple
+ * exclusions may be specified in comma-delimited format.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: filter
+ *
+ * @param antExclude the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder antExclude(String antExclude) {
+ doSetProperty("antExclude", antExclude);
+ return this;
+ }
+ /**
+ * Sets case sensitive flag on ant filter.
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: true
+ * Group: filter
+ *
+ * @param antFilterCaseSensitive the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder antFilterCaseSensitive(
+ boolean antFilterCaseSensitive) {
+ doSetProperty("antFilterCaseSensitive", antFilterCaseSensitive);
+ return this;
+ }
+ /**
+ * Sets case sensitive flag on ant filter.
+ *
+ * The option will be converted to a <code>boolean</code>
+ * type.
+ *
+ * Default: true
+ * Group: filter
+ *
+ * @param antFilterCaseSensitive the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder antFilterCaseSensitive(
+ String antFilterCaseSensitive) {
+ doSetProperty("antFilterCaseSensitive", antFilterCaseSensitive);
+ return this;
+ }
+ /**
+ * Ant style filter inclusion. Multiple inclusions may be specified in
+ * comma-delimited format.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: filter
+ *
+ * @param antInclude the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder antInclude(String antInclude) {
+ doSetProperty("antInclude", antInclude);
+ return this;
+ }
+ /**
+ * 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.
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: true
+ * Group: filter
+ *
+ * @param eagerMaxMessagesPerPoll the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder eagerMaxMessagesPerPoll(
+ boolean eagerMaxMessagesPerPoll) {
+ doSetProperty("eagerMaxMessagesPerPoll", eagerMaxMessagesPerPoll);
+ return this;
+ }
+ /**
+ * 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.
+ *
+ * The option will be converted to a <code>boolean</code>
+ * type.
+ *
+ * Default: true
+ * Group: filter
+ *
+ * @param eagerMaxMessagesPerPoll the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder eagerMaxMessagesPerPoll(
+ String eagerMaxMessagesPerPoll) {
+ doSetProperty("eagerMaxMessagesPerPoll", eagerMaxMessagesPerPoll);
+ return this;
+ }
+ /**
+ * Is used to exclude 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.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: filter
+ *
+ * @param exclude the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder exclude(String exclude) {
+ doSetProperty("exclude", exclude);
+ return this;
+ }
+ /**
+ * Is used to exclude files matching file extension name (case
+ * insensitive). For example to exclude bak files, then use
+ * excludeExt=bak. Multiple extensions can be separated by comma, for
+ * example to exclude bak and dat files, use excludeExt=bak,dat. Note
+ * that the file extension includes all parts, for example having a file
+ * named mydata.tar.gz will have extension as tar.gz. For more
+ * flexibility then use the include/exclude options.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: filter
+ *
+ * @param excludeExt the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder excludeExt(String excludeExt) {
+ doSetProperty("excludeExt", excludeExt);
+ return this;
+ }
+ /**
+ * Pluggable filter as a
+ * org.apache.camel.component.file.GenericFileFilter class. Will skip
+ * files if filter returns false in its accept() method.
+ *
+ * The option is a:
+ * <code>org.apache.camel.component.file.GenericFileFilter&lt;com.azure.storage.file.share.models.ShareFileItem&gt;</code> type.
+ *
+ * Group: filter
+ *
+ * @param filter the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder filter(
+ org.apache.camel.component.file.GenericFileFilter<com.azure.storage.file.share.models.ShareFileItem> filter) {
+ doSetProperty("filter", filter);
+ return this;
+ }
+ /**
+ * Pluggable filter as a
+ * org.apache.camel.component.file.GenericFileFilter class. Will skip
+ * files if filter returns false in its accept() method.
+ *
+ * The option will be converted to a
+ * <code>org.apache.camel.component.file.GenericFileFilter&lt;com.azure.storage.file.share.models.ShareFileItem&gt;</code> type.
+ *
+ * Group: filter
+ *
+ * @param filter the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder filter(String filter) {
+ doSetProperty("filter", filter);
+ return this;
+ }
+ /**
+ * 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}.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: filter
+ *
+ * @param filterDirectory the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder filterDirectory(
+ String filterDirectory) {
+ doSetProperty("filterDirectory", filterDirectory);
+ return this;
+ }
+ /**
+ * Filters the file based on Simple language. For example to filter on
+ * file size, you can use ${file:size} 5000.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: filter
+ *
+ * @param filterFile the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder filterFile(String filterFile) {
+ doSetProperty("filterFile", filterFile);
+ return this;
+ }
+ /**
+ * 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.
+ *
+ * The option is a: <code>java.lang.Boolean</code> type.
+ *
+ * Default: false
+ * Group: filter
+ *
+ * @param idempotent the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder idempotent(Boolean idempotent) {
+ doSetProperty("idempotent", idempotent);
+ return this;
+ }
+ /**
+ * 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.
+ *
+ * The option will be converted to a
+ * <code>java.lang.Boolean</code> type.
+ *
+ * Default: false
+ * Group: filter
+ *
+ * @param idempotent the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder idempotent(String idempotent) {
+ doSetProperty("idempotent", idempotent);
+ return this;
+ }
+ /**
+ * 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}.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: filter
+ *
+ * @param idempotentKey the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder idempotentKey(String idempotentKey) {
+ doSetProperty("idempotentKey", idempotentKey);
+ return this;
+ }
+ /**
+ * A pluggable repository org.apache.camel.spi.IdempotentRepository
+ * which by default use MemoryIdempotentRepository if none is specified
+ * and idempotent is true.
+ *
+ * The option is a:
+ * <code>org.apache.camel.spi.IdempotentRepository</code>
+ * type.
+ *
+ * Group: filter
+ *
+ * @param idempotentRepository the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder idempotentRepository(
+ org.apache.camel.spi.IdempotentRepository idempotentRepository) {
+ doSetProperty("idempotentRepository", idempotentRepository);
+ return this;
+ }
+ /**
+ * A pluggable repository org.apache.camel.spi.IdempotentRepository
+ * which by default use MemoryIdempotentRepository if none is specified
+ * and idempotent is true.
+ *
+ * The option will be converted to a
+ * <code>org.apache.camel.spi.IdempotentRepository</code>
+ * type.
+ *
+ * Group: filter
+ *
+ * @param idempotentRepository the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder idempotentRepository(
+ String idempotentRepository) {
+ doSetProperty("idempotentRepository", idempotentRepository);
+ return this;
+ }
+ /**
+ * 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.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: filter
+ *
+ * @param include the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder include(String include) {
+ doSetProperty("include", include);
+ return this;
+ }
+ /**
+ * Is used to include files matching file extension name (case
+ * insensitive). For example to include txt files, then use
+ * includeExt=txt. Multiple extensions can be separated by comma, for
+ * example to include txt and xml files, use includeExt=txt,xml. Note
+ * that the file extension includes all parts, for example having a file
+ * named mydata.tar.gz will have extension as tar.gz. For more
+ * flexibility then use the include/exclude options.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: filter
+ *
+ * @param includeExt the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder includeExt(String includeExt) {
+ doSetProperty("includeExt", includeExt);
+ return this;
+ }
+ /**
+ * The maximum depth to traverse when recursively processing a
+ * directory.
+ *
+ * The option is a: <code>int</code> type.
+ *
+ * Default: 2147483647
+ * Group: filter
+ *
+ * @param maxDepth the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder maxDepth(int maxDepth) {
+ doSetProperty("maxDepth", maxDepth);
+ return this;
+ }
+ /**
+ * The maximum depth to traverse when recursively processing a
+ * directory.
+ *
+ * The option will be converted to a <code>int</code> type.
+ *
+ * Default: 2147483647
+ * Group: filter
+ *
+ * @param maxDepth the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder maxDepth(String maxDepth) {
+ doSetProperty("maxDepth", maxDepth);
+ return this;
+ }
+ /**
+ * To define a maximum messages to gather per poll. By default no
+ * maximum is set. Can be used to set a limit of e.g. 1000 to avoid when
+ * starting up the server that there are thousands of files. Set a value
+ * of 0 or negative to disabled it. Notice: If this option is in use
+ * then the File and FTP components will limit before any sorting. For
+ * example if you have 100000 files and use maxMessagesPerPoll=500, then
+ * only the first 500 files will be picked up, and then sorted. You can
+ * use the eagerMaxMessagesPerPoll option and set this to false to allow
+ * to scan all files first and then sort afterwards.
+ *
+ * The option is a: <code>int</code> type.
+ *
+ * Group: filter
+ *
+ * @param maxMessagesPerPoll the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder maxMessagesPerPoll(
+ int maxMessagesPerPoll) {
+ doSetProperty("maxMessagesPerPoll", maxMessagesPerPoll);
+ return this;
+ }
+ /**
+ * To define a maximum messages to gather per poll. By default no
+ * maximum is set. Can be used to set a limit of e.g. 1000 to avoid when
+ * starting up the server that there are thousands of files. Set a value
+ * of 0 or negative to disabled it. Notice: If this option is in use
+ * then the File and FTP components will limit before any sorting. For
+ * example if you have 100000 files and use maxMessagesPerPoll=500, then
+ * only the first 500 files will be picked up, and then sorted. You can
+ * use the eagerMaxMessagesPerPoll option and set this to false to allow
+ * to scan all files first and then sort afterwards.
+ *
+ * The option will be converted to a <code>int</code> type.
+ *
+ * Group: filter
+ *
+ * @param maxMessagesPerPoll the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder maxMessagesPerPoll(
+ String maxMessagesPerPoll) {
+ doSetProperty("maxMessagesPerPoll", maxMessagesPerPoll);
+ return this;
+ }
+ /**
+ * The minimum depth to start processing when recursively processing a
+ * directory. Using minDepth=1 means the base directory. Using
+ * minDepth=2 means the first sub directory.
+ *
+ * The option is a: <code>int</code> type.
+ *
+ * Group: filter
+ *
+ * @param minDepth the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder minDepth(int minDepth) {
+ doSetProperty("minDepth", minDepth);
+ return this;
+ }
+ /**
+ * The minimum depth to start processing when recursively processing a
+ * directory. Using minDepth=1 means the base directory. Using
+ * minDepth=2 means the first sub directory.
+ *
+ * The option will be converted to a <code>int</code> type.
+ *
+ * Group: filter
+ *
+ * @param minDepth the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder minDepth(String minDepth) {
+ doSetProperty("minDepth", minDepth);
+ return this;
+ }
+ /**
+ * Expression (such as Simple Language) used to dynamically set the
+ * filename when moving it after processing. To move files into a .done
+ * subdirectory just enter .done.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: filter
+ *
+ * @param move the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder move(String move) {
+ doSetProperty("move", move);
+ return this;
+ }
+ /**
+ * Pluggable read-lock as a
+ * org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy
+ * implementation.
+ *
+ * The option is a:
+ * <code>org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy&lt;com.azure.storage.file.share.models.ShareFileItem&gt;</code> type.
+ *
+ * Group: lock
+ *
+ * @param exclusiveReadLockStrategy the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder exclusiveReadLockStrategy(
+ org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy<com.azure.storage.file.share.models.ShareFileItem> exclusiveReadLockStrategy) {
+ doSetProperty("exclusiveReadLockStrategy", exclusiveReadLockStrategy);
+ return this;
+ }
+ /**
+ * Pluggable read-lock as a
+ * org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy
+ * implementation.
+ *
+ * The option will be converted to a
+ * <code>org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy&lt;com.azure.storage.file.share.models.ShareFileItem&gt;</code> type.
+ *
+ * Group: lock
+ *
+ * @param exclusiveReadLockStrategy the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder exclusiveReadLockStrategy(
+ String exclusiveReadLockStrategy) {
+ doSetProperty("exclusiveReadLockStrategy", exclusiveReadLockStrategy);
+ return this;
+ }
+ /**
+ * Used by consumer, to only poll the files if it has exclusive
+ * read-lock on the file (i.e. the file is not in-progress or being
+ * written). Camel will wait until the file lock is granted. This option
+ * provides the build in strategies: - none - No read lock is in use -
+ * markerFile - Camel creates a marker file (fileName.camelLock) and
+ * then holds a lock on it. This option is not available for the FTP
+ * component - changed - Changed is using file length/modification
+ * timestamp to detect whether the file is currently being copied or
+ * not. Will at least use 1 sec to determine this, so this option cannot
+ * consume files as fast as the others, but can be more reliable as the
+ * JDK IO API cannot always determine whether a file is currently being
+ * used by another process. The option readLockCheckInterval can be used
+ * to set the check frequency. - fileLock - is for using
+ * java.nio.channels.FileLock. This option is not avail for Windows OS
+ * and the FTP component. This approach should be avoided when accessing
+ * a remote file system via a mount/share unless that file system
+ * supports distributed file locks. - rename - rename is for using a try
+ * to rename the file as a test if we can get exclusive read-lock. -
+ * idempotent - (only for file component) idempotent is for using a
+ * idempotentRepository as the read-lock. This allows to use read locks
+ * that supports clustering if the idempotent repository implementation
+ * supports that. - idempotent-changed - (only for file component)
+ * idempotent-changed is for using a idempotentRepository and changed as
+ * the combined read-lock. This allows to use read locks that supports
+ * clustering if the idempotent repository implementation supports that.
+ * - idempotent-rename - (only for file component) idempotent-rename is
+ * for using a idempotentRepository and rename as the combined
+ * read-lock. This allows to use read locks that supports clustering if
+ * the idempotent repository implementation supports that.Notice: The
+ * various read locks is not all suited to work in clustered mode, where
+ * concurrent consumers on different nodes is competing for the same
+ * files on a shared file system. The markerFile using a close to atomic
+ * operation to create the empty marker file, but its not guaranteed to
+ * work in a cluster. The fileLock may work better but then the file
+ * system need to support distributed file locks, and so on. Using the
+ * idempotent read lock can support clustering if the idempotent
+ * repository supports clustering, such as Hazelcast Component or
+ * Infinispan.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Default: none
+ * Group: lock
+ *
+ * @param readLock the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder readLock(String readLock) {
+ doSetProperty("readLock", readLock);
+ return this;
+ }
+ /**
+ * Interval in millis for the read-lock, if supported by the read lock.
+ * This interval is used for sleeping between attempts to acquire the
+ * read lock. For example when using the changed read lock, you can set
+ * a higher interval period to cater for slow writes. The default of 1
+ * sec. may be too fast if the producer is very slow writing the file.
+ * Notice: For FTP the default readLockCheckInterval is 5000. The
+ * readLockTimeout value must be higher than readLockCheckInterval, but
+ * a rule of thumb is to have a timeout that is at least 2 or more times
+ * higher than the readLockCheckInterval. This is needed to ensure that
+ * amble time is allowed for the read lock process to try to grab the
+ * lock before the timeout was hit.
+ *
+ * The option is a: <code>long</code> type.
+ *
+ * Default: 1000
+ * Group: lock
+ *
+ * @param readLockCheckInterval the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder readLockCheckInterval(
+ long readLockCheckInterval) {
+ doSetProperty("readLockCheckInterval", readLockCheckInterval);
+ return this;
+ }
+ /**
+ * Interval in millis for the read-lock, if supported by the read lock.
+ * This interval is used for sleeping between attempts to acquire the
+ * read lock. For example when using the changed read lock, you can set
+ * a higher interval period to cater for slow writes. The default of 1
+ * sec. may be too fast if the producer is very slow writing the file.
+ * Notice: For FTP the default readLockCheckInterval is 5000. The
+ * readLockTimeout value must be higher than readLockCheckInterval, but
+ * a rule of thumb is to have a timeout that is at least 2 or more times
+ * higher than the readLockCheckInterval. This is needed to ensure that
+ * amble time is allowed for the read lock process to try to grab the
+ * lock before the timeout was hit.
+ *
+ * The option will be converted to a <code>long</code> type.
+ *
+ * Default: 1000
+ * Group: lock
+ *
+ * @param readLockCheckInterval the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder readLockCheckInterval(
+ String readLockCheckInterval) {
+ doSetProperty("readLockCheckInterval", readLockCheckInterval);
+ return this;
+ }
+ /**
+ * Whether or not read lock with marker files should upon startup delete
+ * any orphan read lock files, which may have been left on the file
+ * system, if Camel was not properly shutdown (such as a JVM crash). If
+ * turning this option to false then any orphaned lock file will cause
+ * Camel to not attempt to pickup that file, this could also be due
+ * another node is concurrently reading files from the same shared
+ * directory.
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: true
+ * Group: lock
+ *
+ * @param readLockDeleteOrphanLockFiles the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder readLockDeleteOrphanLockFiles(
+ boolean readLockDeleteOrphanLockFiles) {
+ doSetProperty("readLockDeleteOrphanLockFiles", readLockDeleteOrphanLockFiles);
+ return this;
+ }
+ /**
+ * Whether or not read lock with marker files should upon startup delete
+ * any orphan read lock files, which may have been left on the file
+ * system, if Camel was not properly shutdown (such as a JVM crash). If
+ * turning this option to false then any orphaned lock file will cause
+ * Camel to not attempt to pickup that file, this could also be due
+ * another node is concurrently reading files from the same shared
+ * directory.
+ *
+ * The option will be converted to a <code>boolean</code>
+ * type.
+ *
+ * Default: true
+ * Group: lock
+ *
+ * @param readLockDeleteOrphanLockFiles the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder readLockDeleteOrphanLockFiles(
+ String readLockDeleteOrphanLockFiles) {
+ doSetProperty("readLockDeleteOrphanLockFiles", readLockDeleteOrphanLockFiles);
+ return this;
+ }
+ /**
+ * Logging level used when a read lock could not be acquired. By default
+ * a DEBUG is logged. You can change this level, for example to OFF to
+ * not have any logging. This option is only applicable for readLock of
+ * types: changed, fileLock, idempotent, idempotent-changed,
+ * idempotent-rename, rename.
+ *
+ * The option is a:
+ * <code>org.apache.camel.LoggingLevel</code> type.
+ *
+ * Default: DEBUG
+ * Group: lock
+ *
+ * @param readLockLoggingLevel the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder readLockLoggingLevel(
+ org.apache.camel.LoggingLevel readLockLoggingLevel) {
+ doSetProperty("readLockLoggingLevel", readLockLoggingLevel);
+ return this;
+ }
+ /**
+ * Logging level used when a read lock could not be acquired. By default
+ * a DEBUG is logged. You can change this level, for example to OFF to
+ * not have any logging. This option is only applicable for readLock of
+ * types: changed, fileLock, idempotent, idempotent-changed,
+ * idempotent-rename, rename.
+ *
+ * The option will be converted to a
+ * <code>org.apache.camel.LoggingLevel</code> type.
+ *
+ * Default: DEBUG
+ * Group: lock
+ *
+ * @param readLockLoggingLevel the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder readLockLoggingLevel(
+ String readLockLoggingLevel) {
+ doSetProperty("readLockLoggingLevel", readLockLoggingLevel);
+ return this;
+ }
+ /**
+ * Whether to use marker file with the changed, rename, or exclusive
+ * read lock types. By default a marker file is used as well to guard
+ * against other processes picking up the same files. This behavior can
+ * be turned off by setting this option to false. For example if you do
+ * not want to write marker files to the file systems by the Camel
+ * application.
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: true
+ * Group: lock
+ *
+ * @param readLockMarkerFile the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder readLockMarkerFile(
+ boolean readLockMarkerFile) {
+ doSetProperty("readLockMarkerFile", readLockMarkerFile);
+ return this;
+ }
+ /**
+ * Whether to use marker file with the changed, rename, or exclusive
+ * read lock types. By default a marker file is used as well to guard
+ * against other processes picking up the same files. This behavior can
+ * be turned off by setting this option to false. For example if you do
+ * not want to write marker files to the file systems by the Camel
+ * application.
+ *
+ * The option will be converted to a <code>boolean</code>
+ * type.
+ *
+ * Default: true
+ * Group: lock
+ *
+ * @param readLockMarkerFile the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder readLockMarkerFile(
+ String readLockMarkerFile) {
+ doSetProperty("readLockMarkerFile", readLockMarkerFile);
+ return this;
+ }
+ /**
+ * This option is applied only for readLock=changed. It allows to
+ * specify a minimum age the file must be before attempting to acquire
+ * the read lock. For example use readLockMinAge=300s to require the
+ * file is at last 5 minutes old. This can speedup the changed read lock
+ * as it will only attempt to acquire files which are at least that
+ * given age.
+ *
+ * The option is a: <code>long</code> type.
+ *
+ * Default: 0
+ * Group: lock
+ *
+ * @param readLockMinAge the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder readLockMinAge(long readLockMinAge) {
+ doSetProperty("readLockMinAge", readLockMinAge);
+ return this;
+ }
+ /**
+ * This option is applied only for readLock=changed. It allows to
+ * specify a minimum age the file must be before attempting to acquire
+ * the read lock. For example use readLockMinAge=300s to require the
+ * file is at last 5 minutes old. This can speedup the changed read lock
+ * as it will only attempt to acquire files which are at least that
+ * given age.
+ *
+ * The option will be converted to a <code>long</code> type.
+ *
+ * Default: 0
+ * Group: lock
+ *
+ * @param readLockMinAge the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder readLockMinAge(
+ String readLockMinAge) {
+ doSetProperty("readLockMinAge", readLockMinAge);
+ return this;
+ }
+ /**
+ * This option is applied only for readLock=changed. It allows you to
+ * configure a minimum file length. By default Camel expects the file to
+ * contain data, and thus the default value is 1. You can set this
+ * option to zero, to allow consuming zero-length files.
+ *
+ * The option is a: <code>long</code> type.
+ *
+ * Default: 1
+ * Group: lock
+ *
+ * @param readLockMinLength the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder readLockMinLength(
+ long readLockMinLength) {
+ doSetProperty("readLockMinLength", readLockMinLength);
+ return this;
+ }
+ /**
+ * This option is applied only for readLock=changed. It allows you to
+ * configure a minimum file length. By default Camel expects the file to
+ * contain data, and thus the default value is 1. You can set this
+ * option to zero, to allow consuming zero-length files.
+ *
+ * The option will be converted to a <code>long</code> type.
+ *
+ * Default: 1
+ * Group: lock
+ *
+ * @param readLockMinLength the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder readLockMinLength(
+ String readLockMinLength) {
+ doSetProperty("readLockMinLength", readLockMinLength);
+ return this;
+ }
+ /**
+ * This option is applied only for readLock=idempotent. It allows to
+ * specify whether to remove the file name entry from the idempotent
+ * repository when processing the file is succeeded and a commit
+ * happens. By default the file is not removed which ensures that any
+ * race-condition do not occur so another active node may attempt to
+ * grab the file. Instead the idempotent repository may support eviction
+ * strategies that you can configure to evict the file name entry after
+ * X minutes - this ensures no problems with race conditions. See more
+ * details at the readLockIdempotentReleaseDelay option.
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: false
+ * Group: lock
+ *
+ * @param readLockRemoveOnCommit the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder readLockRemoveOnCommit(
+ boolean readLockRemoveOnCommit) {
+ doSetProperty("readLockRemoveOnCommit", readLockRemoveOnCommit);
+ return this;
+ }
+ /**
+ * This option is applied only for readLock=idempotent. It allows to
+ * specify whether to remove the file name entry from the idempotent
+ * repository when processing the file is succeeded and a commit
+ * happens. By default the file is not removed which ensures that any
+ * race-condition do not occur so another active node may attempt to
+ * grab the file. Instead the idempotent repository may support eviction
+ * strategies that you can configure to evict the file name entry after
+ * X minutes - this ensures no problems with race conditions. See more
+ * details at the readLockIdempotentReleaseDelay option.
+ *
+ * The option will be converted to a <code>boolean</code>
+ * type.
+ *
+ * Default: false
+ * Group: lock
+ *
+ * @param readLockRemoveOnCommit the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder readLockRemoveOnCommit(
+ String readLockRemoveOnCommit) {
+ doSetProperty("readLockRemoveOnCommit", readLockRemoveOnCommit);
+ return this;
+ }
+ /**
+ * This option is applied only for readLock=idempotent. It allows to
+ * specify whether to remove the file name entry from the idempotent
+ * repository when processing the file failed and a rollback happens. If
+ * this option is false, then the file name entry is confirmed (as if
+ * the file did a commit).
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: true
+ * Group: lock
+ *
+ * @param readLockRemoveOnRollback the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder readLockRemoveOnRollback(
+ boolean readLockRemoveOnRollback) {
+ doSetProperty("readLockRemoveOnRollback", readLockRemoveOnRollback);
+ return this;
+ }
+ /**
+ * This option is applied only for readLock=idempotent. It allows to
+ * specify whether to remove the file name entry from the idempotent
+ * repository when processing the file failed and a rollback happens. If
+ * this option is false, then the file name entry is confirmed (as if
+ * the file did a commit).
+ *
+ * The option will be converted to a <code>boolean</code>
+ * type.
+ *
+ * Default: true
+ * Group: lock
+ *
+ * @param readLockRemoveOnRollback the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder readLockRemoveOnRollback(
+ String readLockRemoveOnRollback) {
+ doSetProperty("readLockRemoveOnRollback", readLockRemoveOnRollback);
+ return this;
+ }
+ /**
+ * Optional timeout in millis for the read-lock, if supported by the
+ * read-lock. If the read-lock could not be granted and the timeout
+ * triggered, then Camel will skip the file. At next poll Camel, will
+ * try the file again, and this time maybe the read-lock could be
+ * granted. Use a value of 0 or lower to indicate forever. Currently
+ * fileLock, changed and rename support the timeout. Notice: For FTP the
+ * default readLockTimeout value is 20000 instead of 10000. The
+ * readLockTimeout value must be higher than readLockCheckInterval, but
+ * a rule of thumb is to have a timeout that is at least 2 or more times
+ * higher than the readLockCheckInterval. This is needed to ensure that
+ * amble time is allowed for the read lock process to try to grab the
+ * lock before the timeout was hit.
+ *
+ * The option is a: <code>long</code> type.
+ *
+ * Default: 10000
+ * Group: lock
+ *
+ * @param readLockTimeout the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder readLockTimeout(
+ long readLockTimeout) {
+ doSetProperty("readLockTimeout", readLockTimeout);
+ return this;
+ }
+ /**
+ * Optional timeout in millis for the read-lock, if supported by the
+ * read-lock. If the read-lock could not be granted and the timeout
+ * triggered, then Camel will skip the file. At next poll Camel, will
+ * try the file again, and this time maybe the read-lock could be
+ * granted. Use a value of 0 or lower to indicate forever. Currently
+ * fileLock, changed and rename support the timeout. Notice: For FTP the
+ * default readLockTimeout value is 20000 instead of 10000. The
+ * readLockTimeout value must be higher than readLockCheckInterval, but
+ * a rule of thumb is to have a timeout that is at least 2 or more times
+ * higher than the readLockCheckInterval. This is needed to ensure that
+ * amble time is allowed for the read lock process to try to grab the
+ * lock before the timeout was hit.
+ *
+ * The option will be converted to a <code>long</code> type.
+ *
+ * Default: 10000
+ * Group: lock
+ *
+ * @param readLockTimeout the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder readLockTimeout(
+ String readLockTimeout) {
+ doSetProperty("readLockTimeout", readLockTimeout);
+ return this;
+ }
+ /**
+ * The number of subsequent error polls (failed due some error) that
+ * should happen before the backoffMultipler should kick-in.
+ *
+ * The option is a: <code>int</code> type.
+ *
+ * Group: scheduler
+ *
+ * @param backoffErrorThreshold the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder backoffErrorThreshold(
+ int backoffErrorThreshold) {
+ doSetProperty("backoffErrorThreshold", backoffErrorThreshold);
+ return this;
+ }
+ /**
+ * The number of subsequent error polls (failed due some error) that
+ * should happen before the backoffMultipler should kick-in.
+ *
+ * The option will be converted to a <code>int</code> type.
+ *
+ * Group: scheduler
+ *
+ * @param backoffErrorThreshold the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder backoffErrorThreshold(
+ String backoffErrorThreshold) {
+ doSetProperty("backoffErrorThreshold", backoffErrorThreshold);
+ return this;
+ }
+ /**
+ * The number of subsequent idle polls that should happen before the
+ * backoffMultipler should kick-in.
+ *
+ * The option is a: <code>int</code> type.
+ *
+ * Group: scheduler
+ *
+ * @param backoffIdleThreshold the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder backoffIdleThreshold(
+ int backoffIdleThreshold) {
+ doSetProperty("backoffIdleThreshold", backoffIdleThreshold);
+ return this;
+ }
+ /**
+ * The number of subsequent idle polls that should happen before the
+ * backoffMultipler should kick-in.
+ *
+ * The option will be converted to a <code>int</code> type.
+ *
+ * Group: scheduler
+ *
+ * @param backoffIdleThreshold the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder backoffIdleThreshold(
+ String backoffIdleThreshold) {
+ doSetProperty("backoffIdleThreshold", backoffIdleThreshold);
+ return this;
+ }
+ /**
+ * To let the scheduled polling consumer backoff if there has been a
+ * number of subsequent idles/errors in a row. The multiplier is then
+ * the number of polls that will be skipped before the next actual
+ * attempt is happening again. When this option is in use then
+ * backoffIdleThreshold and/or backoffErrorThreshold must also be
+ * configured.
+ *
+ * The option is a: <code>int</code> type.
+ *
+ * Group: scheduler
+ *
+ * @param backoffMultiplier the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder backoffMultiplier(
+ int backoffMultiplier) {
+ doSetProperty("backoffMultiplier", backoffMultiplier);
+ return this;
+ }
+ /**
+ * To let the scheduled polling consumer backoff if there has been a
+ * number of subsequent idles/errors in a row. The multiplier is then
+ * the number of polls that will be skipped before the next actual
+ * attempt is happening again. When this option is in use then
+ * backoffIdleThreshold and/or backoffErrorThreshold must also be
+ * configured.
+ *
+ * The option will be converted to a <code>int</code> type.
+ *
+ * Group: scheduler
+ *
+ * @param backoffMultiplier the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder backoffMultiplier(
+ String backoffMultiplier) {
+ doSetProperty("backoffMultiplier", backoffMultiplier);
+ return this;
+ }
+ /**
+ * Milliseconds before the next poll.
+ *
+ * The option is a: <code>long</code> type.
+ *
+ * Default: 500
+ * Group: scheduler
+ *
+ * @param delay the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder delay(long delay) {
+ doSetProperty("delay", delay);
+ return this;
+ }
+ /**
+ * Milliseconds before the next poll.
+ *
+ * The option will be converted to a <code>long</code> type.
+ *
+ * Default: 500
+ * Group: scheduler
+ *
+ * @param delay the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder delay(String delay) {
+ doSetProperty("delay", delay);
+ return this;
+ }
+ /**
+ * If greedy is enabled, then the ScheduledPollConsumer will run
+ * immediately again, if the previous run polled 1 or more messages.
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: false
+ * Group: scheduler
+ *
+ * @param greedy the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder greedy(boolean greedy) {
+ doSetProperty("greedy", greedy);
+ return this;
+ }
+ /**
+ * If greedy is enabled, then the ScheduledPollConsumer will run
+ * immediately again, if the previous run polled 1 or more messages.
+ *
+ * The option will be converted to a <code>boolean</code>
+ * type.
+ *
+ * Default: false
+ * Group: scheduler
+ *
+ * @param greedy the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder greedy(String greedy) {
+ doSetProperty("greedy", greedy);
+ return this;
+ }
+ /**
+ * Milliseconds before the first poll starts.
+ *
+ * The option is a: <code>long</code> type.
+ *
+ * Default: 1000
+ * Group: scheduler
+ *
+ * @param initialDelay the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder initialDelay(long initialDelay) {
+ doSetProperty("initialDelay", initialDelay);
+ return this;
+ }
+ /**
+ * Milliseconds before the first poll starts.
+ *
+ * The option will be converted to a <code>long</code> type.
+ *
+ * Default: 1000
+ * Group: scheduler
+ *
+ * @param initialDelay the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder initialDelay(String initialDelay) {
+ doSetProperty("initialDelay", initialDelay);
+ return this;
+ }
+ /**
+ * Specifies a maximum limit of number of fires. So if you set it to 1,
+ * the scheduler will only fire once. If you set it to 5, it will only
+ * fire five times. A value of zero or negative means fire forever.
+ *
+ * The option is a: <code>long</code> type.
+ *
+ * Default: 0
+ * Group: scheduler
+ *
+ * @param repeatCount the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder repeatCount(long repeatCount) {
+ doSetProperty("repeatCount", repeatCount);
+ return this;
+ }
+ /**
+ * Specifies a maximum limit of number of fires. So if you set it to 1,
+ * the scheduler will only fire once. If you set it to 5, it will only
+ * fire five times. A value of zero or negative means fire forever.
+ *
+ * The option will be converted to a <code>long</code> type.
+ *
+ * Default: 0
+ * Group: scheduler
+ *
+ * @param repeatCount the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder repeatCount(String repeatCount) {
+ doSetProperty("repeatCount", repeatCount);
+ return this;
+ }
+ /**
+ * The consumer logs a start/complete log line when it polls. This
+ * option allows you to configure the logging level for that.
+ *
+ * The option is a:
+ * <code>org.apache.camel.LoggingLevel</code> type.
+ *
+ * Default: TRACE
+ * Group: scheduler
+ *
+ * @param runLoggingLevel the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder runLoggingLevel(
+ org.apache.camel.LoggingLevel runLoggingLevel) {
+ doSetProperty("runLoggingLevel", runLoggingLevel);
+ return this;
+ }
+ /**
+ * The consumer logs a start/complete log line when it polls. This
+ * option allows you to configure the logging level for that.
+ *
+ * The option will be converted to a
+ * <code>org.apache.camel.LoggingLevel</code> type.
+ *
+ * Default: TRACE
+ * Group: scheduler
+ *
+ * @param runLoggingLevel the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder runLoggingLevel(
+ String runLoggingLevel) {
+ doSetProperty("runLoggingLevel", runLoggingLevel);
+ return this;
+ }
+ /**
+ * Allows for configuring a custom/shared thread pool to use for the
+ * consumer. By default each consumer has its own single threaded thread
+ * pool.
+ *
+ * The option is a:
+ * <code>java.util.concurrent.ScheduledExecutorService</code> type.
+ *
+ * Group: scheduler
+ *
+ * @param scheduledExecutorService the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder scheduledExecutorService(
+ ScheduledExecutorService scheduledExecutorService) {
+ doSetProperty("scheduledExecutorService", scheduledExecutorService);
+ return this;
+ }
+ /**
+ * Allows for configuring a custom/shared thread pool to use for the
+ * consumer. By default each consumer has its own single threaded thread
+ * pool.
+ *
+ * The option will be converted to a
+ * <code>java.util.concurrent.ScheduledExecutorService</code> type.
+ *
+ * Group: scheduler
+ *
+ * @param scheduledExecutorService the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder scheduledExecutorService(
+ String scheduledExecutorService) {
+ doSetProperty("scheduledExecutorService", scheduledExecutorService);
+ return this;
+ }
+ /**
+ * To use a cron scheduler from either camel-spring or camel-quartz
+ * component. Use value spring or quartz for built in scheduler.
+ *
+ * The option is a: <code>java.lang.Object</code> type.
+ *
+ * Default: none
+ * Group: scheduler
+ *
+ * @param scheduler the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder scheduler(Object scheduler) {
+ doSetProperty("scheduler", scheduler);
+ return this;
+ }
+ /**
+ * To use a cron scheduler from either camel-spring or camel-quartz
+ * component. Use value spring or quartz for built in scheduler.
+ *
+ * The option will be converted to a
+ * <code>java.lang.Object</code> type.
+ *
+ * Default: none
+ * Group: scheduler
+ *
+ * @param scheduler the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder scheduler(String scheduler) {
+ doSetProperty("scheduler", scheduler);
+ return this;
+ }
+ /**
+ * To configure additional properties when using a custom scheduler or
+ * any of the Quartz, Spring based scheduler.
+ *
+ * The option is a: <code>java.util.Map&lt;java.lang.String,
+ * java.lang.Object&gt;</code> type.
+ * The option is multivalued, and you can use the
+ * schedulerProperties(String, Object) method to add a value (call the
+ * method multiple times to set more values).
+ *
+ * Group: scheduler
+ *
+ * @param key the option key
+ * @param value the option value
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder schedulerProperties(
+ String key,
+ Object value) {
+ doSetMultiValueProperty("schedulerProperties", "scheduler." + key, value);
+ return this;
+ }
+ /**
+ * To configure additional properties when using a custom scheduler or
+ * any of the Quartz, Spring based scheduler.
+ *
+ * The option is a: <code>java.util.Map&lt;java.lang.String,
+ * java.lang.Object&gt;</code> type.
+ * The option is multivalued, and you can use the
+ * schedulerProperties(String, Object) method to add a value (call the
+ * method multiple times to set more values).
+ *
+ * Group: scheduler
+ *
+ * @param values the values
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder schedulerProperties(Map values) {
+ doSetMultiValueProperties("schedulerProperties", "scheduler.", values);
+ return this;
+ }
+ /**
+ * Whether the scheduler should be auto started.
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: true
+ * Group: scheduler
+ *
+ * @param startScheduler the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder startScheduler(
+ boolean startScheduler) {
+ doSetProperty("startScheduler", startScheduler);
+ return this;
+ }
+ /**
+ * Whether the scheduler should be auto started.
+ *
+ * The option will be converted to a <code>boolean</code>
+ * type.
+ *
+ * Default: true
+ * Group: scheduler
+ *
+ * @param startScheduler the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder startScheduler(
+ String startScheduler) {
+ doSetProperty("startScheduler", startScheduler);
+ return this;
+ }
+ /**
+ * Time unit for initialDelay and delay options.
+ *
+ * The option is a:
+ * <code>java.util.concurrent.TimeUnit</code> type.
+ *
+ * Default: MILLISECONDS
+ * Group: scheduler
+ *
+ * @param timeUnit the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder timeUnit(TimeUnit timeUnit) {
+ doSetProperty("timeUnit", timeUnit);
+ return this;
+ }
+ /**
+ * Time unit for initialDelay and delay options.
+ *
+ * The option will be converted to a
+ * <code>java.util.concurrent.TimeUnit</code> type.
+ *
+ * Default: MILLISECONDS
+ * Group: scheduler
+ *
+ * @param timeUnit the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder timeUnit(String timeUnit) {
+ doSetProperty("timeUnit", timeUnit);
+ return this;
+ }
+ /**
+ * Controls if fixed delay or fixed rate is used. See
+ * ScheduledExecutorService in JDK for details.
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: true
+ * Group: scheduler
+ *
+ * @param useFixedDelay the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder useFixedDelay(boolean useFixedDelay) {
+ doSetProperty("useFixedDelay", useFixedDelay);
+ return this;
+ }
+ /**
+ * Controls if fixed delay or fixed rate is used. See
+ * ScheduledExecutorService in JDK for details.
+ *
+ * The option will be converted to a <code>boolean</code>
+ * type.
+ *
+ * Default: true
+ * Group: scheduler
+ *
+ * @param useFixedDelay the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder useFixedDelay(String useFixedDelay) {
+ doSetProperty("useFixedDelay", useFixedDelay);
+ return this;
+ }
+ /**
+ * To shuffle the list of files (sort in random order).
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: false
+ * Group: sort
+ *
+ * @param shuffle the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder shuffle(boolean shuffle) {
+ doSetProperty("shuffle", shuffle);
+ return this;
+ }
+ /**
+ * To shuffle the list of files (sort in random order).
+ *
+ * The option will be converted to a <code>boolean</code>
+ * type.
+ *
+ * Default: false
+ * Group: sort
+ *
+ * @param shuffle the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder shuffle(String shuffle) {
+ doSetProperty("shuffle", shuffle);
+ return this;
+ }
+ /**
+ * Built-in sort by using the File Language. Supports nested sorts, so
+ * you can have a sort by file name and as a 2nd group sort by modified
+ * date.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: sort
+ *
+ * @param sortBy the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder sortBy(String sortBy) {
+ doSetProperty("sortBy", sortBy);
+ return this;
+ }
+ /**
+ * Pluggable sorter as a java.util.Comparator class.
+ *
+ * The option is a:
+ * <code>java.util.Comparator&lt;org.apache.camel.component.file.GenericFile&lt;com.azure.storage.file.share.models.ShareFileItem&gt;&gt;</code> type.
+ *
+ * Group: sort
+ *
+ * @param sorter the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder sorter(
+ Comparator<org.apache.camel.component.file.GenericFile<com.azure.storage.file.share.models.ShareFileItem>> sorter) {
+ doSetProperty("sorter", sorter);
+ return this;
+ }
+ /**
+ * Pluggable sorter as a java.util.Comparator class.
+ *
+ * The option will be converted to a
+ * <code>java.util.Comparator&lt;org.apache.camel.component.file.GenericFile&lt;com.azure.storage.file.share.models.ShareFileItem&gt;&gt;</code> type.
+ *
+ * Group: sort
+ *
+ * @param sorter the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointConsumerBuilder sorter(String sorter) {
+ doSetProperty("sorter", sorter);
+ return this;
+ }
+ }
+
+ /**
+ * Advanced builder for endpoint consumers for the Azure Files component.
+ */
+ public interface AdvancedFilesEndpointConsumerBuilder
+ extends
+ EndpointConsumerBuilder {
+ default FilesEndpointConsumerBuilder basic() {
+ return (FilesEndpointConsumerBuilder) this;
+ }
+ /**
+ * 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.
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: false
+ * Group: consumer (advanced)
+ *
+ * @param bridgeErrorHandler the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointConsumerBuilder bridgeErrorHandler(
+ boolean bridgeErrorHandler) {
+ doSetProperty("bridgeErrorHandler", bridgeErrorHandler);
+ return this;
+ }
+ /**
+ * 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.
+ *
+ * The option will be converted to a <code>boolean</code>
+ * type.
+ *
+ * Default: false
+ * Group: consumer (advanced)
+ *
+ * @param bridgeErrorHandler the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointConsumerBuilder bridgeErrorHandler(
+ String bridgeErrorHandler) {
+ doSetProperty("bridgeErrorHandler", bridgeErrorHandler);
+ return this;
+ }
+ /**
+ * Whether the FTP consumer should download the file. If this option is
+ * set to false, then the message body will be null, but the consumer
+ * will still trigger a Camel Exchange that has details about the file
+ * such as file name, file size, etc. It's just that the file will not
+ * be downloaded.
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: false
+ * Group: consumer (advanced)
+ *
+ * @param download the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointConsumerBuilder download(boolean download) {
+ doSetProperty("download", download);
+ return this;
+ }
+ /**
+ * Whether the FTP consumer should download the file. If this option is
+ * set to false, then the message body will be null, but the consumer
+ * will still trigger a Camel Exchange that has details about the file
+ * such as file name, file size, etc. It's just that the file will not
+ * be downloaded.
+ *
+ * The option will be converted to a <code>boolean</code>
+ * type.
+ *
+ * Default: false
+ * Group: consumer (advanced)
+ *
+ * @param download the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointConsumerBuilder download(String download) {
+ doSetProperty("download", download);
+ return this;
+ }
+ /**
+ * To let the consumer use a custom ExceptionHandler. Notice if the
+ * option bridgeErrorHandler is enabled then this option is not in use.
+ * By default the consumer will deal with exceptions, that will be
+ * logged at WARN or ERROR level and ignored.
+ *
+ * The option is a:
+ * <code>org.apache.camel.spi.ExceptionHandler</code> type.
+ *
+ * Group: consumer (advanced)
+ *
+ * @param exceptionHandler the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointConsumerBuilder exceptionHandler(
+ org.apache.camel.spi.ExceptionHandler exceptionHandler) {
+ doSetProperty("exceptionHandler", exceptionHandler);
+ return this;
+ }
+ /**
+ * To let the consumer use a custom ExceptionHandler. Notice if the
+ * option bridgeErrorHandler is enabled then this option is not in use.
+ * By default the consumer will deal with exceptions, that will be
+ * logged at WARN or ERROR level and ignored.
+ *
+ * The option will be converted to a
+ * <code>org.apache.camel.spi.ExceptionHandler</code> type.
+ *
+ * Group: consumer (advanced)
+ *
+ * @param exceptionHandler the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointConsumerBuilder exceptionHandler(
+ String exceptionHandler) {
+ doSetProperty("exceptionHandler", exceptionHandler);
+ return this;
+ }
+ /**
+ * Sets the exchange pattern when the consumer creates an exchange.
+ *
+ * The option is a:
+ * <code>org.apache.camel.ExchangePattern</code> type.
+ *
+ * Group: consumer (advanced)
+ *
+ * @param exchangePattern the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointConsumerBuilder exchangePattern(
+ org.apache.camel.ExchangePattern exchangePattern) {
+ doSetProperty("exchangePattern", exchangePattern);
+ return this;
+ }
+ /**
+ * Sets the exchange pattern when the consumer creates an exchange.
+ *
+ * The option will be converted to a
+ * <code>org.apache.camel.ExchangePattern</code> type.
+ *
+ * Group: consumer (advanced)
+ *
+ * @param exchangePattern the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointConsumerBuilder exchangePattern(
+ String exchangePattern) {
+ doSetProperty("exchangePattern", exchangePattern);
+ return this;
+ }
+ /**
+ * A pluggable in-progress repository
+ * org.apache.camel.spi.IdempotentRepository. The in-progress repository
+ * is used to account the current in progress files being consumed. By
+ * default a memory based repository is used.
+ *
+ * The option is a:
+ * <code>org.apache.camel.spi.IdempotentRepository</code>
+ * type.
+ *
+ * Group: consumer (advanced)
+ *
+ * @param inProgressRepository the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointConsumerBuilder inProgressRepository(
+ org.apache.camel.spi.IdempotentRepository inProgressRepository) {
+ doSetProperty("inProgressRepository", inProgressRepository);
+ return this;
+ }
+ /**
+ * A pluggable in-progress repository
+ * org.apache.camel.spi.IdempotentRepository. The in-progress repository
+ * is used to account the current in progress files being consumed. By
+ * default a memory based repository is used.
+ *
+ * The option will be converted to a
+ * <code>org.apache.camel.spi.IdempotentRepository</code>
+ * type.
+ *
+ * Group: consumer (advanced)
+ *
+ * @param inProgressRepository the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointConsumerBuilder inProgressRepository(
+ String inProgressRepository) {
+ doSetProperty("inProgressRepository", inProgressRepository);
+ return this;
+ }
+ /**
+ * When consuming, a local work directory can be used to store the
+ * remote file content directly in local files, to avoid loading the
+ * content into memory. This is beneficial, if you consume a very big
+ * remote file and thus can conserve memory.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: consumer (advanced)
+ *
+ * @param localWorkDirectory the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointConsumerBuilder localWorkDirectory(
+ String localWorkDirectory) {
+ doSetProperty("localWorkDirectory", localWorkDirectory);
+ return this;
+ }
+ /**
+ * To use a custom org.apache.camel.spi.ExceptionHandler to handle any
+ * thrown exceptions that happens during the file on completion process
+ * where the consumer does either a commit or rollback. The default
+ * implementation will log any exception at WARN level and ignore.
+ *
+ * The option is a:
+ * <code>org.apache.camel.spi.ExceptionHandler</code> type.
+ *
+ * Group: consumer (advanced)
+ *
+ * @param onCompletionExceptionHandler the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointConsumerBuilder onCompletionExceptionHandler(
+ org.apache.camel.spi.ExceptionHandler onCompletionExceptionHandler) {
+ doSetProperty("onCompletionExceptionHandler", onCompletionExceptionHandler);
+ return this;
+ }
+ /**
+ * To use a custom org.apache.camel.spi.ExceptionHandler to handle any
+ * thrown exceptions that happens during the file on completion process
+ * where the consumer does either a commit or rollback. The default
+ * implementation will log any exception at WARN level and ignore.
+ *
+ * The option will be converted to a
+ * <code>org.apache.camel.spi.ExceptionHandler</code> type.
+ *
+ * Group: consumer (advanced)
+ *
+ * @param onCompletionExceptionHandler the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointConsumerBuilder onCompletionExceptionHandler(
+ String onCompletionExceptionHandler) {
+ doSetProperty("onCompletionExceptionHandler", onCompletionExceptionHandler);
+ return this;
+ }
+ /**
+ * A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing
+ * you to provide your custom implementation to control error handling
+ * usually occurred during the poll operation before an Exchange have
+ * been created and being routed in Camel.
+ *
+ * The option is a:
+ * <code>org.apache.camel.spi.PollingConsumerPollStrategy</code> type.
+ *
+ * Group: consumer (advanced)
+ *
+ * @param pollStrategy the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointConsumerBuilder pollStrategy(
+ org.apache.camel.spi.PollingConsumerPollStrategy pollStrategy) {
+ doSetProperty("pollStrategy", pollStrategy);
+ return this;
+ }
+ /**
+ * A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing
+ * you to provide your custom implementation to control error handling
+ * usually occurred during the poll operation before an Exchange have
+ * been created and being routed in Camel.
+ *
+ * The option will be converted to a
+ * <code>org.apache.camel.spi.PollingConsumerPollStrategy</code> type.
+ *
+ * Group: consumer (advanced)
+ *
+ * @param pollStrategy the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointConsumerBuilder pollStrategy(
+ String pollStrategy) {
+ doSetProperty("pollStrategy", pollStrategy);
+ return this;
+ }
+ /**
+ * A pluggable
+ * org.apache.camel.component.file.GenericFileProcessStrategy allowing
+ * you to implement your own readLock option or similar. Can also be
+ * used when special conditions must be met before a file can be
+ * consumed, such as a special ready file exists. If this option is set
+ * then the readLock option does not apply.
+ *
+ * The option is a:
+ * <code>org.apache.camel.component.file.GenericFileProcessStrategy&lt;com.azure.storage.file.share.models.ShareFileItem&gt;</code> type.
+ *
+ * Group: consumer (advanced)
+ *
+ * @param processStrategy the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointConsumerBuilder processStrategy(
+ org.apache.camel.component.file.GenericFileProcessStrategy<com.azure.storage.file.share.models.ShareFileItem> processStrategy) {
+ doSetProperty("processStrategy", processStrategy);
+ return this;
+ }
+ /**
+ * A pluggable
+ * org.apache.camel.component.file.GenericFileProcessStrategy allowing
+ * you to implement your own readLock option or similar. Can also be
+ * used when special conditions must be met before a file can be
+ * consumed, such as a special ready file exists. If this option is set
+ * then the readLock option does not apply.
+ *
+ * The option will be converted to a
+ * <code>org.apache.camel.component.file.GenericFileProcessStrategy&lt;com.azure.storage.file.share.models.ShareFileItem&gt;</code> type.
+ *
+ * Group: consumer (advanced)
+ *
+ * @param processStrategy the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointConsumerBuilder processStrategy(
+ String processStrategy) {
+ doSetProperty("processStrategy", processStrategy);
+ return this;
+ }
+ /**
+ * Automatically create missing directories in the file's pathname. For
+ * the file consumer, that means creating the starting directory. For
+ * the file producer, it means the directory the files should be written
+ * to.
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: true
+ * Group: advanced
+ *
+ * @param autoCreate the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointConsumerBuilder autoCreate(
+ boolean autoCreate) {
+ doSetProperty("autoCreate", autoCreate);
+ return this;
+ }
+ /**
+ * Automatically create missing directories in the file's pathname. For
+ * the file consumer, that means creating the starting directory. For
+ * the file producer, it means the directory the files should be written
+ * to.
+ *
+ * The option will be converted to a <code>boolean</code>
+ * type.
+ *
+ * Default: true
+ * Group: advanced
+ *
+ * @param autoCreate the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointConsumerBuilder autoCreate(
+ String autoCreate) {
+ doSetProperty("autoCreate", autoCreate);
+ return this;
+ }
+ /**
+ * Sets the connect timeout for waiting for a connection to be
+ * established Used by both FTPClient and JSCH.
+ *
+ * The option is a: <code>int</code> type.
+ *
+ * Default: 10000
+ * Group: advanced
+ *
+ * @param connectTimeout the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointConsumerBuilder connectTimeout(
+ int connectTimeout) {
+ doSetProperty("connectTimeout", connectTimeout);
+ return this;
+ }
+ /**
+ * Sets the connect timeout for waiting for a connection to be
+ * established Used by both FTPClient and JSCH.
+ *
+ * The option will be converted to a <code>int</code> type.
+ *
+ * Default: 10000
+ * Group: advanced
+ *
+ * @param connectTimeout the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointConsumerBuilder connectTimeout(
+ String connectTimeout) {
+ doSetProperty("connectTimeout", connectTimeout);
+ return this;
+ }
+ /**
+ * Specifies the maximum reconnect attempts Camel performs when it tries
+ * to connect to the remote FTP server. Use 0 to disable this behavior.
+ *
+ * The option is a: <code>int</code> type.
+ *
+ * Group: advanced
+ *
+ * @param maximumReconnectAttempts the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointConsumerBuilder maximumReconnectAttempts(
+ int maximumReconnectAttempts) {
+ doSetProperty("maximumReconnectAttempts", maximumReconnectAttempts);
+ return this;
+ }
+ /**
+ * Specifies the maximum reconnect attempts Camel performs when it tries
+ * to connect to the remote FTP server. Use 0 to disable this behavior.
+ *
+ * The option will be converted to a <code>int</code> type.
+ *
+ * Group: advanced
+ *
+ * @param maximumReconnectAttempts the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointConsumerBuilder maximumReconnectAttempts(
+ String maximumReconnectAttempts) {
+ doSetProperty("maximumReconnectAttempts", maximumReconnectAttempts);
+ return this;
+ }
+ /**
+ * Delay in millis Camel will wait before performing a reconnect
+ * attempt.
+ *
+ * The option is a: <code>long</code> type.
+ *
+ * Default: 1000
+ * Group: advanced
+ *
+ * @param reconnectDelay the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointConsumerBuilder reconnectDelay(
+ long reconnectDelay) {
+ doSetProperty("reconnectDelay", reconnectDelay);
+ return this;
+ }
+ /**
+ * Delay in millis Camel will wait before performing a reconnect
+ * attempt.
+ *
+ * The option will be converted to a <code>long</code> type.
+ *
+ * Default: 1000
+ * Group: advanced
+ *
+ * @param reconnectDelay the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointConsumerBuilder reconnectDelay(
+ String reconnectDelay) {
+ doSetProperty("reconnectDelay", reconnectDelay);
+ return this;
+ }
+ /**
+ * Should an exception be thrown if connection failed (exhausted)By
+ * default exception is not thrown and a WARN is logged. You can use
+ * this to enable exception being thrown and handle the thrown exception
+ * from the org.apache.camel.spi.PollingConsumerPollStrategy rollback
+ * method.
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: false
+ * Group: advanced
+ *
+ * @param throwExceptionOnConnectFailed the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointConsumerBuilder throwExceptionOnConnectFailed(
+ boolean throwExceptionOnConnectFailed) {
+ doSetProperty("throwExceptionOnConnectFailed", throwExceptionOnConnectFailed);
+ return this;
+ }
+ /**
+ * Should an exception be thrown if connection failed (exhausted)By
+ * default exception is not thrown and a WARN is logged. You can use
+ * this to enable exception being thrown and handle the thrown exception
+ * from the org.apache.camel.spi.PollingConsumerPollStrategy rollback
+ * method.
+ *
+ * The option will be converted to a <code>boolean</code>
+ * type.
+ *
+ * Default: false
+ * Group: advanced
+ *
+ * @param throwExceptionOnConnectFailed the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointConsumerBuilder throwExceptionOnConnectFailed(
+ String throwExceptionOnConnectFailed) {
+ doSetProperty("throwExceptionOnConnectFailed", throwExceptionOnConnectFailed);
+ return this;
+ }
+ /**
+ * Sets the data timeout for waiting for reply Used only by FTPClient.
+ *
+ * The option is a: <code>int</code> type.
+ *
+ * Default: 30000
+ * Group: advanced
+ *
+ * @param timeout the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointConsumerBuilder timeout(int timeout) {
+ doSetProperty("timeout", timeout);
+ return this;
+ }
+ /**
+ * Sets the data timeout for waiting for reply Used only by FTPClient.
+ *
+ * The option will be converted to a <code>int</code> type.
+ *
+ * Default: 30000
+ * Group: advanced
+ *
+ * @param timeout the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointConsumerBuilder timeout(String timeout) {
+ doSetProperty("timeout", timeout);
+ return this;
+ }
+ }
+
+ /**
+ * Builder for endpoint producers for the Azure Files component.
+ */
+ public interface FilesEndpointProducerBuilder
+ extends
+ EndpointProducerBuilder {
+ default AdvancedFilesEndpointProducerBuilder advanced() {
+ return (AdvancedFilesEndpointProducerBuilder) this;
+ }
+ /**
+ * 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.
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: false
+ * Group: common
+ *
+ * @param disconnect the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointProducerBuilder disconnect(boolean disconnect) {
+ doSetProperty("disconnect", disconnect);
+ return this;
+ }
+ /**
+ * 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.
+ *
+ * The option will be converted to a <code>boolean</code>
+ * type.
+ *
+ * Default: false
+ * Group: common
+ *
+ * @param disconnect the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointProducerBuilder disconnect(String disconnect) {
+ doSetProperty("disconnect", disconnect);
+ return this;
+ }
+ /**
+ * 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 can specify
+ * a fixed name. Or you can use dynamic placeholders.The done file is
+ * always expected in the same folder as the original file. Only
+ * ${file.name} and ${file.name.next} is supported as dynamic
+ * placeholders.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: common
+ *
+ * @param doneFileName the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointProducerBuilder doneFileName(String doneFileName) {
+ doSetProperty("doneFileName", doneFileName);
+ return this;
+ }
+ /**
+ * Use Expression such as File Language to dynamically set the filename.
+ * For consumers, it's used as a filename filter. For producers, it's
+ * used to evaluate the filename to write. If an expression is set, it
+ * take precedence over the CamelFileName header. (Note: The header
+ * itself can also be an Expression). The expression options support
+ * both String and Expression types. If the expression is a String type,
+ * it is always evaluated using the File Language. If the expression is
+ * an Expression type, the specified Expression type is used - this
+ * allows you, for instance, to use OGNL expressions. For the consumer,
+ * you can use it to filter filenames, so you can for instance consume
+ * today's file using the File Language syntax:
+ * mydata-${date:now:yyyyMMdd}.txt. The producers support the
+ * CamelOverruleFileName header which takes precedence over any existing
+ * CamelFileName header; the CamelOverruleFileName is a header that is
+ * used only once, and makes it easier as this avoids to temporary store
+ * CamelFileName and have to restore it afterwards.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: common
+ *
+ * @param fileName the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointProducerBuilder fileName(String fileName) {
+ doSetProperty("fileName", fileName);
+ return this;
+ }
+ /**
+ * What to do if a file already exists with the same name. Override,
+ * which is the default, replaces the existing file. - Append - adds
+ * content to the existing file. - Fail - throws a
+ * GenericFileOperationException, indicating that there is already an
+ * existing file. - Ignore - silently ignores the problem and does not
+ * override the existing file, but assumes everything is okay. - Move -
+ * option requires to use the moveExisting option to be configured as
+ * well. The option eagerDeleteTargetFile can be used to control what to
+ * do if an moving the file, and there exists already an existing file,
+ * otherwise causing the move operation to fail. The Move option will
+ * move any existing files, before writing the target file. - TryRename
+ * is only applicable if tempFileName option is in use. This allows to
+ * try renaming the file from the temporary name to the actual name,
+ * without doing any exists check. This check may be faster on some file
+ * systems and especially FTP servers.
+ *
+ * The option is a:
+ * <code>org.apache.camel.component.file.GenericFileExist</code> type.
+ *
+ * Default: Override
+ * Group: producer
+ *
+ * @param fileExist the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointProducerBuilder fileExist(
+ org.apache.camel.component.file.GenericFileExist fileExist) {
+ doSetProperty("fileExist", fileExist);
+ return this;
+ }
+ /**
+ * What to do if a file already exists with the same name. Override,
+ * which is the default, replaces the existing file. - Append - adds
+ * content to the existing file. - Fail - throws a
+ * GenericFileOperationException, indicating that there is already an
+ * existing file. - Ignore - silently ignores the problem and does not
+ * override the existing file, but assumes everything is okay. - Move -
+ * option requires to use the moveExisting option to be configured as
+ * well. The option eagerDeleteTargetFile can be used to control what to
+ * do if an moving the file, and there exists already an existing file,
+ * otherwise causing the move operation to fail. The Move option will
+ * move any existing files, before writing the target file. - TryRename
+ * is only applicable if tempFileName option is in use. This allows to
+ * try renaming the file from the temporary name to the actual name,
+ * without doing any exists check. This check may be faster on some file
+ * systems and especially FTP servers.
+ *
+ * The option will be converted to a
+ * <code>org.apache.camel.component.file.GenericFileExist</code> type.
+ *
+ * Default: Override
+ * Group: producer
+ *
+ * @param fileExist the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointProducerBuilder fileExist(String fileExist) {
+ doSetProperty("fileExist", fileExist);
+ return this;
+ }
+ /**
+ * 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.
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: false
+ * Group: producer
+ *
+ * @param flatten the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointProducerBuilder flatten(boolean flatten) {
+ doSetProperty("flatten", flatten);
+ return this;
+ }
+ /**
+ * 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.
+ *
+ * The option will be converted to a <code>boolean</code>
+ * type.
+ *
+ * Default: false
+ * Group: producer
+ *
+ * @param flatten the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointProducerBuilder flatten(String flatten) {
+ doSetProperty("flatten", flatten);
+ return this;
+ }
+ /**
+ * 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.
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: true
+ * Group: producer
+ *
+ * @param jailStartingDirectory the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointProducerBuilder jailStartingDirectory(
+ boolean jailStartingDirectory) {
+ doSetProperty("jailStartingDirectory", jailStartingDirectory);
+ return this;
+ }
+ /**
+ * 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.
+ *
+ * The option will be converted to a <code>boolean</code>
+ * type.
+ *
+ * Default: true
+ * Group: producer
+ *
+ * @param jailStartingDirectory the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointProducerBuilder jailStartingDirectory(
+ String jailStartingDirectory) {
+ doSetProperty("jailStartingDirectory", jailStartingDirectory);
+ return this;
+ }
+ /**
+ * The same as tempPrefix option but offering a more fine grained
+ * control on the naming of the temporary filename as it uses the File
+ * Language. The location for tempFilename is relative to the final file
+ * location in the option 'fileName', not the target directory in the
+ * base uri. For example if option fileName includes a directory prefix:
+ * dir/finalFilename then tempFileName is relative to that subdirectory
+ * dir.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: producer
+ *
+ * @param tempFileName the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointProducerBuilder tempFileName(String tempFileName) {
+ doSetProperty("tempFileName", tempFileName);
+ return this;
+ }
+ /**
+ * This option is used to write the file using a temporary name and
+ * then, after the write is complete, rename it to the real name. Can be
+ * used to identify files being written and also avoid consumers (not
+ * using exclusive read locks) reading in progress files. Is often used
+ * by FTP when uploading big files.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: producer
+ *
+ * @param tempPrefix the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointProducerBuilder tempPrefix(String tempPrefix) {
+ doSetProperty("tempPrefix", tempPrefix);
+ return this;
+ }
+ /**
+ * part of service SAS token.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: both
+ *
+ * @param sdd the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointProducerBuilder sdd(String sdd) {
+ doSetProperty("sdd", sdd);
+ return this;
+ }
+ /**
+ * part of SAS token.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: both
+ *
+ * @param se the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointProducerBuilder se(String se) {
+ doSetProperty("se", se);
+ return this;
+ }
+ /**
+ * Shared key (storage account key).
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: both
+ *
+ * @param sharedKey the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointProducerBuilder sharedKey(String sharedKey) {
+ doSetProperty("sharedKey", sharedKey);
+ return this;
+ }
+ /**
+ * part of service SAS token.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: both
+ *
+ * @param si the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointProducerBuilder si(String si) {
+ doSetProperty("si", si);
+ return this;
+ }
+ /**
+ * part of SAS token.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: both
+ *
+ * @param sig the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointProducerBuilder sig(String sig) {
+ doSetProperty("sig", sig);
+ return this;
+ }
+ /**
+ * part of SAS token.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: both
+ *
+ * @param sip the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointProducerBuilder sip(String sip) {
+ doSetProperty("sip", sip);
+ return this;
+ }
+ /**
+ * part of SAS token.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: both
+ *
+ * @param sp the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointProducerBuilder sp(String sp) {
+ doSetProperty("sp", sp);
+ return this;
+ }
+ /**
+ * part of SAS token.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: both
+ *
+ * @param spr the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointProducerBuilder spr(String spr) {
+ doSetProperty("spr", spr);
+ return this;
+ }
+ /**
+ * part of service SAS token.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: both
+ *
+ * @param sr the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointProducerBuilder sr(String sr) {
+ doSetProperty("sr", sr);
+ return this;
+ }
+ /**
+ * part of SAS token.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: both
+ *
+ * @param srt the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointProducerBuilder srt(String srt) {
+ doSetProperty("srt", srt);
+ return this;
+ }
+ /**
+ * part of account SAS token.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: both
+ *
+ * @param ss the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointProducerBuilder ss(String ss) {
+ doSetProperty("ss", ss);
+ return this;
+ }
+ /**
+ * part of SAS token.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: both
+ *
+ * @param st the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointProducerBuilder st(String st) {
+ doSetProperty("st", st);
+ return this;
+ }
+ /**
+ * part of SAS token.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: both
+ *
+ * @param sv the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointProducerBuilder sv(String sv) {
+ doSetProperty("sv", sv);
+ return this;
+ }
+ }
+
+ /**
+ * Advanced builder for endpoint producers for the Azure Files component.
+ */
+ public interface AdvancedFilesEndpointProducerBuilder
+ extends
+ EndpointProducerBuilder {
+ default FilesEndpointProducerBuilder basic() {
+ return (FilesEndpointProducerBuilder) this;
+ }
+ /**
+ * Used to specify if a null body is allowed during file writing. If set
+ * to true then an empty file will be created, when set to false, and
+ * attempting to send a null body to the file component, a
+ * GenericFileWriteException of 'Cannot write null body to file.' will
+ * be thrown. If the fileExist option is set to 'Override', then the
+ * file will be truncated, and if set to append the file will remain
+ * unchanged.
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: false
+ * Group: producer (advanced)
+ *
+ * @param allowNullBody the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointProducerBuilder allowNullBody(
+ boolean allowNullBody) {
+ doSetProperty("allowNullBody", allowNullBody);
+ return this;
+ }
+ /**
+ * Used to specify if a null body is allowed during file writing. If set
+ * to true then an empty file will be created, when set to false, and
+ * attempting to send a null body to the file component, a
+ * GenericFileWriteException of 'Cannot write null body to file.' will
+ * be thrown. If the fileExist option is set to 'Override', then the
+ * file will be truncated, and if set to append the file will remain
+ * unchanged.
+ *
+ * The option will be converted to a <code>boolean</code>
+ * type.
+ *
+ * Default: false
+ * Group: producer (advanced)
+ *
+ * @param allowNullBody the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointProducerBuilder allowNullBody(
+ String allowNullBody) {
+ doSetProperty("allowNullBody", allowNullBody);
+ return this;
+ }
+ /**
+ * Whether or not to disconnect from remote FTP server right after a
+ * Batch upload is complete. disconnectOnBatchComplete will only
+ * disconnect the current connection to the FTP server.
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: false
+ * Group: producer (advanced)
+ *
+ * @param disconnectOnBatchComplete the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointProducerBuilder disconnectOnBatchComplete(
+ boolean disconnectOnBatchComplete) {
+ doSetProperty("disconnectOnBatchComplete", disconnectOnBatchComplete);
+ return this;
+ }
+ /**
+ * Whether or not to disconnect from remote FTP server right after a
+ * Batch upload is complete. disconnectOnBatchComplete will only
+ * disconnect the current connection to the FTP server.
+ *
+ * The option will be converted to a <code>boolean</code>
+ * type.
+ *
+ * Default: false
+ * Group: producer (advanced)
+ *
+ * @param disconnectOnBatchComplete the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointProducerBuilder disconnectOnBatchComplete(
+ String disconnectOnBatchComplete) {
+ doSetProperty("disconnectOnBatchComplete", disconnectOnBatchComplete);
+ return this;
+ }
+ /**
+ * Whether or not to eagerly delete any existing target file. This
+ * option only applies when you use fileExists=Override and the
+ * tempFileName option as well. You can use this to disable (set it to
+ * false) deleting the target file before the temp file is written. For
+ * example you may write big files and want the target file to exists
+ * during the temp file is being written. This ensure the target file is
+ * only deleted until the very last moment, just before the temp file is
+ * being renamed to the target filename. This option is also used to
+ * control whether to delete any existing files when fileExist=Move is
+ * enabled, and an existing file exists. If this option
+ * copyAndDeleteOnRenameFails false, then an exception will be thrown if
+ * an existing file existed, if its true, then the existing file is
+ * deleted before the move operation.
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: true
+ * Group: producer (advanced)
+ *
+ * @param eagerDeleteTargetFile the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointProducerBuilder eagerDeleteTargetFile(
+ boolean eagerDeleteTargetFile) {
+ doSetProperty("eagerDeleteTargetFile", eagerDeleteTargetFile);
+ return this;
+ }
+ /**
+ * Whether or not to eagerly delete any existing target file. This
+ * option only applies when you use fileExists=Override and the
+ * tempFileName option as well. You can use this to disable (set it to
+ * false) deleting the target file before the temp file is written. For
+ * example you may write big files and want the target file to exists
+ * during the temp file is being written. This ensure the target file is
+ * only deleted until the very last moment, just before the temp file is
+ * being renamed to the target filename. This option is also used to
+ * control whether to delete any existing files when fileExist=Move is
+ * enabled, and an existing file exists. If this option
+ * copyAndDeleteOnRenameFails false, then an exception will be thrown if
+ * an existing file existed, if its true, then the existing file is
+ * deleted before the move operation.
+ *
+ * The option will be converted to a <code>boolean</code>
+ * type.
+ *
+ * Default: true
+ * Group: producer (advanced)
+ *
+ * @param eagerDeleteTargetFile the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointProducerBuilder eagerDeleteTargetFile(
+ String eagerDeleteTargetFile) {
+ doSetProperty("eagerDeleteTargetFile", eagerDeleteTargetFile);
+ return this;
+ }
+ /**
+ * Will keep the last modified timestamp from the source file (if any).
+ * Will use the FileConstants.FILE_LAST_MODIFIED header to located the
+ * timestamp. This header can contain either a java.util.Date or long
+ * with the timestamp. If the timestamp exists and the option is enabled
+ * it will set this timestamp on the written file. Note: This option
+ * only applies to the file producer. You cannot use this option with
+ * any of the ftp producers.
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: false
+ * Group: producer (advanced)
+ *
+ * @param keepLastModified the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointProducerBuilder keepLastModified(
+ boolean keepLastModified) {
+ doSetProperty("keepLastModified", keepLastModified);
+ return this;
+ }
+ /**
+ * Will keep the last modified timestamp from the source file (if any).
+ * Will use the FileConstants.FILE_LAST_MODIFIED header to located the
+ * timestamp. This header can contain either a java.util.Date or long
+ * with the timestamp. If the timestamp exists and the option is enabled
+ * it will set this timestamp on the written file. Note: This option
+ * only applies to the file producer. You cannot use this option with
+ * any of the ftp producers.
+ *
+ * The option will be converted to a <code>boolean</code>
+ * type.
+ *
+ * Default: false
+ * Group: producer (advanced)
+ *
+ * @param keepLastModified the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointProducerBuilder keepLastModified(
+ String keepLastModified) {
+ doSetProperty("keepLastModified", keepLastModified);
+ return this;
+ }
+ /**
+ * 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 starting the
+ * producer may take a little time and prolong the total processing time
+ * of the processing.
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: false
+ * Group: producer (advanced)
+ *
+ * @param lazyStartProducer the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointProducerBuilder lazyStartProducer(
+ boolean lazyStartProducer) {
+ doSetProperty("lazyStartProducer", lazyStartProducer);
+ return this;
+ }
+ /**
+ * 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 starting the
+ * producer may take a little time and prolong the total processing time
+ * of the processing.
+ *
+ * The option will be converted to a <code>boolean</code>
+ * type.
+ *
+ * Default: false
+ * Group: producer (advanced)
+ *
+ * @param lazyStartProducer the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointProducerBuilder lazyStartProducer(
+ String lazyStartProducer) {
+ doSetProperty("lazyStartProducer", lazyStartProducer);
+ return this;
+ }
+ /**
+ * Strategy (Custom Strategy) used to move file with special naming
+ * token to use when fileExist=Move is configured. By default, there is
+ * an implementation used if no custom strategy is provided.
+ *
+ * The option is a:
+ * <code>org.apache.camel.component.file.strategy.FileMoveExistingStrategy</code> type.
+ *
+ * Group: producer (advanced)
+ *
+ * @param moveExistingFileStrategy the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointProducerBuilder moveExistingFileStrategy(
+ org.apache.camel.component.file.strategy.FileMoveExistingStrategy moveExistingFileStrategy) {
+ doSetProperty("moveExistingFileStrategy", moveExistingFileStrategy);
+ return this;
+ }
+ /**
+ * Strategy (Custom Strategy) used to move file with special naming
+ * token to use when fileExist=Move is configured. By default, there is
+ * an implementation used if no custom strategy is provided.
+ *
+ * The option will be converted to a
+ * <code>org.apache.camel.component.file.strategy.FileMoveExistingStrategy</code> type.
+ *
+ * Group: producer (advanced)
+ *
+ * @param moveExistingFileStrategy the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointProducerBuilder moveExistingFileStrategy(
+ String moveExistingFileStrategy) {
+ doSetProperty("moveExistingFileStrategy", moveExistingFileStrategy);
+ return this;
+ }
+ /**
+ * Automatically create missing directories in the file's pathname. For
+ * the file consumer, that means creating the starting directory. For
+ * the file producer, it means the directory the files should be written
+ * to.
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: true
+ * Group: advanced
+ *
+ * @param autoCreate the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointProducerBuilder autoCreate(
+ boolean autoCreate) {
+ doSetProperty("autoCreate", autoCreate);
+ return this;
+ }
+ /**
+ * Automatically create missing directories in the file's pathname. For
+ * the file consumer, that means creating the starting directory. For
+ * the file producer, it means the directory the files should be written
+ * to.
+ *
+ * The option will be converted to a <code>boolean</code>
+ * type.
+ *
+ * Default: true
+ * Group: advanced
+ *
+ * @param autoCreate the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointProducerBuilder autoCreate(
+ String autoCreate) {
+ doSetProperty("autoCreate", autoCreate);
+ return this;
+ }
+ /**
+ * Sets the connect timeout for waiting for a connection to be
+ * established Used by both FTPClient and JSCH.
+ *
+ * The option is a: <code>int</code> type.
+ *
+ * Default: 10000
+ * Group: advanced
+ *
+ * @param connectTimeout the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointProducerBuilder connectTimeout(
+ int connectTimeout) {
+ doSetProperty("connectTimeout", connectTimeout);
+ return this;
+ }
+ /**
+ * Sets the connect timeout for waiting for a connection to be
+ * established Used by both FTPClient and JSCH.
+ *
+ * The option will be converted to a <code>int</code> type.
+ *
+ * Default: 10000
+ * Group: advanced
+ *
+ * @param connectTimeout the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointProducerBuilder connectTimeout(
+ String connectTimeout) {
+ doSetProperty("connectTimeout", connectTimeout);
+ return this;
+ }
+ /**
+ * Specifies the maximum reconnect attempts Camel performs when it tries
+ * to connect to the remote FTP server. Use 0 to disable this behavior.
+ *
+ * The option is a: <code>int</code> type.
+ *
+ * Group: advanced
+ *
+ * @param maximumReconnectAttempts the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointProducerBuilder maximumReconnectAttempts(
+ int maximumReconnectAttempts) {
+ doSetProperty("maximumReconnectAttempts", maximumReconnectAttempts);
+ return this;
+ }
+ /**
+ * Specifies the maximum reconnect attempts Camel performs when it tries
+ * to connect to the remote FTP server. Use 0 to disable this behavior.
+ *
+ * The option will be converted to a <code>int</code> type.
+ *
+ * Group: advanced
+ *
+ * @param maximumReconnectAttempts the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointProducerBuilder maximumReconnectAttempts(
+ String maximumReconnectAttempts) {
+ doSetProperty("maximumReconnectAttempts", maximumReconnectAttempts);
+ return this;
+ }
+ /**
+ * Delay in millis Camel will wait before performing a reconnect
+ * attempt.
+ *
+ * The option is a: <code>long</code> type.
+ *
+ * Default: 1000
+ * Group: advanced
+ *
+ * @param reconnectDelay the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointProducerBuilder reconnectDelay(
+ long reconnectDelay) {
+ doSetProperty("reconnectDelay", reconnectDelay);
+ return this;
+ }
+ /**
+ * Delay in millis Camel will wait before performing a reconnect
+ * attempt.
+ *
+ * The option will be converted to a <code>long</code> type.
+ *
+ * Default: 1000
+ * Group: advanced
+ *
+ * @param reconnectDelay the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointProducerBuilder reconnectDelay(
+ String reconnectDelay) {
+ doSetProperty("reconnectDelay", reconnectDelay);
+ return this;
+ }
+ /**
+ * Should an exception be thrown if connection failed (exhausted)By
+ * default exception is not thrown and a WARN is logged. You can use
+ * this to enable exception being thrown and handle the thrown exception
+ * from the org.apache.camel.spi.PollingConsumerPollStrategy rollback
+ * method.
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: false
+ * Group: advanced
+ *
+ * @param throwExceptionOnConnectFailed the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointProducerBuilder throwExceptionOnConnectFailed(
+ boolean throwExceptionOnConnectFailed) {
+ doSetProperty("throwExceptionOnConnectFailed", throwExceptionOnConnectFailed);
+ return this;
+ }
+ /**
+ * Should an exception be thrown if connection failed (exhausted)By
+ * default exception is not thrown and a WARN is logged. You can use
+ * this to enable exception being thrown and handle the thrown exception
+ * from the org.apache.camel.spi.PollingConsumerPollStrategy rollback
+ * method.
+ *
+ * The option will be converted to a <code>boolean</code>
+ * type.
+ *
+ * Default: false
+ * Group: advanced
+ *
+ * @param throwExceptionOnConnectFailed the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointProducerBuilder throwExceptionOnConnectFailed(
+ String throwExceptionOnConnectFailed) {
+ doSetProperty("throwExceptionOnConnectFailed", throwExceptionOnConnectFailed);
+ return this;
+ }
+ /**
+ * Sets the data timeout for waiting for reply Used only by FTPClient.
+ *
+ * The option is a: <code>int</code> type.
+ *
+ * Default: 30000
+ * Group: advanced
+ *
+ * @param timeout the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointProducerBuilder timeout(int timeout) {
+ doSetProperty("timeout", timeout);
+ return this;
+ }
+ /**
+ * Sets the data timeout for waiting for reply Used only by FTPClient.
+ *
+ * The option will be converted to a <code>int</code> type.
+ *
+ * Default: 30000
+ * Group: advanced
+ *
+ * @param timeout the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointProducerBuilder timeout(String timeout) {
+ doSetProperty("timeout", timeout);
+ return this;
+ }
+ }
+
+ /**
+ * Builder for endpoint for the Azure Files component.
+ */
+ public interface FilesEndpointBuilder
+ extends
+ FilesEndpointConsumerBuilder,
+ FilesEndpointProducerBuilder {
+ default AdvancedFilesEndpointBuilder advanced() {
+ return (AdvancedFilesEndpointBuilder) this;
+ }
+ /**
+ * 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.
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: false
+ * Group: common
+ *
+ * @param disconnect the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointBuilder disconnect(boolean disconnect) {
+ doSetProperty("disconnect", disconnect);
+ return this;
+ }
+ /**
+ * 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.
+ *
+ * The option will be converted to a <code>boolean</code>
+ * type.
+ *
+ * Default: false
+ * Group: common
+ *
+ * @param disconnect the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointBuilder disconnect(String disconnect) {
+ doSetProperty("disconnect", disconnect);
+ return this;
+ }
+ /**
+ * 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 can specify
+ * a fixed name. Or you can use dynamic placeholders.The done file is
+ * always expected in the same folder as the original file. Only
+ * ${file.name} and ${file.name.next} is supported as dynamic
+ * placeholders.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: common
+ *
+ * @param doneFileName the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointBuilder doneFileName(String doneFileName) {
+ doSetProperty("doneFileName", doneFileName);
+ return this;
+ }
+ /**
+ * Use Expression such as File Language to dynamically set the filename.
+ * For consumers, it's used as a filename filter. For producers, it's
+ * used to evaluate the filename to write. If an expression is set, it
+ * take precedence over the CamelFileName header. (Note: The header
+ * itself can also be an Expression). The expression options support
+ * both String and Expression types. If the expression is a String type,
+ * it is always evaluated using the File Language. If the expression is
+ * an Expression type, the specified Expression type is used - this
+ * allows you, for instance, to use OGNL expressions. For the consumer,
+ * you can use it to filter filenames, so you can for instance consume
+ * today's file using the File Language syntax:
+ * mydata-${date:now:yyyyMMdd}.txt. The producers support the
+ * CamelOverruleFileName header which takes precedence over any existing
+ * CamelFileName header; the CamelOverruleFileName is a header that is
+ * used only once, and makes it easier as this avoids to temporary store
+ * CamelFileName and have to restore it afterwards.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: common
+ *
+ * @param fileName the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointBuilder fileName(String fileName) {
+ doSetProperty("fileName", fileName);
+ return this;
+ }
+ /**
+ * part of service SAS token.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: both
+ *
+ * @param sdd the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointBuilder sdd(String sdd) {
+ doSetProperty("sdd", sdd);
+ return this;
+ }
+ /**
+ * part of SAS token.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: both
+ *
+ * @param se the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointBuilder se(String se) {
+ doSetProperty("se", se);
+ return this;
+ }
+ /**
+ * Shared key (storage account key).
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: both
+ *
+ * @param sharedKey the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointBuilder sharedKey(String sharedKey) {
+ doSetProperty("sharedKey", sharedKey);
+ return this;
+ }
+ /**
+ * part of service SAS token.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: both
+ *
+ * @param si the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointBuilder si(String si) {
+ doSetProperty("si", si);
+ return this;
+ }
+ /**
+ * part of SAS token.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: both
+ *
+ * @param sig the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointBuilder sig(String sig) {
+ doSetProperty("sig", sig);
+ return this;
+ }
+ /**
+ * part of SAS token.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: both
+ *
+ * @param sip the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointBuilder sip(String sip) {
+ doSetProperty("sip", sip);
+ return this;
+ }
+ /**
+ * part of SAS token.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: both
+ *
+ * @param sp the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointBuilder sp(String sp) {
+ doSetProperty("sp", sp);
+ return this;
+ }
+ /**
+ * part of SAS token.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: both
+ *
+ * @param spr the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointBuilder spr(String spr) {
+ doSetProperty("spr", spr);
+ return this;
+ }
+ /**
+ * part of service SAS token.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: both
+ *
+ * @param sr the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointBuilder sr(String sr) {
+ doSetProperty("sr", sr);
+ return this;
+ }
+ /**
+ * part of SAS token.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: both
+ *
+ * @param srt the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointBuilder srt(String srt) {
+ doSetProperty("srt", srt);
+ return this;
+ }
+ /**
+ * part of account SAS token.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: both
+ *
+ * @param ss the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointBuilder ss(String ss) {
+ doSetProperty("ss", ss);
+ return this;
+ }
+ /**
+ * part of SAS token.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: both
+ *
+ * @param st the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointBuilder st(String st) {
+ doSetProperty("st", st);
+ return this;
+ }
+ /**
+ * part of SAS token.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: both
+ *
+ * @param sv the value to set
+ * @return the dsl builder
+ */
+ default FilesEndpointBuilder sv(String sv) {
+ doSetProperty("sv", sv);
+ return this;
+ }
+ }
+
+ /**
+ * Advanced builder for endpoint for the Azure Files component.
+ */
+ public interface AdvancedFilesEndpointBuilder
+ extends
+ AdvancedFilesEndpointConsumerBuilder,
+ AdvancedFilesEndpointProducerBuilder {
+ default FilesEndpointBuilder basic() {
+ return (FilesEndpointBuilder) this;
+ }
+ /**
+ * Automatically create missing directories in the file's pathname. For
+ * the file consumer, that means creating the starting directory. For
+ * the file producer, it means the directory the files should be written
+ * to.
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: true
+ * Group: advanced
+ *
+ * @param autoCreate the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointBuilder autoCreate(boolean autoCreate) {
+ doSetProperty("autoCreate", autoCreate);
+ return this;
+ }
+ /**
+ * Automatically create missing directories in the file's pathname. For
+ * the file consumer, that means creating the starting directory. For
+ * the file producer, it means the directory the files should be written
+ * to.
+ *
+ * The option will be converted to a <code>boolean</code>
+ * type.
+ *
+ * Default: true
+ * Group: advanced
+ *
+ * @param autoCreate the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointBuilder autoCreate(String autoCreate) {
+ doSetProperty("autoCreate", autoCreate);
+ return this;
+ }
+ /**
+ * Sets the connect timeout for waiting for a connection to be
+ * established Used by both FTPClient and JSCH.
+ *
+ * The option is a: <code>int</code> type.
+ *
+ * Default: 10000
+ * Group: advanced
+ *
+ * @param connectTimeout the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointBuilder connectTimeout(int connectTimeout) {
+ doSetProperty("connectTimeout", connectTimeout);
+ return this;
+ }
+ /**
+ * Sets the connect timeout for waiting for a connection to be
+ * established Used by both FTPClient and JSCH.
+ *
+ * The option will be converted to a <code>int</code> type.
+ *
+ * Default: 10000
+ * Group: advanced
+ *
+ * @param connectTimeout the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointBuilder connectTimeout(
+ String connectTimeout) {
+ doSetProperty("connectTimeout", connectTimeout);
+ return this;
+ }
+ /**
+ * Specifies the maximum reconnect attempts Camel performs when it tries
+ * to connect to the remote FTP server. Use 0 to disable this behavior.
+ *
+ * The option is a: <code>int</code> type.
+ *
+ * Group: advanced
+ *
+ * @param maximumReconnectAttempts the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointBuilder maximumReconnectAttempts(
+ int maximumReconnectAttempts) {
+ doSetProperty("maximumReconnectAttempts", maximumReconnectAttempts);
+ return this;
+ }
+ /**
+ * Specifies the maximum reconnect attempts Camel performs when it tries
+ * to connect to the remote FTP server. Use 0 to disable this behavior.
+ *
+ * The option will be converted to a <code>int</code> type.
+ *
+ * Group: advanced
+ *
+ * @param maximumReconnectAttempts the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointBuilder maximumReconnectAttempts(
+ String maximumReconnectAttempts) {
+ doSetProperty("maximumReconnectAttempts", maximumReconnectAttempts);
+ return this;
+ }
+ /**
+ * Delay in millis Camel will wait before performing a reconnect
+ * attempt.
+ *
+ * The option is a: <code>long</code> type.
+ *
+ * Default: 1000
+ * Group: advanced
+ *
+ * @param reconnectDelay the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointBuilder reconnectDelay(long reconnectDelay) {
+ doSetProperty("reconnectDelay", reconnectDelay);
+ return this;
+ }
+ /**
+ * Delay in millis Camel will wait before performing a reconnect
+ * attempt.
+ *
+ * The option will be converted to a <code>long</code> type.
+ *
+ * Default: 1000
+ * Group: advanced
+ *
+ * @param reconnectDelay the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointBuilder reconnectDelay(
+ String reconnectDelay) {
+ doSetProperty("reconnectDelay", reconnectDelay);
+ return this;
+ }
+ /**
+ * Should an exception be thrown if connection failed (exhausted)By
+ * default exception is not thrown and a WARN is logged. You can use
+ * this to enable exception being thrown and handle the thrown exception
+ * from the org.apache.camel.spi.PollingConsumerPollStrategy rollback
+ * method.
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: false
+ * Group: advanced
+ *
+ * @param throwExceptionOnConnectFailed the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointBuilder throwExceptionOnConnectFailed(
+ boolean throwExceptionOnConnectFailed) {
+ doSetProperty("throwExceptionOnConnectFailed", throwExceptionOnConnectFailed);
+ return this;
+ }
+ /**
+ * Should an exception be thrown if connection failed (exhausted)By
+ * default exception is not thrown and a WARN is logged. You can use
+ * this to enable exception being thrown and handle the thrown exception
+ * from the org.apache.camel.spi.PollingConsumerPollStrategy rollback
+ * method.
+ *
+ * The option will be converted to a <code>boolean</code>
+ * type.
+ *
+ * Default: false
+ * Group: advanced
+ *
+ * @param throwExceptionOnConnectFailed the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointBuilder throwExceptionOnConnectFailed(
+ String throwExceptionOnConnectFailed) {
+ doSetProperty("throwExceptionOnConnectFailed", throwExceptionOnConnectFailed);
+ return this;
+ }
+ /**
+ * Sets the data timeout for waiting for reply Used only by FTPClient.
+ *
+ * The option is a: <code>int</code> type.
+ *
+ * Default: 30000
+ * Group: advanced
+ *
+ * @param timeout the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointBuilder timeout(int timeout) {
+ doSetProperty("timeout", timeout);
+ return this;
+ }
+ /**
+ * Sets the data timeout for waiting for reply Used only by FTPClient.
+ *
+ * The option will be converted to a <code>int</code> type.
+ *
+ * Default: 30000
+ * Group: advanced
+ *
+ * @param timeout the value to set
+ * @return the dsl builder
+ */
+ default AdvancedFilesEndpointBuilder timeout(String timeout) {
+ doSetProperty("timeout", timeout);
+ return this;
+ }
+ }
+
+ public interface FilesBuilders {
+ /**
+ * Azure Files (camel-azure-files)
+ * Camel Azure Files Component
+ *
+ * Category: cloud,file
+ * Since: 3.21
+ * Maven coordinates: org.apache.camel:camel-azure-files
+ *
+ * @return the dsl builder for the headers' name.
+ */
+ default FilesHeaderNameBuilder azureFiles() {
+ return FilesHeaderNameBuilder.INSTANCE;
+ }
+ /**
+ * Azure Files (camel-azure-files)
+ * Camel Azure Files Component
+ *
+ * Category: cloud,file
+ * Since: 3.21
+ * Maven coordinates: org.apache.camel:camel-azure-files
+ *
+ * Syntax: <code>azure-files://account[.host]/share[/dir]</code>
+ *
+ * Path parameter: host (required)
+ * Hostname of the FTP server
+ *
+ * Path parameter: port
+ * Port of the FTP server
+ *
+ * Path parameter: directoryName
+ * The starting directory
+ *
+ * @param path //account[.host]/share[/dir]
+ * @return the dsl builder
+ */
+ default FilesEndpointBuilder azureFiles(String path) {
+ return FilesEndpointBuilderFactory.endpointBuilder("azure-files", path);
+ }
+ /**
+ * Azure Files (camel-azure-files)
+ * Camel Azure Files Component
+ *
+ * Category: cloud,file
+ * Since: 3.21
+ * Maven coordinates: org.apache.camel:camel-azure-files
+ *
+ * Syntax: <code>azure-files://account[.host]/share[/dir]</code>
+ *
+ * Path parameter: host (required)
+ * Hostname of the FTP server
+ *
+ * Path parameter: port
+ * Port of the FTP server
+ *
+ * Path parameter: directoryName
+ * The starting directory
+ *
+ * @param componentName to use a custom component name for the endpoint
+ * instead of the default name
+ * @param path //account[.host]/share[/dir]
+ * @return the dsl builder
+ */
+ default FilesEndpointBuilder azureFiles(
+ String componentName,
+ String path) {
+ return FilesEndpointBuilderFactory.endpointBuilder(componentName, path);
+ }
+ }
+
+ /**
+ * The builder of headers' name for the Azure Files component.
+ */
+ public static class FilesHeaderNameBuilder {
+ /**
+ * The internal instance of the builder used to access to all the
+ * methods representing the name of headers.
+ */
+ private static final FilesHeaderNameBuilder INSTANCE = new FilesHeaderNameBuilder();
+
+ /**
+ * A long value containing the file size. For producer, known length
+ * helps if the body converts to InputStream more efficiently than to
+ * bytes array.
+ *
+ * The option is a: {@code long} type.
+ *
+ * Group: both
+ *
+ * @return the name of the header {@code FileLength}.
+ */
+ public String fileLength() {
+ return "FileLength";
+ }
+
+ /**
+ * A Long value containing the last modified timestamp of the file.
+ *
+ * The option is a: {@code long} type.
+ *
+ * Group: consumer
+ *
+ * @return the name of the header {@code FileLastModified}.
+ */
+ public String fileLastModified() {
+ return "FileLastModified";
+ }
+
+ /**
+ * Specifies the output file name (relative to the endpoint directory)
+ * to be used for the output message when sending to the endpoint. If
+ * this is not present and no expression either, then a generated
+ * message ID is used as the filename instead.
+ *
+ * The option is a: {@code String} type.
+ *
+ * Group: common
+ *
+ * @return the name of the header {@code FileName}.
+ */
+ public String fileName() {
+ return "FileName";
+ }
+
+ /**
+ * Only the file name (the name with no leading paths).
+ *
+ * The option is a: {@code String} type.
+ *
+ * Group: common
+ *
+ * @return the name of the header {@code FileNameOnly}.
+ */
+ public String fileNameOnly() {
+ return "FileNameOnly";
+ }
+
+ /**
+ * The parent path.
+ *
+ * The option is a: {@code String} type.
+ *
+ * Group: common
+ *
+ * @return the name of the header {@code FileParent}.
+ */
+ public String fileParent() {
+ return "FileParent";
+ }
+
+ /**
+ * The remote file input stream.
+ *
+ * The option is a: {@code java.io.InputStream} type.
+ *
+ * Group: common
+ *
+ * @return the name of the header {@code RemoteFileInputStream}.
+ */
+ public String remoteFileInputStream() {
+ return "RemoteFileInputStream";
+ }
+
+ /**
+ * Path to the local work file, if local work directory is used.
+ *
+ * The option is a: {@code String} type.
+ *
+ * Group: common
+ *
+ * @return the name of the header {@code FileLocalWorkPath}.
+ */
+ public String fileLocalWorkPath() {
+ return "FileLocalWorkPath";
+ }
+
+ /**
+ * The remote hostname.
+ *
+ * The option is a: {@code String} type.
+ *
+ * Group: common
+ *
+ * @return the name of the header {@code FileHost}.
+ */
+ public String fileHost() {
+ return "FileHost";
+ }
+ }
+ static FilesEndpointBuilder endpointBuilder(
+ String componentName,
+ String path) {
+ class FilesEndpointBuilderImpl extends AbstractEndpointBuilder implements FilesEndpointBuilder, AdvancedFilesEndpointBuilder {
+ public FilesEndpointBuilderImpl(String path) {
+ super(componentName, path);
+ }
+ }
+ return new FilesEndpointBuilderImpl(path);
+ }
+}
\ No newline at end of file
diff --git a/dsl/camel-kamelet-main/src/generated/resources/camel-component-known-dependencies.properties b/dsl/camel-kamelet-main/src/generated/resources/camel-component-known-dependencies.properties
index 706956f9e15..1fc81ed91e2 100644
--- a/dsl/camel-kamelet-main/src/generated/resources/camel-component-known-dependencies.properties
+++ b/dsl/camel-kamelet-main/src/generated/resources/camel-component-known-dependencies.properties
@@ -108,6 +108,7 @@ org.apache.camel.component.exec.ExecComponent=camel:exec
org.apache.camel.component.facebook.FacebookComponent=camel:facebook
org.apache.camel.component.fhir.FhirComponent=camel:fhir
org.apache.camel.component.file.FileComponent=camel:file
+org.apache.camel.component.file.azure.FilesComponent=camel:azure-files
org.apache.camel.component.file.remote.FtpComponent=camel:ftp
org.apache.camel.component.file.remote.FtpsComponent=camel:ftp
org.apache.camel.component.file.remote.SftpComponent=camel:ftp