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

Interface FtpsEndpointBuilderFactory.FtpsEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver, FtpsEndpointBuilderFactory.FtpsEndpointConsumerBuilder, FtpsEndpointBuilderFactory.FtpsEndpointProducerBuilder

Enclosing interface:

FtpsEndpointBuilderFactory

public static interface FtpsEndpointBuilderFactory.FtpsEndpointBuilder
extends FtpsEndpointBuilderFactory.FtpsEndpointConsumerBuilder, FtpsEndpointBuilderFactory.FtpsEndpointProducerBuilder

Builder for endpoint for the FTPS component.

Method Summary

Modifier and Type	Method	Description
default FtpsEndpointBuilderFactory.FtpsEndpointBuilder	account(String account)	Account to use for login.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointBuilder	advanced()
default FtpsEndpointBuilderFactory.FtpsEndpointBuilder	binary(boolean binary)	Specifies the file transfer mode, BINARY or ASCII.
default FtpsEndpointBuilderFactory.FtpsEndpointBuilder	binary(String binary)	Specifies the file transfer mode, BINARY or ASCII.
default FtpsEndpointBuilderFactory.FtpsEndpointBuilder	charset(String charset)	This option is used to specify the encoding of the file.
default FtpsEndpointBuilderFactory.FtpsEndpointBuilder	disableSecureDataChannelDefaults(boolean disableSecureDataChannelDefaults)	Use this option to disable default options when using secure data channel.
default FtpsEndpointBuilderFactory.FtpsEndpointBuilder	disableSecureDataChannelDefaults(String disableSecureDataChannelDefaults)	Use this option to disable default options when using secure data channel.
default FtpsEndpointBuilderFactory.FtpsEndpointBuilder	disconnect(boolean disconnect)	Whether or not to disconnect from remote FTP server right after use.
default FtpsEndpointBuilderFactory.FtpsEndpointBuilder	disconnect(String disconnect)	Whether or not to disconnect from remote FTP server right after use.
default FtpsEndpointBuilderFactory.FtpsEndpointBuilder	doneFileName(String doneFileName)	Producer: If provided, then Camel will write a 2nd done file when the original file has been written.
default FtpsEndpointBuilderFactory.FtpsEndpointBuilder	execPbsz(Long execPbsz)	When using secure data channel you can set the exec protection buffer size.
default FtpsEndpointBuilderFactory.FtpsEndpointBuilder	execPbsz(String execPbsz)	When using secure data channel you can set the exec protection buffer size.
default FtpsEndpointBuilderFactory.FtpsEndpointBuilder	execProt(String execProt)	The exec protection level PROT command.
default FtpsEndpointBuilderFactory.FtpsEndpointBuilder	fileName(String fileName)	Use Expression such as File Language to dynamically set the filename.
default FtpsEndpointBuilderFactory.FtpsEndpointBuilder	ftpClientKeyStoreParameters(String key, Object value)	Set the key store parameters.
default FtpsEndpointBuilderFactory.FtpsEndpointBuilder	ftpClientKeyStoreParameters(Map values)	Set the key store parameters.
default FtpsEndpointBuilderFactory.FtpsEndpointBuilder	ftpClientTrustStoreParameters(String key, Object value)	Set the trust store parameters.
default FtpsEndpointBuilderFactory.FtpsEndpointBuilder	ftpClientTrustStoreParameters(Map values)	Set the trust store parameters.
default FtpsEndpointBuilderFactory.FtpsEndpointBuilder	implicit(boolean implicit)	Set the security mode (Implicit/Explicit).
default FtpsEndpointBuilderFactory.FtpsEndpointBuilder	implicit(String implicit)	Set the security mode (Implicit/Explicit).
default FtpsEndpointBuilderFactory.FtpsEndpointBuilder	passiveMode(boolean passiveMode)	Sets passive mode connections.
default FtpsEndpointBuilderFactory.FtpsEndpointBuilder	passiveMode(String passiveMode)	Sets passive mode connections.
default FtpsEndpointBuilderFactory.FtpsEndpointBuilder	password(String password)	Password to use for login.
default FtpsEndpointBuilderFactory.FtpsEndpointBuilder	securityProtocol(String securityProtocol)	Set the underlying security protocol.
default FtpsEndpointBuilderFactory.FtpsEndpointBuilder	separator(String separator)	Sets the path separator to be used.
default FtpsEndpointBuilderFactory.FtpsEndpointBuilder	separator(org.apache.camel.component.file.remote.RemoteFileConfiguration.PathSeparator separator)	Sets the path separator to be used.
default FtpsEndpointBuilderFactory.FtpsEndpointBuilder	sslContextParameters(String sslContextParameters)	Gets the JSSE configuration that overrides any settings in FtpsEndpoint#ftpClientKeyStoreParameters, ftpClientTrustStoreParameters, and FtpsConfiguration#getSecurityProtocol().
default FtpsEndpointBuilderFactory.FtpsEndpointBuilder	sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)	Gets the JSSE configuration that overrides any settings in FtpsEndpoint#ftpClientKeyStoreParameters, ftpClientTrustStoreParameters, and FtpsConfiguration#getSecurityProtocol().
default FtpsEndpointBuilderFactory.FtpsEndpointBuilder	transferLoggingIntervalSeconds(int transferLoggingIntervalSeconds)	Configures the interval in seconds to use when logging the progress of upload and download operations that are in-flight.
default FtpsEndpointBuilderFactory.FtpsEndpointBuilder	transferLoggingIntervalSeconds(String transferLoggingIntervalSeconds)	Configures the interval in seconds to use when logging the progress of upload and download operations that are in-flight.
default FtpsEndpointBuilderFactory.FtpsEndpointBuilder	transferLoggingLevel(String transferLoggingLevel)	Configure the logging level to use when logging the progress of upload and download operations.
default FtpsEndpointBuilderFactory.FtpsEndpointBuilder	transferLoggingLevel(org.apache.camel.LoggingLevel transferLoggingLevel)	Configure the logging level to use when logging the progress of upload and download operations.
default FtpsEndpointBuilderFactory.FtpsEndpointBuilder	transferLoggingVerbose(boolean transferLoggingVerbose)	Configures whether the perform verbose (fine grained) logging of the progress of upload and download operations.
default FtpsEndpointBuilderFactory.FtpsEndpointBuilder	transferLoggingVerbose(String transferLoggingVerbose)	Configures whether the perform verbose (fine grained) logging of the progress of upload and download operations.
default FtpsEndpointBuilderFactory.FtpsEndpointBuilder	username(String username)	Username to use for login.

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.FtpsEndpointBuilderFactory.FtpsEndpointConsumerBuilder

