Package org.apache.camel.builder.endpoint.dsl

Interface SshEndpointBuilderFactory.SshEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver, SshEndpointBuilderFactory.SshEndpointConsumerBuilder, SshEndpointBuilderFactory.SshEndpointProducerBuilder

Enclosing interface:

SshEndpointBuilderFactory

public static interface SshEndpointBuilderFactory.SshEndpointBuilder
extends SshEndpointBuilderFactory.SshEndpointConsumerBuilder, SshEndpointBuilderFactory.SshEndpointProducerBuilder

Builder for endpoint for the SSH component.

Method Summary

Modifier and Type	Method	Description
default SshEndpointBuilderFactory.AdvancedSshEndpointBuilder	advanced()
default SshEndpointBuilderFactory.SshEndpointBuilder	certResource(String certResource)	Sets the resource path of the certificate to use for Authentication.
default SshEndpointBuilderFactory.SshEndpointBuilder	certResourcePassword(String certResourcePassword)	Sets the password to use in loading certResource, if certResource is an encrypted key.
default SshEndpointBuilderFactory.SshEndpointBuilder	ciphers(String ciphers)	Comma-separated list of allowed/supported ciphers in their order of preference.
default SshEndpointBuilderFactory.SshEndpointBuilder	failOnUnknownHost(boolean failOnUnknownHost)	Specifies whether a connection to an unknown host should fail or not.
default SshEndpointBuilderFactory.SshEndpointBuilder	failOnUnknownHost(String failOnUnknownHost)	Specifies whether a connection to an unknown host should fail or not.
default SshEndpointBuilderFactory.SshEndpointBuilder	kex(String kex)	Comma-separated list of allowed/supported key exchange algorithms in their order of preference.
default SshEndpointBuilderFactory.SshEndpointBuilder	keyPairProvider(String keyPairProvider)	Sets the KeyPairProvider reference to use when connecting using Certificates to the remote SSH Server.
default SshEndpointBuilderFactory.SshEndpointBuilder	keyPairProvider(org.apache.sshd.common.keyprovider.KeyPairProvider keyPairProvider)	Sets the KeyPairProvider reference to use when connecting using Certificates to the remote SSH Server.
default SshEndpointBuilderFactory.SshEndpointBuilder	keyType(String keyType)	Sets the key type to pass to the KeyPairProvider as part of authentication.
default SshEndpointBuilderFactory.SshEndpointBuilder	knownHostsResource(String knownHostsResource)	Sets the resource path for a known_hosts file.
default SshEndpointBuilderFactory.SshEndpointBuilder	macs(String macs)	Comma-separated list of allowed/supported message authentication code algorithms in their order of preference.
default SshEndpointBuilderFactory.SshEndpointBuilder	password(String password)	Sets the password to use in connecting to remote SSH server.
default SshEndpointBuilderFactory.SshEndpointBuilder	signatures(String signatures)	Comma-separated list of allowed/supported signature algorithms in their order of preference.
default SshEndpointBuilderFactory.SshEndpointBuilder	timeout(long timeout)	Sets the timeout in milliseconds to wait in establishing the remote SSH server connection.
default SshEndpointBuilderFactory.SshEndpointBuilder	timeout(String timeout)	Sets the timeout in milliseconds to wait in establishing the remote SSH server connection.
default SshEndpointBuilderFactory.SshEndpointBuilder	username(String username)	Sets the username to use in logging into the remote SSH server.

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.SshEndpointBuilderFactory.SshEndpointConsumerBuilder

backoffErrorThreshold, backoffErrorThreshold, backoffIdleThreshold, backoffIdleThreshold, backoffMultiplier, backoffMultiplier, delay, delay, greedy, greedy, initialDelay, initialDelay, pollCommand, repeatCount, repeatCount, runLoggingLevel, runLoggingLevel, scheduledExecutorService, scheduledExecutorService, scheduler, scheduler, schedulerProperties, schedulerProperties, sendEmptyMessageWhenIdle, sendEmptyMessageWhenIdle, startScheduler, startScheduler, timeUnit, timeUnit, useFixedDelay, useFixedDelay

Method Details

advanced

