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

Interface FtpEndpointBuilderFactory.FtpEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver, FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder, FtpEndpointBuilderFactory.FtpEndpointProducerBuilder

Enclosing interface:

FtpEndpointBuilderFactory

public static interface FtpEndpointBuilderFactory.FtpEndpointBuilder
extends FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder, FtpEndpointBuilderFactory.FtpEndpointProducerBuilder

Builder for endpoint for the FTP component.

Method Summary

Modifier and Type	Method	Description
default FtpEndpointBuilderFactory.FtpEndpointBuilder	account(String account)	Account to use for login.
default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder	advanced()
default FtpEndpointBuilderFactory.FtpEndpointBuilder	binary(boolean binary)	Specifies the file transfer mode, BINARY or ASCII.
default FtpEndpointBuilderFactory.FtpEndpointBuilder	binary(String binary)	Specifies the file transfer mode, BINARY or ASCII.
default FtpEndpointBuilderFactory.FtpEndpointBuilder	charset(String charset)	This option is used to specify the encoding of the file.
default FtpEndpointBuilderFactory.FtpEndpointBuilder	disconnect(boolean disconnect)	Whether or not to disconnect from remote FTP server right after use.
default FtpEndpointBuilderFactory.FtpEndpointBuilder	disconnect(String disconnect)	Whether or not to disconnect from remote FTP server right after use.
default FtpEndpointBuilderFactory.FtpEndpointBuilder	doneFileName(String doneFileName)	Producer: If provided, then Camel will write a 2nd done file when the original file has been written.
default FtpEndpointBuilderFactory.FtpEndpointBuilder	fileName(String fileName)	Use Expression such as File Language to dynamically set the filename.
default FtpEndpointBuilderFactory.FtpEndpointBuilder	passiveMode(boolean passiveMode)	Sets passive mode connections.
default FtpEndpointBuilderFactory.FtpEndpointBuilder	passiveMode(String passiveMode)	Sets passive mode connections.
default FtpEndpointBuilderFactory.FtpEndpointBuilder	password(String password)	Password to use for login.
default FtpEndpointBuilderFactory.FtpEndpointBuilder	separator(String separator)	Sets the path separator to be used.
default FtpEndpointBuilderFactory.FtpEndpointBuilder	separator(org.apache.camel.component.file.remote.RemoteFileConfiguration.PathSeparator separator)	Sets the path separator to be used.
default FtpEndpointBuilderFactory.FtpEndpointBuilder	transferLoggingIntervalSeconds(int transferLoggingIntervalSeconds)	Configures the interval in seconds to use when logging the progress of upload and download operations that are in-flight.
default FtpEndpointBuilderFactory.FtpEndpointBuilder	transferLoggingIntervalSeconds(String transferLoggingIntervalSeconds)	Configures the interval in seconds to use when logging the progress of upload and download operations that are in-flight.
default FtpEndpointBuilderFactory.FtpEndpointBuilder	transferLoggingLevel(String transferLoggingLevel)	Configure the logging level to use when logging the progress of upload and download operations.
default FtpEndpointBuilderFactory.FtpEndpointBuilder	transferLoggingLevel(org.apache.camel.LoggingLevel transferLoggingLevel)	Configure the logging level to use when logging the progress of upload and download operations.
default FtpEndpointBuilderFactory.FtpEndpointBuilder	transferLoggingVerbose(boolean transferLoggingVerbose)	Configures whether the perform verbose (fine grained) logging of the progress of upload and download operations.
default FtpEndpointBuilderFactory.FtpEndpointBuilder	transferLoggingVerbose(String transferLoggingVerbose)	Configures whether the perform verbose (fine grained) logging of the progress of upload and download operations.
default FtpEndpointBuilderFactory.FtpEndpointBuilder	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.FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder

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.FtpEndpointBuilderFactory.FtpEndpointProducerBuilder

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

Method Detail

advanced

default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder advanced()

Specified by:

advanced in interface FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder

Specified by:

advanced in interface FtpEndpointBuilderFactory.FtpEndpointProducerBuilder

binary

default FtpEndpointBuilderFactory.FtpEndpointBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder

Specified by:

binary in interface FtpEndpointBuilderFactory.FtpEndpointProducerBuilder

Parameters:

binary - the value to set

Returns:

the dsl builder

binary

default FtpEndpointBuilderFactory.FtpEndpointBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder

Specified by:

binary in interface FtpEndpointBuilderFactory.FtpEndpointProducerBuilder

Parameters:

binary - the value to set

Returns:

the dsl builder

charset

default FtpEndpointBuilderFactory.FtpEndpointBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder

Specified by:

charset in interface FtpEndpointBuilderFactory.FtpEndpointProducerBuilder