antExclude, antFilterCaseSensitive, antFilterCaseSensitive, antInclude, backoffErrorThreshold, backoffErrorThreshold, backoffIdleThreshold, backoffIdleThreshold, backoffMultiplier, backoffMultiplier, delay, delay, delete, delete, eagerMaxMessagesPerPoll, eagerMaxMessagesPerPoll, exclude, excludeExt, exclusiveReadLockStrategy, exclusiveReadLockStrategy, filter, filter, filterDirectory, filterFile, greedy, greedy, idempotent, idempotent, idempotentKey, idempotentRepository, idempotentRepository, include, includeExt, initialDelay, initialDelay, maxDepth, maxDepth, maxMessagesPerPoll, maxMessagesPerPoll, minDepth, minDepth, move, moveFailed, noop, noop, preMove, preSort, preSort, readLock, readLockCheckInterval, readLockCheckInterval, readLockDeleteOrphanLockFiles, readLockDeleteOrphanLockFiles, readLockLoggingLevel, readLockLoggingLevel, readLockMarkerFile, readLockMarkerFile, readLockMinAge, readLockMinAge, readLockMinLength, readLockMinLength, readLockRemoveOnCommit, readLockRemoveOnCommit, readLockRemoveOnRollback, readLockRemoveOnRollback, readLockTimeout, readLockTimeout, recursive, recursive, repeatCount, repeatCount, resumeDownload, resumeDownload, runLoggingLevel, runLoggingLevel, scheduledExecutorService, scheduledExecutorService, scheduler, scheduler, schedulerProperties, schedulerProperties, sendEmptyMessageWhenIdle, sendEmptyMessageWhenIdle, shuffle, shuffle, sortBy, sorter, sorter, startScheduler, startScheduler, streamDownload, streamDownload, timeUnit, timeUnit, useFixedDelay, useFixedDelay

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.FtpsEndpointBuilderFactory.FtpsEndpointProducerBuilder

fileExist, fileExist, flatten, flatten, jailStartingDirectory, jailStartingDirectory, moveExisting, tempFileName, tempPrefix