default SshEndpointBuilderFactory.AdvancedSshEndpointBuilder advanced()

Specified by:

advanced in interface SshEndpointBuilderFactory.SshEndpointConsumerBuilder

Specified by:

advanced in interface SshEndpointBuilderFactory.SshEndpointProducerBuilder

failOnUnknownHost

default SshEndpointBuilderFactory.SshEndpointBuilder failOnUnknownHost(boolean failOnUnknownHost)

Specifies whether a connection to an unknown host should fail or not. This value is only checked when the property knownHosts is set. The option is a: <code>boolean</code> type. Default: false Group: common

Specified by:

failOnUnknownHost in interface SshEndpointBuilderFactory.SshEndpointConsumerBuilder

Specified by:

failOnUnknownHost in interface SshEndpointBuilderFactory.SshEndpointProducerBuilder

Parameters:

failOnUnknownHost - the value to set

Returns:

the dsl builder

failOnUnknownHost

default SshEndpointBuilderFactory.SshEndpointBuilder failOnUnknownHost(String failOnUnknownHost)

Specifies whether a connection to an unknown host should fail or not. This value is only checked when the property knownHosts is set. The option will be converted to a <code>boolean</code> type. Default: false Group: common

Specified by:

failOnUnknownHost in interface SshEndpointBuilderFactory.SshEndpointConsumerBuilder

Specified by:

failOnUnknownHost in interface SshEndpointBuilderFactory.SshEndpointProducerBuilder

Parameters:

failOnUnknownHost - the value to set

Returns:

the dsl builder

knownHostsResource

default SshEndpointBuilderFactory.SshEndpointBuilder knownHostsResource(String knownHostsResource)

Sets the resource path for a known_hosts file. The option is a: <code>java.lang.String</code> type. Group: common

Specified by:

knownHostsResource in interface SshEndpointBuilderFactory.SshEndpointConsumerBuilder

Specified by:

knownHostsResource in interface SshEndpointBuilderFactory.SshEndpointProducerBuilder

Parameters:

knownHostsResource - the value to set

Returns:

the dsl builder

timeout

default SshEndpointBuilderFactory.SshEndpointBuilder timeout(long timeout)

Sets the timeout in milliseconds to wait in establishing the remote SSH server connection. Defaults to 30000 milliseconds. The option is a: <code>long</code> type. Default: 30000 Group: common

Specified by:

timeout in interface SshEndpointBuilderFactory.SshEndpointConsumerBuilder

Specified by:

timeout in interface SshEndpointBuilderFactory.SshEndpointProducerBuilder

Parameters:

timeout - the value to set

Returns:

the dsl builder

timeout

default SshEndpointBuilderFactory.SshEndpointBuilder timeout(String timeout)

Sets the timeout in milliseconds to wait in establishing the remote SSH server connection. Defaults to 30000 milliseconds. The option will be converted to a <code>long</code> type. Default: 30000 Group: common

Specified by:

timeout in interface SshEndpointBuilderFactory.SshEndpointConsumerBuilder

Specified by:

timeout in interface SshEndpointBuilderFactory.SshEndpointProducerBuilder

Parameters:

timeout - the value to set

Returns:

the dsl builder

certResource

default SshEndpointBuilderFactory.SshEndpointBuilder certResource(String certResource)

Sets the resource path of the certificate to use for Authentication. Will use ResourceHelperKeyPairProvider to resolve file based certificate, and depends on keyType setting. The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

certResource in interface SshEndpointBuilderFactory.SshEndpointConsumerBuilder

Specified by:

certResource in interface SshEndpointBuilderFactory.SshEndpointProducerBuilder

Parameters:

certResource - the value to set

Returns:

the dsl builder

certResourcePassword

default SshEndpointBuilderFactory.SshEndpointBuilder certResourcePassword(String certResourcePassword)

Sets the password to use in loading certResource, if certResource is an encrypted key. The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

certResourcePassword in interface SshEndpointBuilderFactory.SshEndpointConsumerBuilder

Specified by:

certResourcePassword in interface SshEndpointBuilderFactory.SshEndpointProducerBuilder

Parameters:

certResourcePassword - the value to set

Returns:

the dsl builder

ciphers

default SshEndpointBuilderFactory.SshEndpointBuilder ciphers(String ciphers)

Comma-separated list of allowed/supported ciphers in their order of preference. The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

ciphers in interface SshEndpointBuilderFactory.SshEndpointConsumerBuilder

Specified by:

ciphers in interface SshEndpointBuilderFactory.SshEndpointProducerBuilder

Parameters:

ciphers - the value to set

Returns:

the dsl builder

kex

default SshEndpointBuilderFactory.SshEndpointBuilder kex(String kex)

Comma-separated list of allowed/supported key exchange algorithms in their order of preference. The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

kex in interface SshEndpointBuilderFactory.SshEndpointConsumerBuilder

Specified by:

kex in interface SshEndpointBuilderFactory.SshEndpointProducerBuilder

Parameters:

kex - the value to set

Returns:

the dsl builder

keyPairProvider

default SshEndpointBuilderFactory.SshEndpointBuilder keyPairProvider(org.apache.sshd.common.keyprovider.KeyPairProvider keyPairProvider)

Sets the KeyPairProvider reference to use when connecting using Certificates to the remote SSH Server. The option is a: <code>org.apache.sshd.common.keyprovider.KeyPairProvider</code> type. Group: security

Specified by:

keyPairProvider in interface SshEndpointBuilderFactory.SshEndpointConsumerBuilder

Specified by:

keyPairProvider in interface SshEndpointBuilderFactory.SshEndpointProducerBuilder

Parameters:

keyPairProvider - the value to set

Returns:

the dsl builder

keyPairProvider

default SshEndpointBuilderFactory.SshEndpointBuilder keyPairProvider(String keyPairProvider)

Sets the KeyPairProvider reference to use when connecting using Certificates to the remote SSH Server. The option will be converted to a <code>org.apache.sshd.common.keyprovider.KeyPairProvider</code> type. Group: security

Specified by:

keyPairProvider in interface SshEndpointBuilderFactory.SshEndpointConsumerBuilder

Specified by:

keyPairProvider in interface SshEndpointBuilderFactory.SshEndpointProducerBuilder

Parameters:

keyPairProvider - the value to set

Returns:

the dsl builder

keyType

default SshEndpointBuilderFactory.SshEndpointBuilder keyType(String keyType)

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. The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

keyType in interface SshEndpointBuilderFactory.SshEndpointConsumerBuilder

Specified by:

keyType in interface SshEndpointBuilderFactory.SshEndpointProducerBuilder

Parameters:

keyType - the value to set

Returns:

the dsl builder

macs

default SshEndpointBuilderFactory.SshEndpointBuilder macs(String 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. The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

macs in interface SshEndpointBuilderFactory.SshEndpointConsumerBuilder

Specified by:

macs in interface SshEndpointBuilderFactory.SshEndpointProducerBuilder

Parameters:

macs - the value to set

Returns:

the dsl builder

password

default SshEndpointBuilderFactory.SshEndpointBuilder password(String password)

Sets the password to use in connecting to remote SSH server. Requires keyPairProvider to be set to null. The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

password in interface SshEndpointBuilderFactory.SshEndpointConsumerBuilder

Specified by:

password in interface SshEndpointBuilderFactory.SshEndpointProducerBuilder

Parameters:

password - the value to set

Returns:

the dsl builder

signatures

default SshEndpointBuilderFactory.SshEndpointBuilder signatures(String signatures)

Comma-separated list of allowed/supported signature algorithms in their order of preference. The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

signatures in interface SshEndpointBuilderFactory.SshEndpointConsumerBuilder

Specified by:

signatures in interface SshEndpointBuilderFactory.SshEndpointProducerBuilder

Parameters:

signatures - the value to set

Returns:

the dsl builder

username

default SshEndpointBuilderFactory.SshEndpointBuilder username(String username)

Sets the username to use in logging into the remote SSH server. The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

username in interface SshEndpointBuilderFactory.SshEndpointConsumerBuilder

Specified by:

username in interface SshEndpointBuilderFactory.SshEndpointProducerBuilder

Parameters:

username - the value to set

Returns:

the dsl builder