Using the FTP Binding Component in a Project

FTP Message Element (<ftp:message>)

The FTP message element extends the WSDL binding element to allow you to specify message transfer details. These details include the locations on an FTP server on which a message is persisted, staged, retrieved, and archived.

ftp messageTable 9 FTP Message Element

Attribute Name 

Description 

Message Repository 

The Message Repository path pointing to a directory on the remote FTP server where messages will be processed and archived. 

For more information, see Table 3.

Message Name 

Message Name is the filename where a message is put into, usually in the form of a name pattern. Pattern is a string containing special characters preceded by a percentage sign. The following are all the symbols supported: 

For more information, see Table 4.

  1. UUID %u, will be substituted by a UUID value compliant with Java 1.5 UUID.

  2. sequence number reference %0, %1, %2, %3, %4, %5, %6, %7, %8, %9, this symbol will be replaced by the current value of sequence number which is an integer count that increment after each reference.

Default value: %u

messageNamePrefixIB 

A prefix placed before the value of messageName to form the actual message name for messages transported in the INBOUND direction (consumer to provider).

messageNamePrefixIB should not contain any pattern symbols or the percentage sign '%'.

Default value: req

messageNamePrefixOB 

A prefix placed before the value of messageName to form the actual message name for messages transported in the OUTBOUND direction (provider to consumer).

messageNamePrefixIB should not contain any pattern symbols or the percentage sign '%'.

Default value: resp

pollintervalMillis 

The polling interval (in milliseconds) for an inbound component (receiver) to poll the remote target. 

Default value: 5000

archive 

Specifies whether a message is archived after it is fetched by a component (either consumer or provider). 

When true, the message is archived (moved to a destination directory such as inarchive or outarchive.

When false, the message is deleted. 

Default value: true

protect 

Specifies how a message is moved to a dedicated directly such as inprotect or outprotect before an incoming message overwrites it.

  • If true, the message is moved (protected).

  • If false, the message is overwritten.

Default value: true

stage 

Specifies whether staging is enabled during message transfer. 

Default value: true

use 

Specified if the message is literal or encoded 

It encoded is specified. then you must also specify the encoder using the encodingStyle property.

Default value: Literal

encodingStyle 

Specifies the encoding type associated with the message. This also defines the encoder type responsible to process the encoded data. 

The value specified here is only applied if the use property is set to encoded. 

Has no default value. ud1encoder-1.0  

part 

References which part of the message described in the abstract WSDL is to be used for the message. 

Default value: Part1

If the part property is not specified, then the first part listed in the abstract WSDL is used. 

messageCorrelate 

Specifies whether UUID tagging-based message correlation is enabled. 

If true, then message correlation is enabled. 

Default value: true