Method Details

advanced

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointBuilder advanced()

Specified by:

advanced in interface FtpsEndpointBuilderFactory.FtpsEndpointConsumerBuilder

Specified by:

advanced in interface FtpsEndpointBuilderFactory.FtpsEndpointProducerBuilder

binary

default FtpsEndpointBuilderFactory.FtpsEndpointBuilder binary(boolean binary)

Specifies the file transfer mode, BINARY or ASCII. Default is ASCII (false). The option is a: <code>boolean</code> type. Default: false Group: common

Specified by:

binary in interface FtpsEndpointBuilderFactory.FtpsEndpointConsumerBuilder

Specified by:

binary in interface FtpsEndpointBuilderFactory.FtpsEndpointProducerBuilder

Parameters:

binary - the value to set

Returns:

the dsl builder

binary

default FtpsEndpointBuilderFactory.FtpsEndpointBuilder binary(String binary)

Specifies the file transfer mode, BINARY or ASCII. Default is ASCII (false). The option will be converted to a <code>boolean</code> type. Default: false Group: common

Specified by:

binary in interface FtpsEndpointBuilderFactory.FtpsEndpointConsumerBuilder

Specified by:

binary in interface FtpsEndpointBuilderFactory.FtpsEndpointProducerBuilder

Parameters:

binary - the value to set

Returns:

the dsl builder

charset

default FtpsEndpointBuilderFactory.FtpsEndpointBuilder charset(String charset)

This option is used to specify the encoding of the file. You can use this on the consumer, to specify the encodings of the files, which allow Camel to know the charset it should load the file content in case the file content is being accessed. Likewise when writing a file, you can use this option to specify which charset to write the file as well. Do mind that when writing the file Camel may have to read the message content into memory to be able to convert the data into the configured charset, so do not use this if you have big messages. The option is a: <code>java.lang.String</code> type. Group: common

Specified by:

charset in interface FtpsEndpointBuilderFactory.FtpsEndpointConsumerBuilder

Specified by:

charset in interface FtpsEndpointBuilderFactory.FtpsEndpointProducerBuilder

Parameters:

charset - the value to set

Returns:

the dsl builder

disconnect

default FtpsEndpointBuilderFactory.FtpsEndpointBuilder disconnect(boolean disconnect)

Whether or not to disconnect from remote FTP server right after use. Disconnect will only disconnect the current connection to the FTP server. If you have a consumer which you want to stop, then you need to stop the consumer/route instead. The option is a: <code>boolean</code> type. Default: false Group: common

Specified by:

disconnect in interface FtpsEndpointBuilderFactory.FtpsEndpointConsumerBuilder

Specified by:

disconnect in interface FtpsEndpointBuilderFactory.FtpsEndpointProducerBuilder

Parameters:

disconnect - the value to set

Returns:

the dsl builder

disconnect

default FtpsEndpointBuilderFactory.FtpsEndpointBuilder disconnect(String disconnect)

Whether or not to disconnect from remote FTP server right after use. Disconnect will only disconnect the current connection to the FTP server. If you have a consumer which you want to stop, then you need to stop the consumer/route instead. The option will be converted to a <code>boolean</code> type. Default: false Group: common

Specified by:

disconnect in interface FtpsEndpointBuilderFactory.FtpsEndpointConsumerBuilder

Specified by:

disconnect in interface FtpsEndpointBuilderFactory.FtpsEndpointProducerBuilder

Parameters:

disconnect - the value to set

Returns:

the dsl builder

doneFileName

default FtpsEndpointBuilderFactory.FtpsEndpointBuilder doneFileName(String doneFileName)

Producer: If provided, then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Consumer: If provided, Camel will only consume files if a done file exists. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders.The done file is always expected in the same folder as the original file. Only ${file.name} and ${file.name.next} is supported as dynamic placeholders. The option is a: <code>java.lang.String</code> type. Group: common

Specified by:

doneFileName in interface FtpsEndpointBuilderFactory.FtpsEndpointConsumerBuilder

Specified by:

doneFileName in interface FtpsEndpointBuilderFactory.FtpsEndpointProducerBuilder

Parameters:

doneFileName - the value to set

Returns:

the dsl builder

fileName

default FtpsEndpointBuilderFactory.FtpsEndpointBuilder fileName(String fileName)

