File Transport Guide

This guide describes the File / FTP / SFTP and FTPS transport configuration options

FileTransportListener
Name Description

tempDirectory

Temporary directory to fetch files - defaults to java.io.tmpdir

useSafeLock

Use a <filename>.lock file instead of locking the file channel at the OS level (Used for Windows)

FileTransportSender

None exists

Transport Binding Properties for Proxy Services
Constant FileConstants. Value Description

BaseConstants

TRANSPORT_URL

ultra.transport.url

URL of the files to poll. Could be a URL for a file or directory - for any supported file protocol such as s/ftp, ftps or file

PollingConstants

CRON_EXPRESSION

ultra.polling.cron_expression

CRON expression for polling - e.g. 0/20/40 * * ? * MON-FRI

START_DELAY

ultra.polling.start_delay

Amount of millis before polling for files from startup of ESB node

REPEAT_INTERVAL

ultra.polling.repeat_interval

Polling interval in millis

CONCURRENT

ultra.polling.concurrent

Concurrent polling enabled? Default: false = only one thread of the ESB will "poll" for messages

CONCURRENT_EXECUTION

ultra.polling.concurrent_execution

The maximum number of allowed concurrent executions (default unlimited, set to 1 for single threaded execution)

PREFETCH_HANDLER_BEAN

ultra.polling.prefetch_handler_bean

A Spring bean implementing PrefetchHandler interface to specify if a message should be picked up or not

PREFETCH_HANDLER_CLASS

ultra.polling.prefetch_handler_class

A class implementing PrefetchHandler interface to specify if a message should be picked up or not

DISABLED

ultra.polling.disabled

Set (polling transport based) proxy service to be disabled temporarily - maybe used for testing

FileConstants

NAME_PATTERN

ultra.file.name_pattern

A pattern for file names such as: .*\.edi

PATH_PATTERN

ultra.file.path_pattern

A pattern such as: ftpuser*/outbox/*.xml

FETCH_AFTER_MODIFICATION

ultra.file.fetch_after_modification

Do not fetch file until this amount of time has passed since the last modified file timestamp

MOVE_AFTER_PROCESS

ultra.file.move_after_process

 

MOVE_AFTER_FAILURE

ultra.file.move_after_failure

 

MOVE_TIMESTAMP_FORMAT

ultra.file.move_timestamp_format

 

DISTRIBUTED_LOCKING_DISABLED

ultra.file.distributed_locking_disabled

In clustered mode, disable distributed locking

PRIVATE_KEY_FILE

keyFilePath

Path to private key file for SFTP

PRIVATE_KEY_PASSWORD

keyPassword

Private key file password

STRICT_HOST_KEY_CHECK

StrictHostKeyChecking

 

SESSION_TIMEOUT

timeout

Timeout for SFTP pooled connection sessions

Message Properties
Name Description

ultra.file.name

Name of the file - when writing, the name to be used (Can be specified as an endpoint property)

ultra.file.timestamp_format

Timestamp format to use when writing file (Can be specified as an endpoint property)

Transport Headers
Constants FileConstants. Description

ORIGINAL_NAME

Name of the original file

NAME

ultra.file.name

SIZE

ultra.file.size

PATH

ultra.file.path

SCHEME

ultra.file.scheme

In this topic
In this topic
Contact Us