Parameters:

charset - the value to set

Returns:

the dsl builder

disconnect

default FtpEndpointBuilderFactory.FtpEndpointBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder

Specified by:

disconnect in interface FtpEndpointBuilderFactory.FtpEndpointProducerBuilder

Parameters:

disconnect - the value to set

Returns:

the dsl builder

disconnect

default FtpEndpointBuilderFactory.FtpEndpointBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder

Specified by:

disconnect in interface FtpEndpointBuilderFactory.FtpEndpointProducerBuilder

Parameters:

disconnect - the value to set

Returns:

the dsl builder

doneFileName

default FtpEndpointBuilderFactory.FtpEndpointBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder

Specified by:

doneFileName in interface FtpEndpointBuilderFactory.FtpEndpointProducerBuilder

Parameters:

doneFileName - the value to set

Returns:

the dsl builder

fileName

default FtpEndpointBuilderFactory.FtpEndpointBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder

Specified by:

fileName in interface FtpEndpointBuilderFactory.FtpEndpointProducerBuilder

Parameters:

fileName - the value to set

Returns:

the dsl builder

passiveMode

default FtpEndpointBuilderFactory.FtpEndpointBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder

Specified by:

passiveMode in interface FtpEndpointBuilderFactory.FtpEndpointProducerBuilder

Parameters:

passiveMode - the value to set

Returns:

the dsl builder

passiveMode

default FtpEndpointBuilderFactory.FtpEndpointBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder

Specified by:

passiveMode in interface FtpEndpointBuilderFactory.FtpEndpointProducerBuilder

Parameters:

passiveMode - the value to set

Returns:

the dsl builder

separator

default FtpEndpointBuilderFactory.FtpEndpointBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder

Specified by:

separator in interface FtpEndpointBuilderFactory.FtpEndpointProducerBuilder

Parameters:

separator - the value to set

Returns:

the dsl builder

separator

default FtpEndpointBuilderFactory.FtpEndpointBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder

Specified by:

separator in interface FtpEndpointBuilderFactory.FtpEndpointProducerBuilder

Parameters:

separator - the value to set

Returns:

the dsl builder

transferLoggingIntervalSeconds

default FtpEndpointBuilderFactory.FtpEndpointBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder

Specified by:

transferLoggingIntervalSeconds in interface FtpEndpointBuilderFactory.FtpEndpointProducerBuilder

Parameters:

transferLoggingIntervalSeconds - the value to set

Returns:

the dsl builder

transferLoggingIntervalSeconds

default FtpEndpointBuilderFactory.FtpEndpointBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder

Specified by:

transferLoggingIntervalSeconds in interface FtpEndpointBuilderFactory.FtpEndpointProducerBuilder

Parameters:

transferLoggingIntervalSeconds - the value to set

Returns:

the dsl builder

transferLoggingLevel

default FtpEndpointBuilderFactory.FtpEndpointBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder

Specified by:

transferLoggingLevel in interface FtpEndpointBuilderFactory.FtpEndpointProducerBuilder

Parameters:

transferLoggingLevel - the value to set

Returns:

the dsl builder

transferLoggingLevel

default FtpEndpointBuilderFactory.FtpEndpointBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder

Specified by:

transferLoggingLevel in interface FtpEndpointBuilderFactory.FtpEndpointProducerBuilder

Parameters:

transferLoggingLevel - the value to set

Returns:

the dsl builder

transferLoggingVerbose

default FtpEndpointBuilderFactory.FtpEndpointBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder

Specified by:

transferLoggingVerbose in interface FtpEndpointBuilderFactory.FtpEndpointProducerBuilder

Parameters:

transferLoggingVerbose - the value to set

Returns:

the dsl builder

transferLoggingVerbose

default FtpEndpointBuilderFactory.FtpEndpointBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder

Specified by:

transferLoggingVerbose in interface FtpEndpointBuilderFactory.FtpEndpointProducerBuilder

Parameters:

transferLoggingVerbose - the value to set

Returns:

the dsl builder

account

default FtpEndpointBuilderFactory.FtpEndpointBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder

Specified by:

account in interface FtpEndpointBuilderFactory.FtpEndpointProducerBuilder

Parameters:

account - the value to set

Returns:

the dsl builder

password

default FtpEndpointBuilderFactory.FtpEndpointBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder

Specified by:

password in interface FtpEndpointBuilderFactory.FtpEndpointProducerBuilder

Parameters:

password - the value to set

Returns:

the dsl builder

username

default FtpEndpointBuilderFactory.FtpEndpointBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder

Specified by:

username in interface FtpEndpointBuilderFactory.FtpEndpointProducerBuilder

Parameters:

username - the value to set

Returns:

the dsl builder