This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel-spring-boot.git
The following commit(s) were added to refs/heads/main by this push:
new c1593185bc6 Regen
c1593185bc6 is described below
commit c1593185bc6f18c612ff88edea00b20b5a58b781
Author: Claus Ibsen <[email protected]>
AuthorDate: Tue Feb 17 14:12:13 2026 +0100
Regen
---
.../camel/springboot/catalog/components/ssh.json | 82 +++++++++++-----------
.../camel-ssh-starter/src/main/docs/ssh.json | 6 ++
.../ssh/springboot/SshComponentConfiguration.java | 14 ++++
3 files changed, 62 insertions(+), 40 deletions(-)
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 eb7d008cedc..06c3b6d1def 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
@@ -36,20 +36,21 @@
"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" },
- "shellPrompt": { "index": 11, "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": 12, "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": 13, "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": 14, "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": 15, "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": 16, "kind": "property", "displayName":
"Cert Resource Password", "group": "security", "label": "security", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the password to use in loading
certResource, if certResource is an encrypted key." },
- "ciphers": { "index": 17, "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": 18, "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": 19, "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": 20, "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 [...]
- "macs": { "index": 21, "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": 22, "kind": "property", "displayName": "Password",
"group": "security", "label": "security", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": true, "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 to null." },
- "signatures": { "index": 23, "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." },
- "username": { "index": 24, "kind": "property", "displayName": "Username",
"group": "security", "label": "security", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": true, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the username to use in logging into the
remote SSH server." }
+ "idleTimeout": { "index": 11, "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": 12, "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": 13, "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": 14, "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": 15, "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": 16, "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": 17, "kind": "property", "displayName":
"Cert Resource Password", "group": "security", "label": "security", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the password to use in loading
certResource, if certResource is an encrypted key." },
+ "ciphers": { "index": 18, "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": 19, "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": 20, "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": 21, "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 [...]
+ "macs": { "index": 22, "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": 23, "kind": "property", "displayName": "Password",
"group": "security", "label": "security", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": true, "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 to null." },
+ "signatures": { "index": 24, "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." },
+ "username": { "index": 25, "kind": "property", "displayName": "Username",
"group": "security", "label": "security", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": true, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the username to use in logging into the
remote SSH server." }
},
"headers": {
"CamelSshUsername": { "index": 0, "kind": "header", "displayName": "",
"group": "common", "label": "", "required": false, "javaType": "String",
"deprecated": false, "deprecationNote": "", "autowired": false, "secret":
false, "description": "The user name", "constantName":
"org.apache.camel.component.ssh.SshConstants#USERNAME_HEADER" },
@@ -73,31 +74,32 @@
"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."
},
- "shellPrompt": { "index": 15, "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": 16, "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": 17, "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": 18, "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": 19, "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": 20, "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": 21, "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": 22, "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": 23, "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": 24, "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": 25, "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": 26, "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": 27, "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": 28, "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": 29, "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": 30, "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": 31, "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": 32, "kind": "parameter", "displayName":
"Cert Resource Password", "group": "security", "label": "security", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the password to use in loading
certResource, if certResource is an encrypted key." },
- "ciphers": { "index": 33, "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": 34, "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": 35, "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": 36, "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 [...]
- "macs": { "index": 37, "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": 38, "kind": "parameter", "displayName": "Password",
"group": "security", "label": "security", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": true, "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 to null." },
- "signatures": { "index": 39, "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." },
- "username": { "index": 40, "kind": "parameter", "displayName": "Username",
"group": "security", "label": "security", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": true, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the username to use in logging into the
remote SSH server." }
+ "idleTimeout": { "index": 15, "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": 16, "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": 17, "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": 18, "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": 19, "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": 20, "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": 21, "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": 22, "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": 23, "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": 24, "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": 25, "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": 26, "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": 27, "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": 28, "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": 29, "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": 30, "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": 31, "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": 32, "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": 33, "kind": "parameter", "displayName":
"Cert Resource Password", "group": "security", "label": "security", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the password to use in loading
certResource, if certResource is an encrypted key." },
+ "ciphers": { "index": 34, "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": 35, "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": 36, "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": 37, "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 [...]
+ "macs": { "index": 38, "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": 39, "kind": "parameter", "displayName": "Password",
"group": "security", "label": "security", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": true, "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 to null." },
+ "signatures": { "index": 40, "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." },
+ "username": { "index": 41, "kind": "parameter", "displayName": "Username",
"group": "security", "label": "security", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": true, "configurationClass":
"org.apache.camel.component.ssh.SshConfiguration", "configurationField":
"configuration", "description": "Sets the username to use in logging into the
remote SSH server." }
}
}
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 245bfff578f..9795bebc656 100644
--- a/components-starter/camel-ssh-starter/src/main/docs/ssh.json
+++ b/components-starter/camel-ssh-starter/src/main/docs/ssh.json
@@ -102,6 +102,12 @@
"sourceType":
"org.apache.camel.component.ssh.springboot.SshComponentConfiguration",
"defaultValue": true
},
+ {
+ "name": "camel.component.ssh.idle-timeout",
+ "type": "java.lang.Long",
+ "description": "Sets the timeout in milliseconds to wait before the SSH
session is closed due to inactivity. The default value is 0, which means no
idle timeout is applied.",
+ "sourceType":
"org.apache.camel.component.ssh.springboot.SshComponentConfiguration"
+ },
{
"name": "camel.component.ssh.kex",
"type": "java.lang.String",
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 72f680e4c25..8306400022e 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
@@ -111,6 +111,12 @@ public class SshComponentConfiguration
* org.apache.camel.component.ssh.SshConfiguration type.
*/
private SshConfiguration configuration;
+ /**
+ * Sets the timeout in milliseconds to wait before the SSH session is
closed
+ * due to inactivity. The default value is 0, which means no idle timeout
is
+ * applied.
+ */
+ private Long idleTimeout;
/**
* Sets the shellPrompt to be dropped when response is read after command
* execution
@@ -277,6 +283,14 @@ public class SshComponentConfiguration
this.configuration = configuration;
}
+ public Long getIdleTimeout() {
+ return idleTimeout;
+ }
+
+ public void setIdleTimeout(Long idleTimeout) {
+ this.idleTimeout = idleTimeout;
+ }
+
public String getShellPrompt() {
return shellPrompt;
}
