Petals-BC-Filetransfer

compared with
Key
This line was removed.
This word was removed. This word was added.
This line was added.

Changes (16)

View Page History
h2. Transfer files into the JBI bus

\\
{loremipsum:1}
\\ !worddav103ae1837a51c53a71a57c7c0997a20a.png|align=center!

h3. Service Unit descriptor
h3. Consumer restrictions

{loremipsum:1}
The FileTransfer component supports only InOnly message exchange pattern as consumer.

The FileTransfer component does not support synchronous sendings as consumer.


h3. Consumer usage

{loremipsum:1}
If you want to invoke a service in the JBI bus with files, put the files in the configured directory (read-directory). Ateach configured polling period (polling-period), the component fetchs the incoming files.If you want to invoke a service in the JBI bus with files, put the files in the configured directory (read-directory). At each configured polling period (polling-period), the component fetchs the incoming files.For each received files and according to the transfer mode (transfer-mode), the component creates a new message exchange and attachs the file, either as source or as attachment.

If a file is put as a attachment, the name of the attachment is set to the name of the file, and in the source of the message exchange, the component put a XML structure like following :

<attached-files><file-name>myFileName</file-name><attached-files>
The resulted message exchange(s) are sent to the target endpoint.

During the transfer, if the backup directory (backup-directory) is set, the transfered file is moved into it and never deleted by the component. Otherwise the file is moved to the system temporary directory.

When deploying a service unit like in the previous code snippet, all the files put in the directory $PETALS_HOME/filetransfer/in would be set as the payload of an invocation to the FileService service.







h2. Transfer files out of the JBI bus

\\
{loremipsum:1}
\\ !worddav93ef27655066d2f8dbcd5b821bb00665.png|align=center!


h3. Provider restrictions

The FileTransfer component only supports InOnly message exchange pattern as service provider.


h3. Provider Usage

According to the configured mode (copy-mode), the XML message content, attachments or both are transfered to the target
directory (write-directory).
According to the configured mode (copy-mode), the XML message content, attachments or both are transfered to the target&nbsp;directory (write-directory).&nbsp;

If the received message is an XML content, the name of the created file would be either the configured file pattern&nbsp;(file-pattern), the operation of the message exchange, or the default name content.xml.

If the received message contains attachments, the name of the created files would be the names of the attachments.

For each file created, the system date is appended to this file name.

When deploying a service unit like in the previous code snippet, all the JBI messages received on the putService service&nbsp;will produce files in the $PETALS_HOME/filetransfer/out directory.

h2. Retrieve files from a folder : the GetFiles service

h3. Provider restrictions

The FileTransfer component supports only InOut or InOptionalOut message exchange pattern as service provider.


h3. Provider Usage