Use Expression such as File Language to dynamically set the filename. For consumers, it's used as a filename filter. For producers, it's used to evaluate the filename to write. If an expression is set, it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type, it is always evaluated using the File Language. If the expression is an Expression type, the specified Expression type is used - this allows you, for instance, to use OGNL expressions. For the consumer, you can use it to filter filenames, so you can for instance consume today's file using the File Language syntax: mydata-${date:now:yyyyMMdd}.txt. The producers support the CamelOverruleFileName header which takes precedence over any existing CamelFileName header; the CamelOverruleFileName is a header that is used only once, and makes it easier as this avoids to temporary store CamelFileName and have to restore it afterwards. The option is a: <code>java.lang.String</code> type. Group: common

Specified by:

fileName in interface FtpsEndpointBuilderFactory.FtpsEndpointConsumerBuilder

Specified by:

fileName in interface FtpsEndpointBuilderFactory.FtpsEndpointProducerBuilder

Parameters:

fileName - the value to set

Returns:

the dsl builder

passiveMode

default FtpsEndpointBuilderFactory.FtpsEndpointBuilder passiveMode(boolean passiveMode)

Sets passive mode connections. Default is active mode connections. The option is a: <code>boolean</code> type. Default: false Group: common

Specified by:

passiveMode in interface FtpsEndpointBuilderFactory.FtpsEndpointConsumerBuilder

Specified by:

passiveMode in interface FtpsEndpointBuilderFactory.FtpsEndpointProducerBuilder

Parameters:

passiveMode - the value to set

Returns:

the dsl builder

passiveMode

default FtpsEndpointBuilderFactory.FtpsEndpointBuilder passiveMode(String passiveMode)

Sets passive mode connections. Default is active mode connections. The option will be converted to a <code>boolean</code> type. Default: false Group: common

Specified by:

passiveMode in interface FtpsEndpointBuilderFactory.FtpsEndpointConsumerBuilder

Specified by:

passiveMode in interface FtpsEndpointBuilderFactory.FtpsEndpointProducerBuilder

Parameters:

passiveMode - the value to set

Returns:

the dsl builder

separator

default FtpsEndpointBuilderFactory.FtpsEndpointBuilder separator(org.apache.camel.component.file.remote.RemoteFileConfiguration.PathSeparator separator)

Sets the path separator to be used. UNIX = Uses unix style path separator Windows = Uses windows style path separator Auto = (is default) Use existing path separator in file name. The option is a: <code>org.apache.camel.component.file.remote.RemoteFileConfiguration.PathSeparator</code> type. Default: UNIX Group: common

Specified by:

separator in interface FtpsEndpointBuilderFactory.FtpsEndpointConsumerBuilder

Specified by:

separator in interface FtpsEndpointBuilderFactory.FtpsEndpointProducerBuilder

Parameters:

separator - the value to set

Returns:

the dsl builder

separator

default FtpsEndpointBuilderFactory.FtpsEndpointBuilder separator(String separator)

Sets the path separator to be used. UNIX = Uses unix style path separator Windows = Uses windows style path separator Auto = (is default) Use existing path separator in file name. The option will be converted to a <code>org.apache.camel.component.file.remote.RemoteFileConfiguration.PathSeparator</code> type. Default: UNIX Group: common

Specified by:

separator in interface FtpsEndpointBuilderFactory.FtpsEndpointConsumerBuilder

Specified by:

separator in interface FtpsEndpointBuilderFactory.FtpsEndpointProducerBuilder

Parameters:

separator - the value to set

Returns:

the dsl builder

transferLoggingIntervalSeconds

default FtpsEndpointBuilderFactory.FtpsEndpointBuilder transferLoggingIntervalSeconds(int transferLoggingIntervalSeconds)

Configures the interval in seconds to use when logging the progress of upload and download operations that are in-flight. This is used for logging progress when operations takes longer time. The option is a: <code>int</code> type. Default: 5 Group: common

Specified by:

transferLoggingIntervalSeconds in interface FtpsEndpointBuilderFactory.FtpsEndpointConsumerBuilder

Specified by:

transferLoggingIntervalSeconds in interface FtpsEndpointBuilderFactory.FtpsEndpointProducerBuilder

Parameters:

transferLoggingIntervalSeconds - the value to set

Returns:

the dsl builder

transferLoggingIntervalSeconds

default FtpsEndpointBuilderFactory.FtpsEndpointBuilder transferLoggingIntervalSeconds(String transferLoggingIntervalSeconds)

