This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/main by this push:
new d72dda5b893 CAMEL-21352: Add more header constants to smb component.
d72dda5b893 is described below
commit d72dda5b89316baab65f3825add7174d259ef168
Author: Claus Ibsen <claus.ib...@gmail.com>
AuthorDate: Sat Jan 4 19:09:55 2025 +0100
CAMEL-21352: Add more header constants to smb component.
---
.../org/apache/camel/catalog/components/file.json | 6 +-
.../org/apache/camel/catalog/components/smb.json | 17 ++
.../org/apache/camel/component/file/file.json | 6 +-
.../apache/camel/component/file/FileConstants.java | 50 +++--
.../camel/component/file/remote/FtpConstants.java | 8 +-
.../org/apache/camel/component/smb/smb.json | 17 ++
.../apache/camel/component/smb/SmbConstants.java | 54 ++++-
.../apache/camel/component/smb/SmbEndpoint.java | 2 +-
.../endpoint/dsl/FileEndpointBuilderFactory.java | 18 +-
.../endpoint/dsl/SmbEndpointBuilderFactory.java | 223 +++++++++++++++++++++
10 files changed, 351 insertions(+), 50 deletions(-)
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/file.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/file.json
index 7f4d6b0ec65..85b61708ab4 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/file.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/file.json
@@ -34,14 +34,14 @@
"CamelFileLength": { "index": 0, "kind": "header", "displayName": "",
"group": "consumer", "label": "consumer", "required": false, "javaType":
"long", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "A long value containing the file size.",
"constantName": "org.apache.camel.component.file.FileConstants#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.FileConstants#FILE_LAST_MODIFIED" },
"CamelFileLocalWorkPath": { "index": 2, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"File", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "The local work path", "constantName":
"org.apache.camel.component.file.FileConstants#FILE_LOCAL_WORK_PATH" },
- "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.FileConstants#FILE_NAME_ONLY"
},
- "CamelFileName": { "index": 4, "kind": "header", "displayName": "",
"group": "common", "label": "", "required": false, "javaType": "String",
"deprecated": false, "deprecationNote": "", "autowired": false, "secret":
false, "description": "(producer) Specifies the name of the file to write
(relative to the endpoint directory). This name can be a String; a String with
a xref:languages:file-language.adocFile Language or
xref:languages:simple-language.adocSimple expression; or an Expressi [...]
+ "CamelFileNameOnly": { "index": 3, "kind": "header", "displayName": "",
"group": "consumer", "label": "consumer", "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.FileConstants#FILE_NAME_ONLY" },
+ "CamelFileName": { "index": 4, "kind": "header", "displayName": "",
"group": "common", "label": "", "required": false, "javaType": "String",
"deprecated": false, "deprecationNote": "", "autowired": false, "secret":
false, "description": "(producer) Specifies the name of the file to write
(relative to the endpoint directory). This name can be a String; a String with
a file or simple Language expression; or an Expression object. If it's null
then Camel will auto-generate a filename bas [...]
"CamelFileNameConsumed": { "index": 5, "kind": "header", "displayName":
"", "group": "consumer", "label": "consumer", "required": false, "javaType":
"String", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "The name of the file that has been consumed",
"constantName":
"org.apache.camel.component.file.FileConstants#FILE_NAME_CONSUMED" },
"CamelFileAbsolute": { "index": 6, "kind": "header", "displayName": "",
"group": "consumer", "label": "consumer", "required": false, "javaType":
"Boolean", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "A boolean option specifying whether the
consumed file denotes an absolute path or not. Should normally be false for
relative paths. Absolute paths should normally not be used but we added to the
move option to allow moving files to abs [...]
"CamelFileAbsolutePath": { "index": 7, "kind": "header", "displayName":
"", "group": "consumer", "label": "consumer", "required": false, "javaType":
"String", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "The absolute path to the file. For relative
files this path holds the relative path instead.", "constantName":
"org.apache.camel.component.file.FileConstants#FILE_ABSOLUTE_PATH" },
"CamelFileExtendedAttributes": { "index": 8, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "Map<String, Object>", "deprecated": false, "deprecationNote": "",
"autowired": false, "secret": false, "description": "The extended attributes of
the file", "constantName":
"org.apache.camel.component.file.FileConstants#FILE_EXTENDED_ATTRIBUTES" },
"CamelFileContentType": { "index": 9, "kind": "header", "displayName": "",
"group": "consumer", "label": "consumer", "required": false, "javaType":
"String", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "The content type of the file", "constantName":
"org.apache.camel.component.file.FileConstants#FILE_CONTENT_TYPE" },
- "CamelFilePath": { "index": 10, "kind": "header", "displayName": "",
"group": "consumer", "label": "consumer", "required": false, "javaType":
"String", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "The file path. For relative files this is the
starting directory the relative filename. For absolute files this is the
absolute path.", "constantName":
"org.apache.camel.component.file.FileConstants#FILE_PATH" },
+ "CamelFilePath": { "index": 10, "kind": "header", "displayName": "",
"group": "consumer", "label": "consumer", "required": false, "javaType":
"String", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "The file path. For relative files this is the
starting directory. For absolute files this is the absolute path.",
"constantName": "org.apache.camel.component.file.FileConstants#FILE_PATH" },
"CamelFileRelativePath": { "index": 11, "kind": "header", "displayName":
"", "group": "consumer", "label": "consumer", "required": false, "javaType":
"String", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "The relative path.", "constantName":
"org.apache.camel.component.file.FileConstants#FILE_RELATIVE_PATH" },
"CamelFileParent": { "index": 12, "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.FileConstants#FILE_PARENT" },
"CamelFileNameProduced": { "index": 13, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "The actual absolute filepath (path name) for
the output file that was written. This header is set by Camel and its purpose
is providing end-users with the name of the file that was written.",
"constantName": "org.apache.camel.compo [...]
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/smb.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/smb.json
index 71598867a4f..b54769811c1 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/smb.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/smb.json
@@ -30,6 +30,23 @@
"healthCheckConsumerEnabled": { "index": 3, "kind": "property",
"displayName": "Health Check Consumer Enabled", "group": "health", "label":
"health", "required": false, "type": "boolean", "javaType": "boolean",
"deprecated": false, "autowired": false, "secret": false, "defaultValue": true,
"description": "Used for enabling or disabling all consumer based health checks
from this component" },
"healthCheckProducerEnabled": { "index": 4, "kind": "property",
"displayName": "Health Check Producer Enabled", "group": "health", "label":
"health", "required": false, "type": "boolean", "javaType": "boolean",
"deprecated": false, "autowired": false, "secret": false, "defaultValue": true,
"description": "Used for enabling or disabling all producer based health checks
from this component. Notice: Camel has by default disabled all producer based
health-checks. You can turn on producer [...]
},
+ "headers": {
+ "CamelFileLength": { "index": 0, "kind": "header", "displayName": "",
"group": "consumer", "label": "consumer", "required": false, "javaType":
"long", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "A long value containing the file size.",
"constantName": "org.apache.camel.component.smb.SmbConstants#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.smb.SmbConstants#FILE_LAST_MODIFIED" },
+ "CamelFileNameOnly": { "index": 2, "kind": "header", "displayName": "",
"group": "consumer", "label": "consumer", "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.smb.SmbConstants#FILE_NAME_ONLY" },
+ "CamelFileName": { "index": 3, "kind": "header", "displayName": "",
"group": "common", "label": "", "required": false, "javaType": "String",
"deprecated": false, "deprecationNote": "", "autowired": false, "secret":
false, "description": "(producer) Specifies the name of the file to write
(relative to the endpoint directory). This name can be a String; a String with
a file or simple Language expression; or an Expression object. If it's null
then Camel will auto-generate a filename bas [...]
+ "CamelFileNameConsumed": { "index": 4, "kind": "header", "displayName":
"", "group": "consumer", "label": "consumer", "required": false, "javaType":
"String", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "The name of the file that has been consumed",
"constantName":
"org.apache.camel.component.smb.SmbConstants#FILE_NAME_CONSUMED" },
+ "CamelFileAbsolute": { "index": 5, "kind": "header", "displayName": "",
"group": "consumer", "label": "consumer", "required": false, "javaType":
"Boolean", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "A boolean option specifying whether the
consumed file denotes an absolute path or not. Should normally be false for
relative paths. Absolute paths should normally not be used but we added to the
move option to allow moving files to abs [...]
+ "CamelFileAbsolutePath": { "index": 6, "kind": "header", "displayName":
"", "group": "consumer", "label": "consumer", "required": false, "javaType":
"String", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "The absolute path to the file. For relative
files this path holds the relative path instead.", "constantName":
"org.apache.camel.component.smb.SmbConstants#FILE_ABSOLUTE_PATH" },
+ "CamelFilePath": { "index": 7, "kind": "header", "displayName": "",
"group": "consumer", "label": "consumer", "required": false, "javaType":
"String", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "The file path. For relative files this is the
starting directory. For absolute files this is the absolute path.",
"constantName": "org.apache.camel.component.smb.SmbConstants#FILE_PATH" },
+ "CamelFileRelativePath": { "index": 8, "kind": "header", "displayName":
"", "group": "consumer", "label": "consumer", "required": false, "javaType":
"String", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "The relative path.", "constantName":
"org.apache.camel.component.smb.SmbConstants#FILE_RELATIVE_PATH" },
+ "CamelFileParent": { "index": 9, "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.smb.SmbConstants#FILE_PARENT" },
+ "CamelFileNameProduced": { "index": 10, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "The actual absolute filepath (path name) for
the output file that was written. This header is set by Camel and its purpose
is providing end-users with the name of the file that was written.",
"constantName": "org.apache.camel.compo [...]
+ "CamelOverruleFileName": { "index": 11, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"Object", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "Is used for overruling CamelFileName header
and use the value instead (but only once, as the producer will remove this
header after writing the file). The value can be only be a String. Notice that
if the option fileName has been c [...]
+ "CamelFileHost": { "index": 12, "kind": "header", "displayName": "",
"group": "consumer", "label": "consumer", "required": false, "javaType":
"String", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "The remote hostname.", "constantName":
"org.apache.camel.component.smb.SmbConstants#FILE_HOST" },
+ "CamelFileLocalWorkPath": { "index": 13, "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.smb.SmbConstants#FILE_LOCAL_WORK_PATH" },
+ "CamelSmbFileExists": { "index": 14, "kind": "header", "displayName": "",
"group": "producer", "label": "producer", "required": false, "javaType":
"org.apache.camel.component.file.GenericFileExist", "enum": [ "Override",
"Append", "Fail", "Ignore", "Move", "TryRename" ], "deprecated": true,
"deprecationNote": "", "autowired": false, "secret": false, "description": "The
expected behavior if the file already exists.", "constantName":
"org.apache.camel.component.smb.SmbConstants#SMB_FIL [...]
+ },
"properties": {
"hostname": { "index": 0, "kind": "path", "displayName": "Hostname",
"group": "common", "label": "", "required": true, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.smb.SmbConfiguration", "configurationField":
"configuration", "description": "The share hostname or IP address" },
"port": { "index": 1, "kind": "path", "displayName": "Port", "group":
"common", "label": "", "required": false, "type": "integer", "javaType": "int",
"deprecated": false, "autowired": false, "secret": false, "defaultValue": 445,
"configurationClass": "org.apache.camel.component.smb.SmbConfiguration",
"configurationField": "configuration", "description": "The share port number" },
diff --git
a/components/camel-file/src/generated/resources/META-INF/org/apache/camel/component/file/file.json
b/components/camel-file/src/generated/resources/META-INF/org/apache/camel/component/file/file.json
index 7f4d6b0ec65..85b61708ab4 100644
---
a/components/camel-file/src/generated/resources/META-INF/org/apache/camel/component/file/file.json
+++
b/components/camel-file/src/generated/resources/META-INF/org/apache/camel/component/file/file.json
@@ -34,14 +34,14 @@
"CamelFileLength": { "index": 0, "kind": "header", "displayName": "",
"group": "consumer", "label": "consumer", "required": false, "javaType":
"long", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "A long value containing the file size.",
"constantName": "org.apache.camel.component.file.FileConstants#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.FileConstants#FILE_LAST_MODIFIED" },
"CamelFileLocalWorkPath": { "index": 2, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"File", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "The local work path", "constantName":
"org.apache.camel.component.file.FileConstants#FILE_LOCAL_WORK_PATH" },
- "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.FileConstants#FILE_NAME_ONLY"
},
- "CamelFileName": { "index": 4, "kind": "header", "displayName": "",
"group": "common", "label": "", "required": false, "javaType": "String",
"deprecated": false, "deprecationNote": "", "autowired": false, "secret":
false, "description": "(producer) Specifies the name of the file to write
(relative to the endpoint directory). This name can be a String; a String with
a xref:languages:file-language.adocFile Language or
xref:languages:simple-language.adocSimple expression; or an Expressi [...]
+ "CamelFileNameOnly": { "index": 3, "kind": "header", "displayName": "",
"group": "consumer", "label": "consumer", "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.FileConstants#FILE_NAME_ONLY" },
+ "CamelFileName": { "index": 4, "kind": "header", "displayName": "",
"group": "common", "label": "", "required": false, "javaType": "String",
"deprecated": false, "deprecationNote": "", "autowired": false, "secret":
false, "description": "(producer) Specifies the name of the file to write
(relative to the endpoint directory). This name can be a String; a String with
a file or simple Language expression; or an Expression object. If it's null
then Camel will auto-generate a filename bas [...]
"CamelFileNameConsumed": { "index": 5, "kind": "header", "displayName":
"", "group": "consumer", "label": "consumer", "required": false, "javaType":
"String", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "The name of the file that has been consumed",
"constantName":
"org.apache.camel.component.file.FileConstants#FILE_NAME_CONSUMED" },
"CamelFileAbsolute": { "index": 6, "kind": "header", "displayName": "",
"group": "consumer", "label": "consumer", "required": false, "javaType":
"Boolean", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "A boolean option specifying whether the
consumed file denotes an absolute path or not. Should normally be false for
relative paths. Absolute paths should normally not be used but we added to the
move option to allow moving files to abs [...]
"CamelFileAbsolutePath": { "index": 7, "kind": "header", "displayName":
"", "group": "consumer", "label": "consumer", "required": false, "javaType":
"String", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "The absolute path to the file. For relative
files this path holds the relative path instead.", "constantName":
"org.apache.camel.component.file.FileConstants#FILE_ABSOLUTE_PATH" },
"CamelFileExtendedAttributes": { "index": 8, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "Map<String, Object>", "deprecated": false, "deprecationNote": "",
"autowired": false, "secret": false, "description": "The extended attributes of
the file", "constantName":
"org.apache.camel.component.file.FileConstants#FILE_EXTENDED_ATTRIBUTES" },
"CamelFileContentType": { "index": 9, "kind": "header", "displayName": "",
"group": "consumer", "label": "consumer", "required": false, "javaType":
"String", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "The content type of the file", "constantName":
"org.apache.camel.component.file.FileConstants#FILE_CONTENT_TYPE" },
- "CamelFilePath": { "index": 10, "kind": "header", "displayName": "",
"group": "consumer", "label": "consumer", "required": false, "javaType":
"String", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "The file path. For relative files this is the
starting directory the relative filename. For absolute files this is the
absolute path.", "constantName":
"org.apache.camel.component.file.FileConstants#FILE_PATH" },
+ "CamelFilePath": { "index": 10, "kind": "header", "displayName": "",
"group": "consumer", "label": "consumer", "required": false, "javaType":
"String", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "The file path. For relative files this is the
starting directory. For absolute files this is the absolute path.",
"constantName": "org.apache.camel.component.file.FileConstants#FILE_PATH" },
"CamelFileRelativePath": { "index": 11, "kind": "header", "displayName":
"", "group": "consumer", "label": "consumer", "required": false, "javaType":
"String", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "The relative path.", "constantName":
"org.apache.camel.component.file.FileConstants#FILE_RELATIVE_PATH" },
"CamelFileParent": { "index": 12, "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.FileConstants#FILE_PARENT" },
"CamelFileNameProduced": { "index": 13, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "The actual absolute filepath (path name) for
the output file that was written. This header is set by Camel and its purpose
is providing end-users with the name of the file that was written.",
"constantName": "org.apache.camel.compo [...]
diff --git
a/components/camel-file/src/main/java/org/apache/camel/component/file/FileConstants.java
b/components/camel-file/src/main/java/org/apache/camel/component/file/FileConstants.java
index 53cb13dba98..f4023690187 100644
---
a/components/camel-file/src/main/java/org/apache/camel/component/file/FileConstants.java
+++
b/components/camel-file/src/main/java/org/apache/camel/component/file/FileConstants.java
@@ -28,53 +28,51 @@ public final class FileConstants {
public static final String FILE_LAST_MODIFIED =
Exchange.FILE_LAST_MODIFIED;
@Metadata(label = "producer", description = "The local work path",
javaType = "File")
public static final String FILE_LOCAL_WORK_PATH =
Exchange.FILE_LOCAL_WORK_PATH;
- @Metadata(description = "Only the file name (the name with no leading
paths).", javaType = "String")
+ @Metadata(label = "consumer", description = "Only the file name (the name
with no leading paths).", javaType = "String")
public static final String FILE_NAME_ONLY = Exchange.FILE_NAME_ONLY;
- @Metadata(description = "(producer) Specifies the name of the file to
write (relative to the endpoint\n" +
- "directory). This name can be a `String`; a
`String` with a\n" +
- "xref:languages:file-language.adoc[File Language]
or xref:languages:simple-language.adoc[Simple]\n"
- +
- "expression; or an Expression object. If it's\n" +
- "`null` then Camel will auto-generate a filename
based on the message\n" +
- "unique ID. (consumer) Name of the consumed file
as a relative file path with offset from the\n" +
- "starting directory configured on the endpoint.",
+ @Metadata(description = "(producer) Specifies the name of the file to
write (relative to the endpoint"
+ + " directory). This name can be a `String`; a
`String` with a"
+ + " file or simple Language expression; or an
Expression object. If it's"
+ + " `null` then Camel will auto-generate a
filename based on the message"
+ + " unique ID. (consumer) Name of the consumed
file as a relative file path with offset from the"
+ + " starting directory configured on the
endpoint.",
javaType = "String")
public static final String FILE_NAME = Exchange.FILE_NAME;
@Metadata(label = "consumer", description = "The name of the file that has
been consumed", javaType = "String")
public static final String FILE_NAME_CONSUMED =
Exchange.FILE_NAME_CONSUMED;
- @Metadata(label = "consumer", description = "A `boolean` option specifying
whether the consumed file denotes an\n" +
- "absolute path or not. Should
normally be `false` for relative paths.\n" +
- "Absolute paths should
normally not be used but we added to the move\n" +
- "option to allow moving files
to absolute paths. But can be used\n" +
- "elsewhere as well.",
+ @Metadata(label = "consumer", description = "A `boolean` option specifying
whether the consumed file denotes an"
+ + " absolute path or not.
Should normally be `false` for relative paths."
+ + " Absolute paths should
normally not be used but we added to the move"
+ + " option to allow moving
files to absolute paths. But can be used"
+ + " elsewhere as well.",
javaType = "Boolean")
public static final String FILE_ABSOLUTE = "CamelFileAbsolute";
- @Metadata(label = "consumer", description = "The absolute path to the
file. For relative files this path holds the\n" +
- "relative path instead.",
+ @Metadata(label = "consumer", description = "The absolute path to the
file. For relative files this path holds the"
+ + " relative path instead.",
javaType = "String")
public static final String FILE_ABSOLUTE_PATH = "CamelFileAbsolutePath";
@Metadata(label = "consumer", description = "The extended attributes of
the file", javaType = "Map<String, Object>")
public static final String FILE_EXTENDED_ATTRIBUTES =
"CamelFileExtendedAttributes";
@Metadata(label = "consumer", description = "The content type of the
file", javaType = "String")
public static final String FILE_CONTENT_TYPE = Exchange.FILE_CONTENT_TYPE;
- @Metadata(label = "consumer", description = "The file path. For relative
files this is the starting directory + the\n" +
- "relative filename. For
absolute files this is the absolute path.",
+ @Metadata(label = "consumer", description = "The file path. For relative
files this is the starting directory."
+ + " For absolute files this is
the absolute path.",
javaType = "String")
public static final String FILE_PATH = Exchange.FILE_PATH;
@Metadata(label = "consumer", description = "The relative path.", javaType
= "String")
public static final String FILE_RELATIVE_PATH = "CamelFileRelativePath";
@Metadata(description = "The parent path.", javaType = "String")
public static final String FILE_PARENT = Exchange.FILE_PARENT;
- @Metadata(label = "producer", description = "The actual absolute filepath
(path + name) for the output file that was\n" +
- "written. This header is set
by Camel and its purpose is providing\n" +
- "end-users with the name of
the file that was written.",
+ @Metadata(label = "producer", description = "The actual absolute filepath
(path + name) for the output file that was"
+ + " written. This header is
set by Camel and its purpose is providing"
+ + " end-users with the name of
the file that was written.",
javaType = "String")
public static final String FILE_NAME_PRODUCED =
Exchange.FILE_NAME_PRODUCED;
- @Metadata(label = "producer", description = "Is used for overruling
`CamelFileName` header and use the\n" +
- "value instead (but only once,
as the producer will remove this header\n" +
- "after writing the file). The
value can be only be a String. Notice that\n" +
- "if the option `fileName` has
been configured, then this is still being\n" +
- "evaluated.",
+ @Metadata(label = "producer", description = "Is used for overruling
`CamelFileName` header and use the"
+ + " value instead (but only
once, as the producer will remove this header"
+ + " after writing the file).
The value can be only be a String. Notice that"
+ + " if the option `fileName`
has been configured, then this is still being"
+ + " evaluated.",
javaType = "Object")
public static final String OVERRULE_FILE_NAME =
Exchange.OVERRULE_FILE_NAME;
diff --git
a/components/camel-ftp/src/main/java/org/apache/camel/component/file/remote/FtpConstants.java
b/components/camel-ftp/src/main/java/org/apache/camel/component/file/remote/FtpConstants.java
index 9d568c88214..33b4687fe81 100644
---
a/components/camel-ftp/src/main/java/org/apache/camel/component/file/remote/FtpConstants.java
+++
b/components/camel-ftp/src/main/java/org/apache/camel/component/file/remote/FtpConstants.java
@@ -29,10 +29,10 @@ public final class FtpConstants {
@Metadata(label = "consumer", description = "A `Long` value containing the
last modified timestamp of the file.",
javaType = "long")
public static final String FILE_LAST_MODIFIED =
Exchange.FILE_LAST_MODIFIED;
- @Metadata(description = "Specifies the output file name (relative to the
endpoint directory) to\n" +
- "be used for the output message when sending to
the endpoint. If this is\n" +
- "not present and no expression either, then a
generated message ID is\n" +
- "used as the filename instead.",
+ @Metadata(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.",
javaType = "String")
public static final String FILE_NAME = Exchange.FILE_NAME;
@Metadata(description = "Only the file name (the name with no leading
paths).", javaType = "String")
diff --git
a/components/camel-smb/src/generated/resources/META-INF/org/apache/camel/component/smb/smb.json
b/components/camel-smb/src/generated/resources/META-INF/org/apache/camel/component/smb/smb.json
index 71598867a4f..b54769811c1 100644
---
a/components/camel-smb/src/generated/resources/META-INF/org/apache/camel/component/smb/smb.json
+++
b/components/camel-smb/src/generated/resources/META-INF/org/apache/camel/component/smb/smb.json
@@ -30,6 +30,23 @@
"healthCheckConsumerEnabled": { "index": 3, "kind": "property",
"displayName": "Health Check Consumer Enabled", "group": "health", "label":
"health", "required": false, "type": "boolean", "javaType": "boolean",
"deprecated": false, "autowired": false, "secret": false, "defaultValue": true,
"description": "Used for enabling or disabling all consumer based health checks
from this component" },
"healthCheckProducerEnabled": { "index": 4, "kind": "property",
"displayName": "Health Check Producer Enabled", "group": "health", "label":
"health", "required": false, "type": "boolean", "javaType": "boolean",
"deprecated": false, "autowired": false, "secret": false, "defaultValue": true,
"description": "Used for enabling or disabling all producer based health checks
from this component. Notice: Camel has by default disabled all producer based
health-checks. You can turn on producer [...]
},
+ "headers": {
+ "CamelFileLength": { "index": 0, "kind": "header", "displayName": "",
"group": "consumer", "label": "consumer", "required": false, "javaType":
"long", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "A long value containing the file size.",
"constantName": "org.apache.camel.component.smb.SmbConstants#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.smb.SmbConstants#FILE_LAST_MODIFIED" },
+ "CamelFileNameOnly": { "index": 2, "kind": "header", "displayName": "",
"group": "consumer", "label": "consumer", "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.smb.SmbConstants#FILE_NAME_ONLY" },
+ "CamelFileName": { "index": 3, "kind": "header", "displayName": "",
"group": "common", "label": "", "required": false, "javaType": "String",
"deprecated": false, "deprecationNote": "", "autowired": false, "secret":
false, "description": "(producer) Specifies the name of the file to write
(relative to the endpoint directory). This name can be a String; a String with
a file or simple Language expression; or an Expression object. If it's null
then Camel will auto-generate a filename bas [...]
+ "CamelFileNameConsumed": { "index": 4, "kind": "header", "displayName":
"", "group": "consumer", "label": "consumer", "required": false, "javaType":
"String", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "The name of the file that has been consumed",
"constantName":
"org.apache.camel.component.smb.SmbConstants#FILE_NAME_CONSUMED" },
+ "CamelFileAbsolute": { "index": 5, "kind": "header", "displayName": "",
"group": "consumer", "label": "consumer", "required": false, "javaType":
"Boolean", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "A boolean option specifying whether the
consumed file denotes an absolute path or not. Should normally be false for
relative paths. Absolute paths should normally not be used but we added to the
move option to allow moving files to abs [...]
+ "CamelFileAbsolutePath": { "index": 6, "kind": "header", "displayName":
"", "group": "consumer", "label": "consumer", "required": false, "javaType":
"String", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "The absolute path to the file. For relative
files this path holds the relative path instead.", "constantName":
"org.apache.camel.component.smb.SmbConstants#FILE_ABSOLUTE_PATH" },
+ "CamelFilePath": { "index": 7, "kind": "header", "displayName": "",
"group": "consumer", "label": "consumer", "required": false, "javaType":
"String", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "The file path. For relative files this is the
starting directory. For absolute files this is the absolute path.",
"constantName": "org.apache.camel.component.smb.SmbConstants#FILE_PATH" },
+ "CamelFileRelativePath": { "index": 8, "kind": "header", "displayName":
"", "group": "consumer", "label": "consumer", "required": false, "javaType":
"String", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "The relative path.", "constantName":
"org.apache.camel.component.smb.SmbConstants#FILE_RELATIVE_PATH" },
+ "CamelFileParent": { "index": 9, "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.smb.SmbConstants#FILE_PARENT" },
+ "CamelFileNameProduced": { "index": 10, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "The actual absolute filepath (path name) for
the output file that was written. This header is set by Camel and its purpose
is providing end-users with the name of the file that was written.",
"constantName": "org.apache.camel.compo [...]
+ "CamelOverruleFileName": { "index": 11, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"Object", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "Is used for overruling CamelFileName header
and use the value instead (but only once, as the producer will remove this
header after writing the file). The value can be only be a String. Notice that
if the option fileName has been c [...]
+ "CamelFileHost": { "index": 12, "kind": "header", "displayName": "",
"group": "consumer", "label": "consumer", "required": false, "javaType":
"String", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "The remote hostname.", "constantName":
"org.apache.camel.component.smb.SmbConstants#FILE_HOST" },
+ "CamelFileLocalWorkPath": { "index": 13, "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.smb.SmbConstants#FILE_LOCAL_WORK_PATH" },
+ "CamelSmbFileExists": { "index": 14, "kind": "header", "displayName": "",
"group": "producer", "label": "producer", "required": false, "javaType":
"org.apache.camel.component.file.GenericFileExist", "enum": [ "Override",
"Append", "Fail", "Ignore", "Move", "TryRename" ], "deprecated": true,
"deprecationNote": "", "autowired": false, "secret": false, "description": "The
expected behavior if the file already exists.", "constantName":
"org.apache.camel.component.smb.SmbConstants#SMB_FIL [...]
+ },
"properties": {
"hostname": { "index": 0, "kind": "path", "displayName": "Hostname",
"group": "common", "label": "", "required": true, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.smb.SmbConfiguration", "configurationField":
"configuration", "description": "The share hostname or IP address" },
"port": { "index": 1, "kind": "path", "displayName": "Port", "group":
"common", "label": "", "required": false, "type": "integer", "javaType": "int",
"deprecated": false, "autowired": false, "secret": false, "defaultValue": 445,
"configurationClass": "org.apache.camel.component.smb.SmbConfiguration",
"configurationField": "configuration", "description": "The share port number" },
diff --git
a/components/camel-smb/src/main/java/org/apache/camel/component/smb/SmbConstants.java
b/components/camel-smb/src/main/java/org/apache/camel/component/smb/SmbConstants.java
index b252cd800ea..4c23152e030 100644
---
a/components/camel-smb/src/main/java/org/apache/camel/component/smb/SmbConstants.java
+++
b/components/camel-smb/src/main/java/org/apache/camel/component/smb/SmbConstants.java
@@ -21,14 +21,62 @@ import org.apache.camel.spi.Metadata;
public class SmbConstants {
- @Metadata(description = "The remote hostname.", javaType = "String")
- public static final String FILE_HOST = "CamelFileHost";
+ @Metadata(label = "consumer", description = "A `long` value containing the
file size.", javaType = "long")
+ public static final String FILE_LENGTH = Exchange.FILE_LENGTH;
+ @Metadata(label = "consumer", description = "A `Long` value containing the
last modified timestamp of the file.",
+ javaType = "long")
+ public static final String FILE_LAST_MODIFIED =
Exchange.FILE_LAST_MODIFIED;
+ @Metadata(label = "consumer", description = "Only the file name (the name
with no leading paths).", javaType = "String")
+ public static final String FILE_NAME_ONLY = Exchange.FILE_NAME_ONLY;
+ @Metadata(description = "(producer) Specifies the name of the file to
write (relative to the endpoint"
+ + " directory). This name can be a `String`; a
`String` with a"
+ + " file or simple Language expression; or an
Expression object. If it's"
+ + " `null` then Camel will auto-generate a
filename based on the message"
+ + " unique ID. (consumer) Name of the consumed
file as a relative file path with offset from the"
+ + " starting directory configured on the
endpoint.",
+ javaType = "String")
+ public static final String FILE_NAME = Exchange.FILE_NAME;
+ @Metadata(label = "consumer", description = "The name of the file that has
been consumed", javaType = "String")
+ public static final String FILE_NAME_CONSUMED =
Exchange.FILE_NAME_CONSUMED;
+ @Metadata(label = "consumer", description = "A `boolean` option specifying
whether the consumed file denotes an"
+ + " absolute path or not.
Should normally be `false` for relative paths."
+ + " Absolute paths should
normally not be used but we added to the move"
+ + " option to allow moving
files to absolute paths. But can be used"
+ + " elsewhere as well.",
+ javaType = "Boolean")
+ public static final String FILE_ABSOLUTE = "CamelFileAbsolute";
+ @Metadata(label = "consumer", description = "The absolute path to the
file. For relative files this path holds the"
+ + " relative path instead.",
+ javaType = "String")
+ public static final String FILE_ABSOLUTE_PATH = "CamelFileAbsolutePath";
+ @Metadata(label = "consumer", description = "The file path. For relative
files this is the starting directory."
+ + " For absolute files this is
the absolute path.",
+ javaType = "String")
+ public static final String FILE_PATH = Exchange.FILE_PATH;
+ @Metadata(label = "consumer", description = "The relative path.", javaType
= "String")
+ public static final String FILE_RELATIVE_PATH = "CamelFileRelativePath";
+ @Metadata(description = "The parent path.", javaType = "String")
+ public static final String FILE_PARENT = Exchange.FILE_PARENT;
+ @Metadata(label = "producer", description = "The actual absolute filepath
(path + name) for the output file that was"
+ + " written. This header is
set by Camel and its purpose is providing"
+ + " end-users with the name of
the file that was written.",
+ javaType = "String")
+ public static final String FILE_NAME_PRODUCED =
Exchange.FILE_NAME_PRODUCED;
+ @Metadata(label = "producer", description = "Is used for overruling
`CamelFileName` header and use the"
+ + " value instead (but only
once, as the producer will remove this header"
+ + " after writing the file).
The value can be only be a String. Notice that"
+ + " if the option `fileName`
has been configured, then this is still being"
+ + " evaluated.",
+ javaType = "Object")
+ public static final String OVERRULE_FILE_NAME =
Exchange.OVERRULE_FILE_NAME;
+ @Metadata(label = "consumer", description = "The remote hostname.",
javaType = "String")
+ public static final String FILE_HOST = "CamelFileHost";
@Metadata(description = "Path to the local work file, if local work
directory is used.", javaType = "String")
public static final String FILE_LOCAL_WORK_PATH =
Exchange.FILE_LOCAL_WORK_PATH;
-
// for backwards compatibility with existing 'file-exists' that uses a
header
@Metadata(label = "producer", description = "The expected behavior if the
file already exists.",
javaType = "org.apache.camel.component.file.GenericFileExist")
+ @Deprecated
public static final String SMB_FILE_EXISTS = "CamelSmbFileExists";
}
diff --git
a/components/camel-smb/src/main/java/org/apache/camel/component/smb/SmbEndpoint.java
b/components/camel-smb/src/main/java/org/apache/camel/component/smb/SmbEndpoint.java
index b2186b880f6..ef102bb160a 100644
---
a/components/camel-smb/src/main/java/org/apache/camel/component/smb/SmbEndpoint.java
+++
b/components/camel-smb/src/main/java/org/apache/camel/component/smb/SmbEndpoint.java
@@ -45,7 +45,7 @@ import org.slf4j.LoggerFactory;
* Read and write files to Server Message Block (SMB) file shares.
*/
@UriEndpoint(firstVersion = "4.3.0", scheme = "smb", title = "SMB", syntax =
"smb:hostname:port/shareName",
- category = { Category.FILE })
+ headersClass = SmbConstants.class, category = { Category.FILE })
@Metadata(excludeProperties =
"appendChars,readLockIdempotentReleaseAsync,readLockIdempotentReleaseAsyncPoolSize,"
+
"readLockIdempotentReleaseDelay,readLockIdempotentReleaseExecutorService,"
+
"directoryMustExist,extendedAttributes,probeContentType,startingDirectoryMustExist,"
diff --git
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/FileEndpointBuilderFactory.java
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/FileEndpointBuilderFactory.java
index bd600724808..f2554cf7865 100644
---
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/FileEndpointBuilderFactory.java
+++
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/FileEndpointBuilderFactory.java
@@ -4025,7 +4025,7 @@ public interface FileEndpointBuilderFactory {
*
* The option is a: {@code String} type.
*
- * Group: common
+ * Group: consumer
*
* @return the name of the header {@code FileNameOnly}.
*/
@@ -4034,13 +4034,11 @@ public interface FileEndpointBuilderFactory {
}
/**
* (producer) Specifies the name of the file to write (relative to the
- * endpoint directory). This name can be a String; a String with a
- * xref:languages:file-language.adocFile Language or
- * xref:languages:simple-language.adocSimple expression; or an
- * Expression object. If it's null then Camel will auto-generate a
- * filename based on the message unique ID. (consumer) Name of the
- * consumed file as a relative file path with offset from the starting
- * directory configured on the endpoint.
+ * endpoint directory). This name can be a String; a String with a file
+ * or simple Language expression; or an Expression object. If it's null
+ * then Camel will auto-generate a filename based on the message unique
+ * ID. (consumer) Name of the consumed file as a relative file path
with
+ * offset from the starting directory configured on the endpoint.
*
* The option is a: {@code String} type.
*
@@ -4117,8 +4115,8 @@ public interface FileEndpointBuilderFactory {
return "CamelFileContentType";
}
/**
- * The file path. For relative files this is the starting directory the
- * relative filename. For absolute files this is the absolute path.
+ * The file path. For relative files this is the starting directory.
For
+ * absolute files this is the absolute path.
*
* The option is a: {@code String} type.
*
diff --git
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/SmbEndpointBuilderFactory.java
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/SmbEndpointBuilderFactory.java
index 2f41586e864..7e2f8e4396c 100644
---
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/SmbEndpointBuilderFactory.java
+++
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/SmbEndpointBuilderFactory.java
@@ -3335,6 +3335,19 @@ public interface SmbEndpointBuilderFactory {
}
public interface SmbBuilders {
+ /**
+ * SMB (camel-smb)
+ * Read and write files to Server Message Block (SMB) file shares.
+ *
+ * Category: file
+ * Since: 4.3
+ * Maven coordinates: org.apache.camel:camel-smb
+ *
+ * @return the dsl builder for the headers' name.
+ */
+ default SmbHeaderNameBuilder smb() {
+ return SmbHeaderNameBuilder.INSTANCE;
+ }
/**
* SMB (camel-smb)
* Read and write files to Server Message Block (SMB) file shares.
@@ -3391,6 +3404,216 @@ public interface SmbEndpointBuilderFactory {
}
}
+ /**
+ * The builder of headers' name for the SMB component.
+ */
+ public static class SmbHeaderNameBuilder {
+ /**
+ * The internal instance of the builder used to access to all the
+ * methods representing the name of headers.
+ */
+ private static final SmbHeaderNameBuilder INSTANCE = new
SmbHeaderNameBuilder();
+
+ /**
+ * A long value containing the file size.
+ *
+ * The option is a: {@code long} type.
+ *
+ * Group: consumer
+ *
+ * @return the name of the header {@code FileLength}.
+ */
+ public String fileLength() {
+ return "CamelFileLength";
+ }
+ /**
+ * 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 "CamelFileLastModified";
+ }
+ /**
+ * Only the file name (the name with no leading paths).
+ *
+ * The option is a: {@code String} type.
+ *
+ * Group: consumer
+ *
+ * @return the name of the header {@code FileNameOnly}.
+ */
+ public String fileNameOnly() {
+ return "CamelFileNameOnly";
+ }
+ /**
+ * (producer) Specifies the name of the file to write (relative to the
+ * endpoint directory). This name can be a String; a String with a file
+ * or simple Language expression; or an Expression object. If it's null
+ * then Camel will auto-generate a filename based on the message unique
+ * ID. (consumer) Name of the consumed file as a relative file path
with
+ * offset from the starting directory configured on the endpoint.
+ *
+ * The option is a: {@code String} type.
+ *
+ * Group: common
+ *
+ * @return the name of the header {@code FileName}.
+ */
+ public String fileName() {
+ return "CamelFileName";
+ }
+ /**
+ * The name of the file that has been consumed.
+ *
+ * The option is a: {@code String} type.
+ *
+ * Group: consumer
+ *
+ * @return the name of the header {@code FileNameConsumed}.
+ */
+ public String fileNameConsumed() {
+ return "CamelFileNameConsumed";
+ }
+ /**
+ * A boolean option specifying whether the consumed file denotes an
+ * absolute path or not. Should normally be false for relative paths.
+ * Absolute paths should normally not be used but we added to the move
+ * option to allow moving files to absolute paths. But can be used
+ * elsewhere as well.
+ *
+ * The option is a: {@code Boolean} type.
+ *
+ * Group: consumer
+ *
+ * @return the name of the header {@code FileAbsolute}.
+ */
+ public String fileAbsolute() {
+ return "CamelFileAbsolute";
+ }
+ /**
+ * The absolute path to the file. For relative files this path holds
the
+ * relative path instead.
+ *
+ * The option is a: {@code String} type.
+ *
+ * Group: consumer
+ *
+ * @return the name of the header {@code FileAbsolutePath}.
+ */
+ public String fileAbsolutePath() {
+ return "CamelFileAbsolutePath";
+ }
+ /**
+ * The file path. For relative files this is the starting directory.
For
+ * absolute files this is the absolute path.
+ *
+ * The option is a: {@code String} type.
+ *
+ * Group: consumer
+ *
+ * @return the name of the header {@code FilePath}.
+ */
+ public String filePath() {
+ return "CamelFilePath";
+ }
+ /**
+ * The relative path.
+ *
+ * The option is a: {@code String} type.
+ *
+ * Group: consumer
+ *
+ * @return the name of the header {@code FileRelativePath}.
+ */
+ public String fileRelativePath() {
+ return "CamelFileRelativePath";
+ }
+ /**
+ * The parent path.
+ *
+ * The option is a: {@code String} type.
+ *
+ * Group: common
+ *
+ * @return the name of the header {@code FileParent}.
+ */
+ public String fileParent() {
+ return "CamelFileParent";
+ }
+ /**
+ * The actual absolute filepath (path name) for the output file that
was
+ * written. This header is set by Camel and its purpose is providing
+ * end-users with the name of the file that was written.
+ *
+ * The option is a: {@code String} type.
+ *
+ * Group: producer
+ *
+ * @return the name of the header {@code FileNameProduced}.
+ */
+ public String fileNameProduced() {
+ return "CamelFileNameProduced";
+ }
+ /**
+ * Is used for overruling CamelFileName header and use the value
instead
+ * (but only once, as the producer will remove this header after
writing
+ * the file). The value can be only be a String. Notice that if the
+ * option fileName has been configured, then this is still being
+ * evaluated.
+ *
+ * The option is a: {@code Object} type.
+ *
+ * Group: producer
+ *
+ * @return the name of the header {@code OverruleFileName}.
+ */
+ public String overruleFileName() {
+ return "CamelOverruleFileName";
+ }
+ /**
+ * The remote hostname.
+ *
+ * The option is a: {@code String} type.
+ *
+ * Group: consumer
+ *
+ * @return the name of the header {@code FileHost}.
+ */
+ public String fileHost() {
+ return "CamelFileHost";
+ }
+ /**
+ * 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 "CamelFileLocalWorkPath";
+ }
+ /**
+ * The expected behavior if the file already exists.
+ *
+ * The option is a: {@code
+ * org.apache.camel.component.file.GenericFileExist} type.
+ *
+ * Group: producer
+ *
+ * @return the name of the header {@code SmbFileExists}.
+ */
+ @Deprecated
+ public String smbFileExists() {
+ return "CamelSmbFileExists";
+ }
+ }
static SmbEndpointBuilder endpointBuilder(String componentName, String
path) {
class SmbEndpointBuilderImpl extends AbstractEndpointBuilder
implements SmbEndpointBuilder, AdvancedSmbEndpointBuilder {
public SmbEndpointBuilderImpl(String path) {
