FTP endpoint
Name | Kind | Type | Required | Deprecated | Default Value | Enum Values | Description |
---|---|---|---|---|---|---|---|
host | path | java.lang.String | true | false | Hostname of the FTP server | ||
port | path | int | false | Port of the FTP server | |||
directoryName | path | java.lang.String | false | The starting directory | |||
username | parameter | java.lang.String | false | Username to use for login | |||
password | parameter | java.lang.String | false | Password to use for login | |||
binary | parameter | boolean | false | ||||
passiveMode | parameter | boolean | false | Sets passive mode connections.
Default is active mode connections. |
|||
connectTimeout | parameter | int | false | 10000 | Sets the connect timeout for waiting for a connection to be established Used by both FTPClient and JSCH | ||
timeout | parameter | int | false | 30000 | Sets the data timeout for waiting for reply Used only by FTPClient | ||
soTimeout | parameter | int | false | Sets the so timeout Used only by FTPClient | |||
throwExceptionOnConnectFailed | parameter | boolean | false | Should an exception be thrown if connection failed (exhausted) By default exception is not thrown and a WARN is logged. You can use this to enable exception being thrown and handle the thrown exception from the {@link org.apache.camel.spi.PollingConsumerPollStrategy} rollback method. | |||
siteCommand | parameter | java.lang.String | false | Sets optional site command(s) to be executed after successful login. Multiple site commands can be separated using a new line character (\n). @param siteCommand the site command(s). | |||
stepwise | parameter | boolean | false | true | Sets whether we should stepwise change directories while traversing file structures when downloading files, or as well when uploading a file to a directory. You can disable this if you for example are in a situation where you cannot change directory on the FTP server due security reasons. @param stepwise whether to use change directory or not | ||
separator | parameter | org.apache.camel.component.file.remote.RemoteFileConfiguration.PathSeparator | false | Auto | Sets the path separator to be used. UNIX = Path separator / is used Windows = Path separator \ is used Auto = (is default) Use existing path separator in file name | ||
streamDownload | parameter | boolean | false | Sets the download method to use when not using a local working directory. If set to true, the remote files are streamed to the route as they are read. When set to false, the remote files are loaded into memory before being sent into the route. | |||
useList | parameter | boolean | false | true | Whether to allow using LIST command when downloading a file. Default is true. In some use cases you may want to download a specific file and are not allowed to use the LIST command, and therefore you can set this option to false. | ||
ignoreFileNotFoundOrPermissionError | parameter | boolean | false | Whether to ignore when trying to download a file which does not exist or due to permission error. By default when a file does not exists or insufficient permission, then an exception is thrown. Setting this option to true allows to ignore that instead. | |||
dataTimeout | parameter | int | false | ||||
maximumReconnectAttempts | parameter | int | false | ||||
reconnectDelay | parameter | long | false | ||||
disconnect | parameter | boolean | false | ||||
fastExistsCheck | parameter | boolean | false | ||||
download | parameter | boolean | false | ||||
autoCreate | parameter | boolean | false | true | |||
bufferSize | parameter | int | false | 131072 | |||
flatten | parameter | boolean | false | ||||
charset | parameter | java.lang.String | false | ||||
fileName | parameter | org.apache.camel.Expression | false | ||||
fileExist | parameter | org.apache.camel.component.file.GenericFileExist | false | Override | Override Append Fail Ignore Move TryRename |
||
tempPrefix | parameter | java.lang.String | false | ||||
tempFileName | parameter | org.apache.camel.Expression | false | ||||
eagerDeleteTargetFile | parameter | boolean | false | true | |||
keepLastModified | parameter | boolean | false | false | |||
doneFileName | parameter | java.lang.String | false | ||||
allowNullBody | parameter | boolean | false | false | |||
chmod | parameter | java.lang.String | false | ||||
processStrategy | parameter | org.apache.camel.component.file.GenericFileProcessStrategy |
false | ||||
inProgressRepository | parameter | org.apache.camel.spi.IdempotentRepository |
false | ||||
localWorkDirectory | parameter | java.lang.String | false | ||||
startingDirectoryMustExist | parameter | boolean | false | false | |||
directoryMustExist | parameter | boolean | false | false | |||
noop | parameter | boolean | false | false | |||
recursive | parameter | boolean | false | false | |||
delete | parameter | boolean | false | false | |||
maxMessagesPerPoll | parameter | int | false | ||||
eagerMaxMessagesPerPoll | parameter | boolean | false | true | |||
maxDepth | parameter | int | false | 2147483647 | |||
minDepth | parameter | int | false | ||||
include | parameter | java.lang.String | false | ||||
exclude | parameter | java.lang.String | false | ||||
move | parameter | org.apache.camel.Expression | false | ||||
moveFailed | parameter | org.apache.camel.Expression | false | ||||
preMove | parameter | org.apache.camel.Expression | false | ||||
moveExisting | parameter | org.apache.camel.Expression | false | ||||
idempotent | parameter | java.lang.Boolean | false | ||||
idempotentKey | parameter | org.apache.camel.Expression | false | ||||
idempotentRepository | parameter | org.apache.camel.spi.IdempotentRepository |
false | ||||
filter | parameter | org.apache.camel.component.file.GenericFileFilter |
false | ||||
antInclude | parameter | java.lang.String | false | ||||
antExclude | parameter | java.lang.String | false | ||||
sorter | parameter | java.util.Comparator |
false | ||||
sortBy | parameter | java.util.Comparator |
false | ||||
readLock | parameter | java.lang.String | false | none markerFile fileLock rename changed |
|||
readLockCheckInterval | parameter | long | false | 1000 | |||
readLockTimeout | parameter | long | false | 10000 | |||
readLockMarkerFile | parameter | boolean | false | true | |||
readLockLoggingLevel | parameter | org.apache.camel.LoggingLevel | false | WARN | DEBUG ERROR INFO TRACE WARN OFF |
||
readLockMinLength | parameter | long | false | 1 | |||
readLockMinAge | parameter | long | false | 0 | |||
exclusiveReadLockStrategy | parameter | org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy |
false | ||||
startScheduler | parameter | boolean | false | true | |||
initialDelay | parameter | long | false | 1000 | |||
delay | parameter | long | false | 500 | |||
timeUnit | parameter | java.util.concurrent.TimeUnit | false | MILLISECONDS | NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS |
||
useFixedDelay | parameter | boolean | false | true | |||
pollStrategy | parameter | org.apache.camel.spi.PollingConsumerPollStrategy | false | ||||
runLoggingLevel | parameter | org.apache.camel.LoggingLevel | false | TRACE | DEBUG ERROR INFO TRACE WARN OFF |
||
sendEmptyMessageWhenIdle | parameter | boolean | false | ||||
greedy | parameter | boolean | false | ||||
scheduler | parameter | org.apache.camel.spi.ScheduledPollConsumerScheduler | false | spring quartz2 |
|||
schedulerProperties | parameter | java.util.Map |
false | ||||
scheduledExecutorService | parameter | java.util.concurrent.ScheduledExecutorService | false | ||||
backoffMultiplier | parameter | int | false | ||||
backoffIdleThreshold | parameter | int | false | ||||
backoffErrorThreshold | parameter | int | false | ||||
exchangePattern | parameter | org.apache.camel.ExchangePattern | false | InOnly | InOnly RobustInOnly InOut InOptionalOut OutOnly RobustOutOnly OutIn OutOptionalIn |
Sets the default exchange pattern when creating an exchange | |
synchronous | parameter | boolean | false | false | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). |
FTP consumer
Name | Kind | Type | Required | Deprecated | Default Value | Enum Values | Description |
---|---|---|---|---|---|---|---|
eagerLimitMaxMessagesPerPoll | parameter | boolean | false | ||||
maxMessagesPerPoll | parameter | int | false |