This is an automated email from the ASF dual-hosted git repository.
oscerd pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel-spring-boot.git
The following commit(s) were added to refs/heads/main by this push:
new c3995bec820 [create-pull-request] automated change (#1869)
c3995bec820 is described below
commit c3995bec8200736595354525811a851cafe0d868
Author: github-actions[bot]
<41898282+github-actions[bot]@users.noreply.github.com>
AuthorDate: Sat Aug 1 09:24:55 2026 +0200
[create-pull-request] automated change (#1869)
Co-authored-by: oscerd <[email protected]>
---
.../camel/springboot/catalog/components/scp.json | 38 +++---
.../camel/springboot/catalog/components/ssh.json | 136 ++++++++++-----------
.../camel-ssh-starter/src/main/docs/ssh.json | 4 +-
.../ssh/springboot/SshComponentConfiguration.java | 53 ++++----
.../modules/ROOT/pages/starters/ssh.adoc | 4 +-
5 files changed, 119 insertions(+), 116 deletions(-)
diff --git
a/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components/scp.json
b/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components/scp.json
index 1c93a91df7c..2ad0a9a3d76 100644
---
a/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components/scp.json
+++
b/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components/scp.json
@@ -41,25 +41,25 @@
"jailStartingDirectory": { "index": 7, "kind": "parameter", "displayName":
"Jail Starting Directory", "group": "common", "label": "common", "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 [...]
"checksumWriteFile": { "index": 8, "kind": "parameter", "displayName":
"Checksum Write File", "group": "producer", "label": "producer", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": true, "description": "If
checksumFileAlgorithm has been configured then this option controls whether to
write a checksum file as well or not. The checksum file will always be written
in the same folder as the original [...]
"flatten": { "index": 9, "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 [...]
- "strictHostKeyChecking": { "index": 10, "kind": "parameter",
"displayName": "Strict Host Key Checking", "group": "producer", "label": "",
"required": false, "type": "enum", "javaType": "java.lang.String", "enum": [
"no", "yes" ], "deprecated": false, "autowired": false, "secret": false,
"defaultValue": "no", "configurationClass":
"org.apache.camel.component.scp.ScpConfiguration", "configurationField":
"configuration", "description": "Sets whether to use strict host key checking.
Poss [...]
- "allowNullBody": { "index": 11, "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": 12, "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 [...]
- "lazyStartProducer": { "index": 13, "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": 14, "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, [...]
- "browseLimit": { "index": 15, "kind": "parameter", "displayName": "Browse
Limit", "group": "advanced", "label": "advanced", "required": false, "type":
"integer", "javaType": "int", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": 100, "description": "Maximum number of
messages to keep in memory available for browsing. Use 0 for unlimited." },
- "connectTimeout": { "index": 16, "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.scp.ScpConfiguration", "configurationField":
"configuration", "description": "Sets the connect timeout for waiting for a
connection to be established Used by both FTPC [...]
- "soTimeout": { "index": 17, "kind": "parameter", "displayName": "So
Timeout", "group": "advanced", "label": "advanced", "required": false, "type":
"duration", "javaType": "int", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "300000", "configurationClass":
"org.apache.camel.component.scp.ScpConfiguration", "configurationField":
"configuration", "description": "Sets the so timeout FTP and FTPS Is the
SocketOptions.SO_TIMEOUT value in millis. Recommended opti [...]
- "timeout": { "index": 18, "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.scp.ScpConfiguration", "configurationField":
"configuration", "description": "Sets the data timeout for waiting for reply
Used only by FTPClient" },
- "caSignatureAlgorithms": { "index": 19, "kind": "parameter",
"displayName": "Ca Signature Algorithms", "group": "security", "label":
"security", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"configurationClass": "org.apache.camel.component.scp.ScpConfiguration",
"configurationField": "configuration", "description": "Set a comma separated
list of CA signature algorithms accepted for host certificate veri [...]
- "certBytes": { "index": 20, "kind": "parameter", "displayName": "Cert
Bytes", "group": "security", "label": "security", "required": false, "type":
"string", "javaType": "byte[]", "deprecated": false, "autowired": false,
"secret": true, "security": "secret", "configurationClass":
"org.apache.camel.component.scp.ScpConfiguration", "configurationField":
"configuration", "description": "Set the OpenSSH certificate as a byte array
for certificate-based authentication." },
- "certFile": { "index": 21, "kind": "parameter", "displayName": "Cert
File", "group": "security", "label": "security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": true, "security": "secret", "configurationClass":
"org.apache.camel.component.scp.ScpConfiguration", "configurationField":
"configuration", "description": "Set the OpenSSH certificate file path for
certificate-based authentication." },
- "certUri": { "index": 22, "kind": "parameter", "displayName": "Cert Uri",
"group": "security", "label": "security", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "deprecationNote": "",
"autowired": false, "secret": true, "security": "secret",
"supportFileReference": true, "configurationClass":
"org.apache.camel.component.scp.ScpConfiguration", "configurationField":
"configuration", "description": "Set the OpenSSH certificate (loaded from cl
[...]
- "knownHostsFile": { "index": 23, "kind": "parameter", "displayName":
"Known Hosts File", "group": "security", "label": "security", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"deprecationNote": "", "autowired": false, "secret": true, "security":
"secret", "supportFileReference": true, "configurationClass":
"org.apache.camel.component.scp.ScpConfiguration", "configurationField":
"configuration", "description": "Sets the known_hosts file, s [...]
- "password": { "index": 24, "kind": "parameter", "displayName": "Password",
"group": "security", "label": "security", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": true, "security": "secret", "configurationClass":
"org.apache.camel.component.scp.ScpConfiguration", "configurationField":
"configuration", "description": "Password to use for login" },
- "preferredAuthentications": { "index": 25, "kind": "parameter",
"displayName": "Preferred Authentications", "group": "security", "label":
"security", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": true,
"security": "secret", "configurationClass":
"org.apache.camel.component.scp.ScpConfiguration", "configurationField":
"configuration", "description": "Set a comma separated list of authentications
that will be use [...]
- "privateKeyBytes": { "index": 26, "kind": "parameter", "displayName":
"Private Key Bytes", "group": "security", "label": "security", "required":
false, "type": "string", "javaType": "byte[]", "deprecated": false,
"autowired": false, "secret": true, "security": "secret", "configurationClass":
"org.apache.camel.component.scp.ScpConfiguration", "configurationField":
"configuration", "description": "Set the private key bytes to that the endpoint
can do private key verification. This must [...]
- "privateKeyFile": { "index": 27, "kind": "parameter", "displayName":
"Private Key File", "group": "security", "label": "security", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "security": "secret", "configurationClass":
"org.apache.camel.component.scp.ScpConfiguration", "configurationField":
"configuration", "description": "Set the private key file to that the endpoint
can do private key verification. Yo [...]
- "privateKeyFilePassphrase": { "index": 28, "kind": "parameter",
"displayName": "Private Key File Passphrase", "group": "security", "label":
"security", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": true,
"security": "secret", "configurationClass":
"org.apache.camel.component.scp.ScpConfiguration", "configurationField":
"configuration", "description": "Set the private key file passphrase to that
the endpoint can [...]
+ "allowNullBody": { "index": 10, "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": 11, "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 [...]
+ "lazyStartProducer": { "index": 12, "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": 13, "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, [...]
+ "browseLimit": { "index": 14, "kind": "parameter", "displayName": "Browse
Limit", "group": "advanced", "label": "advanced", "required": false, "type":
"integer", "javaType": "int", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": 100, "description": "Maximum number of
messages to keep in memory available for browsing. Use 0 for unlimited." },
+ "connectTimeout": { "index": 15, "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.scp.ScpConfiguration", "configurationField":
"configuration", "description": "Sets the connect timeout for waiting for a
connection to be established Used by both FTPC [...]
+ "soTimeout": { "index": 16, "kind": "parameter", "displayName": "So
Timeout", "group": "advanced", "label": "advanced", "required": false, "type":
"duration", "javaType": "int", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "300000", "configurationClass":
"org.apache.camel.component.scp.ScpConfiguration", "configurationField":
"configuration", "description": "Sets the so timeout FTP and FTPS Is the
SocketOptions.SO_TIMEOUT value in millis. Recommended opti [...]
+ "timeout": { "index": 17, "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.scp.ScpConfiguration", "configurationField":
"configuration", "description": "Sets the data timeout for waiting for reply
Used only by FTPClient" },
+ "caSignatureAlgorithms": { "index": 18, "kind": "parameter",
"displayName": "Ca Signature Algorithms", "group": "security", "label":
"security", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"configurationClass": "org.apache.camel.component.scp.ScpConfiguration",
"configurationField": "configuration", "description": "Set a comma separated
list of CA signature algorithms accepted for host certificate veri [...]
+ "certBytes": { "index": 19, "kind": "parameter", "displayName": "Cert
Bytes", "group": "security", "label": "security", "required": false, "type":
"string", "javaType": "byte[]", "deprecated": false, "autowired": false,
"secret": true, "security": "secret", "configurationClass":
"org.apache.camel.component.scp.ScpConfiguration", "configurationField":
"configuration", "description": "Set the OpenSSH certificate as a byte array
for certificate-based authentication." },
+ "certFile": { "index": 20, "kind": "parameter", "displayName": "Cert
File", "group": "security", "label": "security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": true, "security": "secret", "configurationClass":
"org.apache.camel.component.scp.ScpConfiguration", "configurationField":
"configuration", "description": "Set the OpenSSH certificate file path for
certificate-based authentication." },
+ "certUri": { "index": 21, "kind": "parameter", "displayName": "Cert Uri",
"group": "security", "label": "security", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "deprecationNote": "",
"autowired": false, "secret": true, "security": "secret",
"supportFileReference": true, "configurationClass":
"org.apache.camel.component.scp.ScpConfiguration", "configurationField":
"configuration", "description": "Set the OpenSSH certificate (loaded from cl
[...]
+ "knownHostsFile": { "index": 22, "kind": "parameter", "displayName":
"Known Hosts File", "group": "security", "label": "security", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"deprecationNote": "", "autowired": false, "secret": true, "security":
"secret", "supportFileReference": true, "configurationClass":
"org.apache.camel.component.scp.ScpConfiguration", "configurationField":
"configuration", "description": "Sets the known_hosts file, s [...]
+ "password": { "index": 23, "kind": "parameter", "displayName": "Password",
"group": "security", "label": "security", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": true, "security": "secret", "configurationClass":
"org.apache.camel.component.scp.ScpConfiguration", "configurationField":
"configuration", "description": "Password to use for login" },
+ "preferredAuthentications": { "index": 24, "kind": "parameter",
"displayName": "Preferred Authentications", "group": "security", "label":
"security", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": true,
"security": "secret", "configurationClass":
"org.apache.camel.component.scp.ScpConfiguration", "configurationField":
"configuration", "description": "Set a comma separated list of authentications
that will be use [...]
+ "privateKeyBytes": { "index": 25, "kind": "parameter", "displayName":
"Private Key Bytes", "group": "security", "label": "security", "required":
false, "type": "string", "javaType": "byte[]", "deprecated": false,
"autowired": false, "secret": true, "security": "secret", "configurationClass":
"org.apache.camel.component.scp.ScpConfiguration", "configurationField":
"configuration", "description": "Set the private key bytes to that the endpoint
can do private key verification. This must [...]
+ "privateKeyFile": { "index": 26, "kind": "parameter", "displayName":
"Private Key File", "group": "security", "label": "security", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "security": "secret", "configurationClass":
"org.apache.camel.component.scp.ScpConfiguration", "configurationField":
"configuration", "description": "Set the private key file to that the endpoint
can do private key verification. Yo [...]
+ "privateKeyFilePassphrase": { "index": 27, "kind": "parameter",
"displayName": "Private Key File Passphrase", "group": "security", "label":
"security", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": true,
"security": "secret", "configurationClass":
"org.apache.camel.component.scp.ScpConfiguration", "configurationField":
"configuration", "description": "Set the private key file passphrase to that
the endpoint can [...]
+ "strictHostKeyChecking": { "index": 28, "kind": "parameter",
"displayName": "Strict Host Key Checking", "group": "security", "label":
"security", "required": false, "type": "enum", "javaType": "java.lang.String",
"enum": [ "no", "yes" ], "deprecated": false, "autowired": false, "secret":
false, "security": "insecure:ssl", "defaultValue": "no", "configurationClass":
"org.apache.camel.component.scp.ScpConfiguration", "configurationField":
"configuration", "description": "Sets whether t [...]
"username": { "index": 29, "kind": "parameter", "displayName": "Username",
"group": "security", "label": "security", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": true, "security": "secret", "configurationClass":
"org.apache.camel.component.scp.ScpConfiguration", "configurationField":
"configuration", "description": "Username to use for login" },
"useUserKnownHostsFile": { "index": 30, "kind": "parameter",
"displayName": "Use User Known Hosts File", "group": "security", "label":
"security", "required": false, "type": "boolean", "javaType": "boolean",
"deprecated": false, "autowired": false, "secret": false, "defaultValue": true,
"configurationClass": "org.apache.camel.component.scp.ScpConfiguration",
"configurationField": "configuration", "description": "If knownHostFile has not
been explicit configured, then use the host fil [...]
"ciphers": { "index": 31, "kind": "parameter", "displayName": "Ciphers",
"group": "security (advanced)", "label": "security,advanced", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.scp.ScpConfiguration", "configurationField":
"configuration", "description": "Set a comma separated list of ciphers that
will be used in order of preference. Possible cipher na [...]
diff --git
a/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components/ssh.json
b/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components/ssh.json
index 0619285fe16..8d245505fc0 100644
---
a/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components/ssh.json
+++
b/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components/ssh.json
@@ -25,33 +25,33 @@
"remote": true
},
"componentProperties": {
- "failOnUnknownHost": { "index": 0, "kind": "property", "displayName":
"Fail On Unknown Host", "group": "common", "label": "", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Specifies whether a connection to an unknown
host should fail or not. This value is only che [...]
- "knownHostsResource": { "index": 1, "kind": "property", "displayName":
"Known Hosts Resource", "group": "common", "label": "", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the resource path for a known_hosts file"
},
- "timeout": { "index": 2, "kind": "property", "displayName": "Timeout",
"group": "common", "label": "", "required": false, "type": "integer",
"javaType": "long", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": 30000, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the timeout in milliseconds to wait in
establishing the remote SSH server connection. Defaults to 30000 milliseco [...]
- "bridgeErrorHandler": { "index": 3, "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 (if possible) occurred while the Camel consumer is trying
to pickup incoming messages, or the like [...]
- "pollCommand": { "index": 4, "kind": "property", "displayName": "Poll
Command", "group": "consumer", "label": "consumer", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the command string to send to the remote
SSH server during every poll cycle. Only works with camel-ssh com [...]
- "lazyStartProducer": { "index": 5, "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 [...]
- "authTimeout": { "index": 6, "kind": "property", "displayName": "Auth
Timeout", "group": "advanced", "label": "advanced", "required": false, "type":
"integer", "javaType": "long", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the authentication timeout in
milliseconds." },
- "autowiredEnabled": { "index": 7, "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 [...]
- "channelOpenTimeout": { "index": 8, "kind": "property", "displayName":
"Channel Open Timeout", "group": "advanced", "label": "advanced", "required":
false, "type": "integer", "javaType": "long", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the timeout in milliseconds for opening a
channel." },
- "channelType": { "index": 9, "kind": "property", "displayName": "Channel
Type", "group": "advanced", "label": "advanced", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": "exec", "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the channel type to pass to the Channel
as part of command execution. Defaults to [...]
- "clientBuilder": { "index": 10, "kind": "property", "displayName": "Client
Builder", "group": "advanced", "label": "advanced", "required": false, "type":
"object", "javaType": "org.apache.sshd.client.ClientBuilder", "deprecated":
false, "deprecationNote": "", "autowired": true, "secret": false,
"configurationClass": "org.apache.camel.component.ssh.SshConfiguration",
"configurationField": "configuration", "description": "Instance of
ClientBuilder used by the producer or consumer to cr [...]
- "compressions": { "index": 11, "kind": "property", "displayName":
"Compressions", "group": "advanced", "label": "advanced", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Whether to use compression, and if so which."
},
- "configuration": { "index": 12, "kind": "property", "displayName":
"Configuration", "group": "advanced", "label": "advanced", "required": false,
"type": "object", "javaType":
"org.apache.camel.component.ssh.SshConfiguration", "deprecated": false,
"autowired": false, "secret": false, "description": "Component configuration" },
- "connectTimeout": { "index": 13, "kind": "property", "displayName":
"Connect Timeout", "group": "advanced", "label": "advanced", "required": false,
"type": "integer", "javaType": "long", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the socket connection timeout in
milliseconds." },
- "heartbeatInterval": { "index": 14, "kind": "property", "displayName":
"Heartbeat Interval", "group": "advanced", "label": "advanced", "required":
false, "type": "integer", "javaType": "long", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the heartbeat interval in milliseconds.
If positive, the component will send keep-alive messages to prev [...]
- "heartbeatReplyMaxWait": { "index": 15, "kind": "property", "displayName":
"Heartbeat Reply Max Wait", "group": "advanced", "label": "advanced",
"required": false, "type": "integer", "javaType": "int", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the maximum number of keep-alive messages
without reply before the session is terminated." },
- "idleTimeout": { "index": 16, "kind": "property", "displayName": "Idle
Timeout", "group": "advanced", "label": "advanced", "required": false, "type":
"integer", "javaType": "long", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the timeout in milliseconds to wait
before the SSH session is closed due to inactivity. The default value is 0,
whic [...]
- "shellPrompt": { "index": 17, "kind": "property", "displayName": "Shell
Prompt", "group": "advanced", "label": "advanced", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the shellPrompt to be dropped when
response is read after command execution" },
- "sleepForShellPrompt": { "index": 18, "kind": "property", "displayName":
"Sleep For Shell Prompt", "group": "advanced", "label": "advanced", "required":
false, "type": "integer", "javaType": "long", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": 100, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the sleep period in milliseconds to wait
reading response from shell prompt. [...]
- "healthCheckConsumerEnabled": { "index": 19, "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": 20, "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 produce [...]
- "certResource": { "index": 21, "kind": "property", "displayName": "Cert
Resource", "group": "security", "label": "security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the resource path of the certificate to
use for Authentication. Will use ResourceHelperKeyPairProvider [...]
- "certResourcePassword": { "index": 22, "kind": "property", "displayName":
"Cert Resource Password", "group": "security", "label": "security", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "security": "secret", "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the password to use in loading
certResource, if certResource is a [...]
- "ciphers": { "index": 23, "kind": "property", "displayName": "Ciphers",
"group": "security", "label": "security", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Comma-separated list of allowed\/supported
ciphers in their order of preference." },
- "kex": { "index": 24, "kind": "property", "displayName": "Kex", "group":
"security", "label": "security", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Comma-separated list of allowed\/supported key
exchange algorithms in their order of preference." },
- "keyPairProvider": { "index": 25, "kind": "property", "displayName": "Key
Pair Provider", "group": "security", "label": "security", "required": false,
"type": "object", "javaType":
"org.apache.sshd.common.keyprovider.KeyPairProvider", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the KeyPairProvider reference to use when
connecting using Cer [...]
- "keyType": { "index": 26, "kind": "property", "displayName": "Key Type",
"group": "security", "label": "security", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the key type to pass to the
KeyPairProvider as part of authentication. KeyPairProvider.loadKey(...) will be
passe [...]
+ "timeout": { "index": 0, "kind": "property", "displayName": "Timeout",
"group": "common", "label": "", "required": false, "type": "integer",
"javaType": "long", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": 30000, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the timeout in milliseconds to wait in
establishing the remote SSH server connection. Defaults to 30000 milliseco [...]
+ "bridgeErrorHandler": { "index": 1, "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 (if possible) occurred while the Camel consumer is trying
to pickup incoming messages, or the like [...]
+ "pollCommand": { "index": 2, "kind": "property", "displayName": "Poll
Command", "group": "consumer", "label": "consumer", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the command string to send to the remote
SSH server during every poll cycle. Only works with camel-ssh com [...]
+ "lazyStartProducer": { "index": 3, "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 [...]
+ "authTimeout": { "index": 4, "kind": "property", "displayName": "Auth
Timeout", "group": "advanced", "label": "advanced", "required": false, "type":
"integer", "javaType": "long", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the authentication timeout in
milliseconds." },
+ "autowiredEnabled": { "index": 5, "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 [...]
+ "channelOpenTimeout": { "index": 6, "kind": "property", "displayName":
"Channel Open Timeout", "group": "advanced", "label": "advanced", "required":
false, "type": "integer", "javaType": "long", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the timeout in milliseconds for opening a
channel." },
+ "channelType": { "index": 7, "kind": "property", "displayName": "Channel
Type", "group": "advanced", "label": "advanced", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": "exec", "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the channel type to pass to the Channel
as part of command execution. Defaults to [...]
+ "clientBuilder": { "index": 8, "kind": "property", "displayName": "Client
Builder", "group": "advanced", "label": "advanced", "required": false, "type":
"object", "javaType": "org.apache.sshd.client.ClientBuilder", "deprecated":
false, "deprecationNote": "", "autowired": true, "secret": false,
"configurationClass": "org.apache.camel.component.ssh.SshConfiguration",
"configurationField": "configuration", "description": "Instance of
ClientBuilder used by the producer or consumer to cre [...]
+ "compressions": { "index": 9, "kind": "property", "displayName":
"Compressions", "group": "advanced", "label": "advanced", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Whether to use compression, and if so which."
},
+ "configuration": { "index": 10, "kind": "property", "displayName":
"Configuration", "group": "advanced", "label": "advanced", "required": false,
"type": "object", "javaType":
"org.apache.camel.component.ssh.SshConfiguration", "deprecated": false,
"autowired": false, "secret": false, "description": "Component configuration" },
+ "connectTimeout": { "index": 11, "kind": "property", "displayName":
"Connect Timeout", "group": "advanced", "label": "advanced", "required": false,
"type": "integer", "javaType": "long", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the socket connection timeout in
milliseconds." },
+ "heartbeatInterval": { "index": 12, "kind": "property", "displayName":
"Heartbeat Interval", "group": "advanced", "label": "advanced", "required":
false, "type": "integer", "javaType": "long", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the heartbeat interval in milliseconds.
If positive, the component will send keep-alive messages to prev [...]
+ "heartbeatReplyMaxWait": { "index": 13, "kind": "property", "displayName":
"Heartbeat Reply Max Wait", "group": "advanced", "label": "advanced",
"required": false, "type": "integer", "javaType": "int", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the maximum number of keep-alive messages
without reply before the session is terminated." },
+ "idleTimeout": { "index": 14, "kind": "property", "displayName": "Idle
Timeout", "group": "advanced", "label": "advanced", "required": false, "type":
"integer", "javaType": "long", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the timeout in milliseconds to wait
before the SSH session is closed due to inactivity. The default value is 0,
whic [...]
+ "shellPrompt": { "index": 15, "kind": "property", "displayName": "Shell
Prompt", "group": "advanced", "label": "advanced", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the shellPrompt to be dropped when
response is read after command execution" },
+ "sleepForShellPrompt": { "index": 16, "kind": "property", "displayName":
"Sleep For Shell Prompt", "group": "advanced", "label": "advanced", "required":
false, "type": "integer", "javaType": "long", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": 100, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the sleep period in milliseconds to wait
reading response from shell prompt. [...]
+ "healthCheckConsumerEnabled": { "index": 17, "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": 18, "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 produce [...]
+ "certResource": { "index": 19, "kind": "property", "displayName": "Cert
Resource", "group": "security", "label": "security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the resource path of the certificate to
use for Authentication. Will use ResourceHelperKeyPairProvider [...]
+ "certResourcePassword": { "index": 20, "kind": "property", "displayName":
"Cert Resource Password", "group": "security", "label": "security", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "security": "secret", "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the password to use in loading
certResource, if certResource is a [...]
+ "ciphers": { "index": 21, "kind": "property", "displayName": "Ciphers",
"group": "security", "label": "security", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Comma-separated list of allowed\/supported
ciphers in their order of preference." },
+ "failOnUnknownHost": { "index": 22, "kind": "property", "displayName":
"Fail On Unknown Host", "group": "security", "label": "security", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "security": "insecure:ssl",
"insecureValue": "false", "defaultValue": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Specifies whether a connect [...]
+ "kex": { "index": 23, "kind": "property", "displayName": "Kex", "group":
"security", "label": "security", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Comma-separated list of allowed\/supported key
exchange algorithms in their order of preference." },
+ "keyPairProvider": { "index": 24, "kind": "property", "displayName": "Key
Pair Provider", "group": "security", "label": "security", "required": false,
"type": "object", "javaType":
"org.apache.sshd.common.keyprovider.KeyPairProvider", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the KeyPairProvider reference to use when
connecting using Cer [...]
+ "keyType": { "index": 25, "kind": "property", "displayName": "Key Type",
"group": "security", "label": "security", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the key type to pass to the
KeyPairProvider as part of authentication. KeyPairProvider.loadKey(...) will be
passe [...]
+ "knownHostsResource": { "index": 26, "kind": "property", "displayName":
"Known Hosts Resource", "group": "security", "label": "security", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "security": "insecure:ssl",
"configurationClass": "org.apache.camel.component.ssh.SshConfiguration",
"configurationField": "configuration", "description": "Sets the resource path
for a known_hosts file used to verify the SS [...]
"macs": { "index": 27, "kind": "property", "displayName": "Macs", "group":
"security", "label": "security", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Comma-separated list of allowed\/supported
message authentication code algorithms in their order of preference. The MAC
algor [...]
"password": { "index": 28, "kind": "property", "displayName": "Password",
"group": "security", "label": "security", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": true, "security": "secret", "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the password to use in connecting to
remote SSH server. Requires keyPairProvider to be set [...]
"signatures": { "index": 29, "kind": "property", "displayName":
"Signatures", "group": "security", "label": "security", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Comma-separated list of allowed\/supported
signature algorithms in their order of preference." },
@@ -66,47 +66,47 @@
"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.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the hostname of the remote SSH server." },
"port": { "index": 1, "kind": "path", "displayName": "Port", "group":
"common", "label": "", "required": false, "type": "integer", "javaType": "int",
"deprecated": false, "autowired": false, "secret": false, "defaultValue": 22,
"configurationClass": "org.apache.camel.component.ssh.SshConfiguration",
"configurationField": "configuration", "description": "Sets the port number for
the remote SSH server." },
- "failOnUnknownHost": { "index": 2, "kind": "parameter", "displayName":
"Fail On Unknown Host", "group": "common", "label": "", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Specifies whether a connection to an unknown
host should fail or not. This value is only ch [...]
- "knownHostsResource": { "index": 3, "kind": "parameter", "displayName":
"Known Hosts Resource", "group": "common", "label": "", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the resource path for a known_hosts file"
},
- "timeout": { "index": 4, "kind": "parameter", "displayName": "Timeout",
"group": "common", "label": "", "required": false, "type": "integer",
"javaType": "long", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": 30000, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the timeout in milliseconds to wait in
establishing the remote SSH server connection. Defaults to 30000 millisec [...]
- "pollCommand": { "index": 5, "kind": "parameter", "displayName": "Poll
Command", "group": "consumer", "label": "consumer", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the command string to send to the remote
SSH server during every poll cycle. Only works with camel-ssh co [...]
- "sendEmptyMessageWhenIdle": { "index": 6, "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." },
- "bridgeErrorHandler": { "index": 7, "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 (if possible) occurred
while the Camel consumer is trying to pickup incoming [...]
- "exceptionHandler": { "index": 8, "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 def [...]
- "exchangePattern": { "index": 9, "kind": "parameter", "displayName":
"Exchange Pattern", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "enum", "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." },
- "pollStrategy": { "index": 10, "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
[...]
- "lazyStartProducer": { "index": 11, "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 [...]
- "authTimeout": { "index": 12, "kind": "parameter", "displayName": "Auth
Timeout", "group": "advanced", "label": "advanced", "required": false, "type":
"integer", "javaType": "long", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the authentication timeout in
milliseconds." },
- "channelOpenTimeout": { "index": 13, "kind": "parameter", "displayName":
"Channel Open Timeout", "group": "advanced", "label": "advanced", "required":
false, "type": "integer", "javaType": "long", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the timeout in milliseconds for opening a
channel." },
- "channelType": { "index": 14, "kind": "parameter", "displayName": "Channel
Type", "group": "advanced", "label": "advanced", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": "exec", "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the channel type to pass to the Channel
as part of command execution. Defaults t [...]
- "clientBuilder": { "index": 15, "kind": "parameter", "displayName":
"Client Builder", "group": "advanced", "label": "advanced", "required": false,
"type": "object", "javaType": "org.apache.sshd.client.ClientBuilder",
"deprecated": false, "deprecationNote": "", "autowired": true, "secret": false,
"configurationClass": "org.apache.camel.component.ssh.SshConfiguration",
"configurationField": "configuration", "description": "Instance of
ClientBuilder used by the producer or consumer to c [...]
- "compressions": { "index": 16, "kind": "parameter", "displayName":
"Compressions", "group": "advanced", "label": "advanced", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Whether to use compression, and if so which."
},
- "connectTimeout": { "index": 17, "kind": "parameter", "displayName":
"Connect Timeout", "group": "advanced", "label": "advanced", "required": false,
"type": "integer", "javaType": "long", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the socket connection timeout in
milliseconds." },
- "heartbeatInterval": { "index": 18, "kind": "parameter", "displayName":
"Heartbeat Interval", "group": "advanced", "label": "advanced", "required":
false, "type": "integer", "javaType": "long", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the heartbeat interval in milliseconds.
If positive, the component will send keep-alive messages to pre [...]
- "heartbeatReplyMaxWait": { "index": 19, "kind": "parameter",
"displayName": "Heartbeat Reply Max Wait", "group": "advanced", "label":
"advanced", "required": false, "type": "integer", "javaType": "int",
"deprecated": false, "autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the maximum number of keep-alive messages
without reply before the session is terminated." },
- "idleTimeout": { "index": 20, "kind": "parameter", "displayName": "Idle
Timeout", "group": "advanced", "label": "advanced", "required": false, "type":
"integer", "javaType": "long", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the timeout in milliseconds to wait
before the SSH session is closed due to inactivity. The default value is 0, whi
[...]
- "shellPrompt": { "index": 21, "kind": "parameter", "displayName": "Shell
Prompt", "group": "advanced", "label": "advanced", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the shellPrompt to be dropped when
response is read after command execution" },
- "sleepForShellPrompt": { "index": 22, "kind": "parameter", "displayName":
"Sleep For Shell Prompt", "group": "advanced", "label": "advanced", "required":
false, "type": "integer", "javaType": "long", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": 100, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the sleep period in milliseconds to wait
reading response from shell prompt. [...]
- "backoffErrorThreshold": { "index": 23, "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": 24, "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": 25, "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": 26, "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": 27, "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": 28, "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": 29, "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": 30, "kind": "parameter", "displayName": "Run
Logging Level", "group": "scheduler", "label": "consumer,scheduler",
"required": false, "type": "enum", "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 log [...]
- "scheduledExecutorService": { "index": 31, "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": 32, "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": 33, "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. This i [...]
- "startScheduler": { "index": 34, "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": 35, "kind": "parameter", "displayName": "Time
Unit", "group": "scheduler", "label": "consumer,scheduler", "required": false,
"type": "enum", "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": 36, "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." },
- "certResource": { "index": 37, "kind": "parameter", "displayName": "Cert
Resource", "group": "security", "label": "security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the resource path of the certificate to
use for Authentication. Will use ResourceHelperKeyPairProvider [...]
- "certResourcePassword": { "index": 38, "kind": "parameter", "displayName":
"Cert Resource Password", "group": "security", "label": "security", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "security": "secret", "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the password to use in loading
certResource, if certResource is [...]
- "ciphers": { "index": 39, "kind": "parameter", "displayName": "Ciphers",
"group": "security", "label": "security", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Comma-separated list of allowed\/supported
ciphers in their order of preference." },
- "kex": { "index": 40, "kind": "parameter", "displayName": "Kex", "group":
"security", "label": "security", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Comma-separated list of allowed\/supported key
exchange algorithms in their order of preference." },
- "keyPairProvider": { "index": 41, "kind": "parameter", "displayName": "Key
Pair Provider", "group": "security", "label": "security", "required": false,
"type": "object", "javaType":
"org.apache.sshd.common.keyprovider.KeyPairProvider", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the KeyPairProvider reference to use when
connecting using Ce [...]
- "keyType": { "index": 42, "kind": "parameter", "displayName": "Key Type",
"group": "security", "label": "security", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the key type to pass to the
KeyPairProvider as part of authentication. KeyPairProvider.loadKey(...) will be
pass [...]
+ "timeout": { "index": 2, "kind": "parameter", "displayName": "Timeout",
"group": "common", "label": "", "required": false, "type": "integer",
"javaType": "long", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": 30000, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the timeout in milliseconds to wait in
establishing the remote SSH server connection. Defaults to 30000 millisec [...]
+ "pollCommand": { "index": 3, "kind": "parameter", "displayName": "Poll
Command", "group": "consumer", "label": "consumer", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the command string to send to the remote
SSH server during every poll cycle. Only works with camel-ssh co [...]
+ "sendEmptyMessageWhenIdle": { "index": 4, "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." },
+ "bridgeErrorHandler": { "index": 5, "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 (if possible) occurred
while the Camel consumer is trying to pickup incoming [...]
+ "exceptionHandler": { "index": 6, "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 def [...]
+ "exchangePattern": { "index": 7, "kind": "parameter", "displayName":
"Exchange Pattern", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "enum", "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." },
+ "pollStrategy": { "index": 8, "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 pol
[...]
+ "lazyStartProducer": { "index": 9, "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 produc [...]
+ "authTimeout": { "index": 10, "kind": "parameter", "displayName": "Auth
Timeout", "group": "advanced", "label": "advanced", "required": false, "type":
"integer", "javaType": "long", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the authentication timeout in
milliseconds." },
+ "channelOpenTimeout": { "index": 11, "kind": "parameter", "displayName":
"Channel Open Timeout", "group": "advanced", "label": "advanced", "required":
false, "type": "integer", "javaType": "long", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the timeout in milliseconds for opening a
channel." },
+ "channelType": { "index": 12, "kind": "parameter", "displayName": "Channel
Type", "group": "advanced", "label": "advanced", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": "exec", "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the channel type to pass to the Channel
as part of command execution. Defaults t [...]
+ "clientBuilder": { "index": 13, "kind": "parameter", "displayName":
"Client Builder", "group": "advanced", "label": "advanced", "required": false,
"type": "object", "javaType": "org.apache.sshd.client.ClientBuilder",
"deprecated": false, "deprecationNote": "", "autowired": true, "secret": false,
"configurationClass": "org.apache.camel.component.ssh.SshConfiguration",
"configurationField": "configuration", "description": "Instance of
ClientBuilder used by the producer or consumer to c [...]
+ "compressions": { "index": 14, "kind": "parameter", "displayName":
"Compressions", "group": "advanced", "label": "advanced", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Whether to use compression, and if so which."
},
+ "connectTimeout": { "index": 15, "kind": "parameter", "displayName":
"Connect Timeout", "group": "advanced", "label": "advanced", "required": false,
"type": "integer", "javaType": "long", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the socket connection timeout in
milliseconds." },
+ "heartbeatInterval": { "index": 16, "kind": "parameter", "displayName":
"Heartbeat Interval", "group": "advanced", "label": "advanced", "required":
false, "type": "integer", "javaType": "long", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the heartbeat interval in milliseconds.
If positive, the component will send keep-alive messages to pre [...]
+ "heartbeatReplyMaxWait": { "index": 17, "kind": "parameter",
"displayName": "Heartbeat Reply Max Wait", "group": "advanced", "label":
"advanced", "required": false, "type": "integer", "javaType": "int",
"deprecated": false, "autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the maximum number of keep-alive messages
without reply before the session is terminated." },
+ "idleTimeout": { "index": 18, "kind": "parameter", "displayName": "Idle
Timeout", "group": "advanced", "label": "advanced", "required": false, "type":
"integer", "javaType": "long", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the timeout in milliseconds to wait
before the SSH session is closed due to inactivity. The default value is 0, whi
[...]
+ "shellPrompt": { "index": 19, "kind": "parameter", "displayName": "Shell
Prompt", "group": "advanced", "label": "advanced", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the shellPrompt to be dropped when
response is read after command execution" },
+ "sleepForShellPrompt": { "index": 20, "kind": "parameter", "displayName":
"Sleep For Shell Prompt", "group": "advanced", "label": "advanced", "required":
false, "type": "integer", "javaType": "long", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": 100, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the sleep period in milliseconds to wait
reading response from shell prompt. [...]
+ "backoffErrorThreshold": { "index": 21, "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": 22, "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": 23, "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": 24, "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": 25, "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": 26, "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": 27, "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": 28, "kind": "parameter", "displayName": "Run
Logging Level", "group": "scheduler", "label": "consumer,scheduler",
"required": false, "type": "enum", "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 log [...]
+ "scheduledExecutorService": { "index": 29, "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": 30, "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": 31, "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. This i [...]
+ "startScheduler": { "index": 32, "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": 33, "kind": "parameter", "displayName": "Time
Unit", "group": "scheduler", "label": "consumer,scheduler", "required": false,
"type": "enum", "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": 34, "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." },
+ "certResource": { "index": 35, "kind": "parameter", "displayName": "Cert
Resource", "group": "security", "label": "security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the resource path of the certificate to
use for Authentication. Will use ResourceHelperKeyPairProvider [...]
+ "certResourcePassword": { "index": 36, "kind": "parameter", "displayName":
"Cert Resource Password", "group": "security", "label": "security", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "security": "secret", "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the password to use in loading
certResource, if certResource is [...]
+ "ciphers": { "index": 37, "kind": "parameter", "displayName": "Ciphers",
"group": "security", "label": "security", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Comma-separated list of allowed\/supported
ciphers in their order of preference." },
+ "failOnUnknownHost": { "index": 38, "kind": "parameter", "displayName":
"Fail On Unknown Host", "group": "security", "label": "security", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "security": "insecure:ssl",
"insecureValue": "false", "defaultValue": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Specifies whether a connec [...]
+ "kex": { "index": 39, "kind": "parameter", "displayName": "Kex", "group":
"security", "label": "security", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Comma-separated list of allowed\/supported key
exchange algorithms in their order of preference." },
+ "keyPairProvider": { "index": 40, "kind": "parameter", "displayName": "Key
Pair Provider", "group": "security", "label": "security", "required": false,
"type": "object", "javaType":
"org.apache.sshd.common.keyprovider.KeyPairProvider", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the KeyPairProvider reference to use when
connecting using Ce [...]
+ "keyType": { "index": 41, "kind": "parameter", "displayName": "Key Type",
"group": "security", "label": "security", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the key type to pass to the
KeyPairProvider as part of authentication. KeyPairProvider.loadKey(...) will be
pass [...]
+ "knownHostsResource": { "index": 42, "kind": "parameter", "displayName":
"Known Hosts Resource", "group": "security", "label": "security", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "security": "insecure:ssl",
"configurationClass": "org.apache.camel.component.ssh.SshConfiguration",
"configurationField": "configuration", "description": "Sets the resource path
for a known_hosts file used to verify the S [...]
"macs": { "index": 43, "kind": "parameter", "displayName": "Macs",
"group": "security", "label": "security", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Comma-separated list of allowed\/supported
message authentication code algorithms in their order of preference. The MAC
algo [...]
"password": { "index": 44, "kind": "parameter", "displayName": "Password",
"group": "security", "label": "security", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": true, "security": "secret", "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the password to use in connecting to
remote SSH server. Requires keyPairProvider to be set [...]
"signatures": { "index": 45, "kind": "parameter", "displayName":
"Signatures", "group": "security", "label": "security", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Comma-separated list of allowed\/supported
signature algorithms in their order of preference." },
diff --git a/components-starter/camel-ssh-starter/src/main/docs/ssh.json
b/components-starter/camel-ssh-starter/src/main/docs/ssh.json
index 35c970f37b2..beea4cf7d94 100644
--- a/components-starter/camel-ssh-starter/src/main/docs/ssh.json
+++ b/components-starter/camel-ssh-starter/src/main/docs/ssh.json
@@ -102,7 +102,7 @@
{
"name": "camel.component.ssh.fail-on-unknown-host",
"type": "java.lang.Boolean",
- "description": "Specifies whether a connection to an unknown host should
fail or not. This value is only checked when the property knownHosts is set.",
+ "description": "Specifies whether a connection to an unknown SSH server
host key should fail. When false, host keys that are not present in the
known_hosts resource are accepted.",
"sourceType":
"org.apache.camel.component.ssh.springboot.SshComponentConfiguration",
"defaultValue": false
},
@@ -159,7 +159,7 @@
{
"name": "camel.component.ssh.known-hosts-resource",
"type": "java.lang.String",
- "description": "Sets the resource path for a known_hosts file",
+ "description": "Sets the resource path for a known_hosts file used to
verify the SSH server host key. When not set, the client does not verify the
server host key against a known_hosts file.",
"sourceType":
"org.apache.camel.component.ssh.springboot.SshComponentConfiguration"
},
{
diff --git
a/components-starter/camel-ssh-starter/src/main/java/org/apache/camel/component/ssh/springboot/SshComponentConfiguration.java
b/components-starter/camel-ssh-starter/src/main/java/org/apache/camel/component/ssh/springboot/SshComponentConfiguration.java
index d044e2b35c6..93c2555de4f 100644
---
a/components-starter/camel-ssh-starter/src/main/java/org/apache/camel/component/ssh/springboot/SshComponentConfiguration.java
+++
b/components-starter/camel-ssh-starter/src/main/java/org/apache/camel/component/ssh/springboot/SshComponentConfiguration.java
@@ -37,15 +37,6 @@ public class SshComponentConfiguration
* enabled by default.
*/
private Boolean enabled;
- /**
- * Specifies whether a connection to an unknown host should fail or not.
- * This value is only checked when the property knownHosts is set.
- */
- private Boolean failOnUnknownHost = false;
- /**
- * Sets the resource path for a known_hosts file
- */
- private String knownHostsResource;
/**
* Sets the timeout in milliseconds to wait in establishing the remote SSH
* server connection. Defaults to 30000 milliseconds.
@@ -177,6 +168,12 @@ public class SshComponentConfiguration
* preference.
*/
private String ciphers;
+ /**
+ * Specifies whether a connection to an unknown SSH server host key should
+ * fail. When false, host keys that are not present in the known_hosts
+ * resource are accepted.
+ */
+ private Boolean failOnUnknownHost = false;
/**
* Comma-separated list of allowed/supported key exchange algorithms in
* their order of preference.
@@ -196,6 +193,12 @@ public class SshComponentConfiguration
* was enforced by default.
*/
private String keyType;
+ /**
+ * Sets the resource path for a known_hosts file used to verify the SSH
+ * server host key. When not set, the client does not verify the server
host
+ * key against a known_hosts file.
+ */
+ private String knownHostsResource;
/**
* Comma-separated list of allowed/supported message authentication code
* algorithms in their order of preference. The MAC algorithm is used for
@@ -217,22 +220,6 @@ public class SshComponentConfiguration
*/
private String username;
- public Boolean getFailOnUnknownHost() {
- return failOnUnknownHost;
- }
-
- public void setFailOnUnknownHost(Boolean failOnUnknownHost) {
- this.failOnUnknownHost = failOnUnknownHost;
- }
-
- public String getKnownHostsResource() {
- return knownHostsResource;
- }
-
- public void setKnownHostsResource(String knownHostsResource) {
- this.knownHostsResource = knownHostsResource;
- }
-
public Long getTimeout() {
return timeout;
}
@@ -409,6 +396,14 @@ public class SshComponentConfiguration
this.ciphers = ciphers;
}
+ public Boolean getFailOnUnknownHost() {
+ return failOnUnknownHost;
+ }
+
+ public void setFailOnUnknownHost(Boolean failOnUnknownHost) {
+ this.failOnUnknownHost = failOnUnknownHost;
+ }
+
public String getKex() {
return kex;
}
@@ -433,6 +428,14 @@ public class SshComponentConfiguration
this.keyType = keyType;
}
+ public String getKnownHostsResource() {
+ return knownHostsResource;
+ }
+
+ public void setKnownHostsResource(String knownHostsResource) {
+ this.knownHostsResource = knownHostsResource;
+ }
+
public String getMacs() {
return macs;
}
diff --git a/docs/spring-boot/modules/ROOT/pages/starters/ssh.adoc
b/docs/spring-boot/modules/ROOT/pages/starters/ssh.adoc
index ed796b0a604..23707bedbeb 100644
--- a/docs/spring-boot/modules/ROOT/pages/starters/ssh.adoc
+++ b/docs/spring-boot/modules/ROOT/pages/starters/ssh.adoc
@@ -41,7 +41,7 @@ The starter supports 32 options, which are listed below.
| camel.component.ssh.configuration | Component configuration. The option is a
org.apache.camel.component.ssh.SshConfiguration type. | | SshConfiguration
| camel.component.ssh.connect-timeout | Sets the socket connection timeout in
milliseconds. | | Long
| camel.component.ssh.enabled | Whether to enable auto configuration of the
ssh component. This is enabled by default. | | Boolean
-| camel.component.ssh.fail-on-unknown-host | Specifies whether a connection to
an unknown host should fail or not. This value is only checked when the
property knownHosts is set. | false | Boolean
+| camel.component.ssh.fail-on-unknown-host | Specifies whether a connection to
an unknown SSH server host key should fail. When false, host keys that are not
present in the known_hosts resource are accepted. | false | Boolean
| camel.component.ssh.health-check-consumer-enabled | Used for enabling or
disabling all consumer based health checks from this component | true | Boolean
| camel.component.ssh.health-check-producer-enabled | 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 checks globally by setting camel.health.producersEnabled=true. | true
| Boolean
| camel.component.ssh.heartbeat-interval | Sets the heartbeat interval in
milliseconds. If positive, the component will send keep-alive messages to
prevent the SSH session from timing out. | | Long
@@ -50,7 +50,7 @@ The starter supports 32 options, which are listed below.
| camel.component.ssh.kex | Comma-separated list of allowed/supported key
exchange algorithms in their order of preference. | | String
| camel.component.ssh.key-pair-provider | Sets the KeyPairProvider reference
to use when connecting using Certificates to the remote SSH Server. The option
is a org.apache.sshd.common.keyprovider.KeyPairProvider type. | |
KeyPairProvider
| camel.component.ssh.key-type | Sets the key type to pass to the
KeyPairProvider as part of authentication. KeyPairProvider.loadKey(...) will be
passed this value. From Camel 3.0.0 / 2.25.0, by default Camel will select the
first available KeyPair that is loaded. Prior to this, a KeyType of 'ssh-rsa'
was enforced by default. | | String
-| camel.component.ssh.known-hosts-resource | Sets the resource path for a
known_hosts file | | String
+| camel.component.ssh.known-hosts-resource | Sets the resource path for a
known_hosts file used to verify the SSH server host key. When not set, the
client does not verify the server host key against a known_hosts file. | |
String
| camel.component.ssh.lazy-start-producer | Whether the producer should be
started lazy (on the first message). By starting lazy you can use this to allow
CamelContext and routes to startup in situations where a producer may otherwise
fail during starting and cause the route to fail being started. By deferring
this startup to be lazy then the startup failure can be handled during routing
messages via Camel's routing error handlers. Beware that when the first message
is processed then cre [...]
| camel.component.ssh.macs | Comma-separated list of allowed/supported message
authentication code algorithms in their order of preference. The MAC algorithm
is used for data integrity protection. | | String
| camel.component.ssh.password | Sets the password to use in connecting to
remote SSH server. Requires keyPairProvider to be set to null. | | String