Configures the interval in seconds to use when logging the progress of upload and download operations that are in-flight. This is used for logging progress when operations takes longer time. The option will be converted to a <code>int</code> type. Default: 5 Group: common

Specified by:

transferLoggingIntervalSeconds in interface FtpsEndpointBuilderFactory.FtpsEndpointConsumerBuilder

Specified by:

transferLoggingIntervalSeconds in interface FtpsEndpointBuilderFactory.FtpsEndpointProducerBuilder

Parameters:

transferLoggingIntervalSeconds - the value to set

Returns:

the dsl builder

transferLoggingLevel

default FtpsEndpointBuilderFactory.FtpsEndpointBuilder transferLoggingLevel(org.apache.camel.LoggingLevel transferLoggingLevel)

Configure the logging level to use when logging the progress of upload and download operations. The option is a: <code>org.apache.camel.LoggingLevel</code> type. Default: DEBUG Group: common

Specified by:

transferLoggingLevel in interface FtpsEndpointBuilderFactory.FtpsEndpointConsumerBuilder

Specified by:

transferLoggingLevel in interface FtpsEndpointBuilderFactory.FtpsEndpointProducerBuilder

Parameters:

transferLoggingLevel - the value to set

Returns:

the dsl builder

transferLoggingLevel

default FtpsEndpointBuilderFactory.FtpsEndpointBuilder transferLoggingLevel(String transferLoggingLevel)

Configure the logging level to use when logging the progress of upload and download operations. The option will be converted to a <code>org.apache.camel.LoggingLevel</code> type. Default: DEBUG Group: common

Specified by:

transferLoggingLevel in interface FtpsEndpointBuilderFactory.FtpsEndpointConsumerBuilder

Specified by:

transferLoggingLevel in interface FtpsEndpointBuilderFactory.FtpsEndpointProducerBuilder

Parameters:

transferLoggingLevel - the value to set

Returns:

the dsl builder

transferLoggingVerbose

default FtpsEndpointBuilderFactory.FtpsEndpointBuilder transferLoggingVerbose(boolean transferLoggingVerbose)

Configures whether the perform verbose (fine grained) logging of the progress of upload and download operations. The option is a: <code>boolean</code> type. Default: false Group: common

Specified by:

transferLoggingVerbose in interface FtpsEndpointBuilderFactory.FtpsEndpointConsumerBuilder

Specified by:

transferLoggingVerbose in interface FtpsEndpointBuilderFactory.FtpsEndpointProducerBuilder

Parameters:

transferLoggingVerbose - the value to set

Returns:

the dsl builder

transferLoggingVerbose

default FtpsEndpointBuilderFactory.FtpsEndpointBuilder transferLoggingVerbose(String transferLoggingVerbose)

Configures whether the perform verbose (fine grained) logging of the progress of upload and download operations. The option will be converted to a <code>boolean</code> type. Default: false Group: common

Specified by:

transferLoggingVerbose in interface FtpsEndpointBuilderFactory.FtpsEndpointConsumerBuilder

Specified by:

transferLoggingVerbose in interface FtpsEndpointBuilderFactory.FtpsEndpointProducerBuilder

Parameters:

transferLoggingVerbose - the value to set

Returns:

the dsl builder

account

default FtpsEndpointBuilderFactory.FtpsEndpointBuilder account(String account)

Account to use for login. The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

account in interface FtpsEndpointBuilderFactory.FtpsEndpointConsumerBuilder

Specified by:

account in interface FtpsEndpointBuilderFactory.FtpsEndpointProducerBuilder

Parameters:

account - the value to set

Returns:

the dsl builder

disableSecureDataChannelDefaults

default FtpsEndpointBuilderFactory.FtpsEndpointBuilder disableSecureDataChannelDefaults(boolean disableSecureDataChannelDefaults)

Use this option to disable default options when using secure data channel. This allows you to be in full control what the execPbsz and execProt setting should be used. Default is false. The option is a: <code>boolean</code> type. Default: false Group: security

Specified by:

disableSecureDataChannelDefaults in interface FtpsEndpointBuilderFactory.FtpsEndpointConsumerBuilder

Specified by:

disableSecureDataChannelDefaults in interface FtpsEndpointBuilderFactory.FtpsEndpointProducerBuilder

Parameters:

disableSecureDataChannelDefaults - the value to set

Returns:

the dsl builder

disableSecureDataChannelDefaults

default FtpsEndpointBuilderFactory.FtpsEndpointBuilder disableSecureDataChannelDefaults(String disableSecureDataChannelDefaults)

Use this option to disable default options when using secure data channel. This allows you to be in full control what the execPbsz and execProt setting should be used. Default is false. The option will be converted to a <code>boolean</code> type. Default: false Group: security

Specified by:

disableSecureDataChannelDefaults in interface FtpsEndpointBuilderFactory.FtpsEndpointConsumerBuilder

Specified by:

disableSecureDataChannelDefaults in interface FtpsEndpointBuilderFactory.FtpsEndpointProducerBuilder

Parameters:

disableSecureDataChannelDefaults - the value to set

Returns:

the dsl builder

execPbsz

default FtpsEndpointBuilderFactory.FtpsEndpointBuilder execPbsz(Long execPbsz)

When using secure data channel you can set the exec protection buffer size. The option is a: <code>java.lang.Long</code> type. Group: security

Specified by:

execPbsz in interface FtpsEndpointBuilderFactory.FtpsEndpointConsumerBuilder

Specified by:

execPbsz in interface FtpsEndpointBuilderFactory.FtpsEndpointProducerBuilder

Parameters:

execPbsz - the value to set

Returns:

the dsl builder

execPbsz

default FtpsEndpointBuilderFactory.FtpsEndpointBuilder execPbsz(String execPbsz)

When using secure data channel you can set the exec protection buffer size. The option will be converted to a <code>java.lang.Long</code> type. Group: security

Specified by:

execPbsz in interface FtpsEndpointBuilderFactory.FtpsEndpointConsumerBuilder

Specified by:

execPbsz in interface FtpsEndpointBuilderFactory.FtpsEndpointProducerBuilder

Parameters:

execPbsz - the value to set

Returns:

the dsl builder

execProt

default FtpsEndpointBuilderFactory.FtpsEndpointBuilder execProt(String execProt)

The exec protection level PROT command. C - Clear S - Safe(SSL protocol only) E - Confidential(SSL protocol only) P - Private. The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

execProt in interface FtpsEndpointBuilderFactory.FtpsEndpointConsumerBuilder

Specified by:

execProt in interface FtpsEndpointBuilderFactory.FtpsEndpointProducerBuilder

Parameters:

execProt - the value to set

Returns:

the dsl builder

ftpClientKeyStoreParameters

default FtpsEndpointBuilderFactory.FtpsEndpointBuilder ftpClientKeyStoreParameters(String key,
 Object value)

Set the key store parameters. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the ftpClientKeyStoreParameters(String, Object) method to add a value (call the method multiple times to set more values). Group: security

Specified by:

ftpClientKeyStoreParameters in interface FtpsEndpointBuilderFactory.FtpsEndpointConsumerBuilder

Specified by:

ftpClientKeyStoreParameters in interface FtpsEndpointBuilderFactory.FtpsEndpointProducerBuilder

Parameters:

key - the option key

value - the option value

Returns:

the dsl builder

ftpClientKeyStoreParameters

default FtpsEndpointBuilderFactory.FtpsEndpointBuilder ftpClientKeyStoreParameters(Map values)

Set the key store parameters. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the ftpClientKeyStoreParameters(String, Object) method to add a value (call the method multiple times to set more values). Group: security

Specified by:

ftpClientKeyStoreParameters in interface FtpsEndpointBuilderFactory.FtpsEndpointConsumerBuilder

Specified by:

ftpClientKeyStoreParameters in interface FtpsEndpointBuilderFactory.FtpsEndpointProducerBuilder

Parameters:

values - the values

Returns:

the dsl builder

ftpClientTrustStoreParameters

default FtpsEndpointBuilderFactory.FtpsEndpointBuilder ftpClientTrustStoreParameters(String key,
 Object value)

Set the trust store parameters. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the ftpClientTrustStoreParameters(String, Object) method to add a value (call the method multiple times to set more values). Group: security

Specified by:

ftpClientTrustStoreParameters in interface FtpsEndpointBuilderFactory.FtpsEndpointConsumerBuilder

Specified by:

ftpClientTrustStoreParameters in interface FtpsEndpointBuilderFactory.FtpsEndpointProducerBuilder

Parameters:

key - the option key

value - the option value

Returns:

the dsl builder

ftpClientTrustStoreParameters

default FtpsEndpointBuilderFactory.FtpsEndpointBuilder ftpClientTrustStoreParameters(Map values)

Set the trust store parameters. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the ftpClientTrustStoreParameters(String, Object) method to add a value (call the method multiple times to set more values). Group: security

Specified by:

ftpClientTrustStoreParameters in interface FtpsEndpointBuilderFactory.FtpsEndpointConsumerBuilder

Specified by:

ftpClientTrustStoreParameters in interface FtpsEndpointBuilderFactory.FtpsEndpointProducerBuilder

Parameters:

values - the values

Returns:

the dsl builder

implicit

default FtpsEndpointBuilderFactory.FtpsEndpointBuilder implicit(boolean implicit)

Set the security mode (Implicit/Explicit). true - Implicit Mode / False - Explicit Mode. The option is a: <code>boolean</code> type. Default: false Group: security

Specified by:

implicit in interface FtpsEndpointBuilderFactory.FtpsEndpointConsumerBuilder

Specified by:

implicit in interface FtpsEndpointBuilderFactory.FtpsEndpointProducerBuilder

Parameters:

implicit - the value to set

Returns:

the dsl builder

implicit

default FtpsEndpointBuilderFactory.FtpsEndpointBuilder implicit(String implicit)

Set the security mode (Implicit/Explicit). true - Implicit Mode / False - Explicit Mode. The option will be converted to a <code>boolean</code> type. Default: false Group: security

Specified by:

implicit in interface FtpsEndpointBuilderFactory.FtpsEndpointConsumerBuilder

Specified by:

implicit in interface FtpsEndpointBuilderFactory.FtpsEndpointProducerBuilder

Parameters:

implicit - the value to set

Returns:

the dsl builder

password

default FtpsEndpointBuilderFactory.FtpsEndpointBuilder password(String password)

Password to use for login. The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

password in interface FtpsEndpointBuilderFactory.FtpsEndpointConsumerBuilder

Specified by:

password in interface FtpsEndpointBuilderFactory.FtpsEndpointProducerBuilder

Parameters:

password - the value to set

Returns:

the dsl builder

securityProtocol

default FtpsEndpointBuilderFactory.FtpsEndpointBuilder securityProtocol(String securityProtocol)

Set the underlying security protocol. The option is a: <code>java.lang.String</code> type. Default: TLSv1.3 Group: security

Specified by:

securityProtocol in interface FtpsEndpointBuilderFactory.FtpsEndpointConsumerBuilder

Specified by:

securityProtocol in interface FtpsEndpointBuilderFactory.FtpsEndpointProducerBuilder

Parameters:

securityProtocol - the value to set

Returns:

the dsl builder

sslContextParameters

default FtpsEndpointBuilderFactory.FtpsEndpointBuilder sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)

Gets the JSSE configuration that overrides any settings in FtpsEndpoint#ftpClientKeyStoreParameters, ftpClientTrustStoreParameters, and FtpsConfiguration#getSecurityProtocol(). The option is a: <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: security

Specified by:

sslContextParameters in interface FtpsEndpointBuilderFactory.FtpsEndpointConsumerBuilder

Specified by:

sslContextParameters in interface FtpsEndpointBuilderFactory.FtpsEndpointProducerBuilder

Parameters:

sslContextParameters - the value to set

Returns:

the dsl builder

sslContextParameters

default FtpsEndpointBuilderFactory.FtpsEndpointBuilder sslContextParameters(String sslContextParameters)

Gets the JSSE configuration that overrides any settings in FtpsEndpoint#ftpClientKeyStoreParameters, ftpClientTrustStoreParameters, and FtpsConfiguration#getSecurityProtocol(). The option will be converted to a <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: security

Specified by:

sslContextParameters in interface FtpsEndpointBuilderFactory.FtpsEndpointConsumerBuilder

Specified by:

sslContextParameters in interface FtpsEndpointBuilderFactory.FtpsEndpointProducerBuilder

Parameters:

sslContextParameters - the value to set

Returns:

the dsl builder

username

default FtpsEndpointBuilderFactory.FtpsEndpointBuilder username(String username)

Username to use for login. The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

username in interface FtpsEndpointBuilderFactory.FtpsEndpointConsumerBuilder

Specified by:

username in interface FtpsEndpointBuilderFactory.FtpsEndpointProducerBuilder

Parameters:

username - the value to set

Returns:

the dsl builder