h2. Usage
h3. Put Operation
When the put operation is set on the incoming IN message, the component write the XML message to the configured directory.
The IN message looks like :
{code:lang=xml}
<?xml version="1.0" encoding="UTF-8"?>
<ver:put xmlns:ver="http://petals.ow2.org/components/filetransfer/version-3">?</ver:put>
{code}
The service does not return a message.
The available exchange pattern is : *InOnly*.
h3. MPut Operation
When the mput operation is set on the incoming IN message, the component write the attachments on the configured directory.
The IN message looks like :
{code:lang=xml}
<?xml version="1.0" encoding="UTF-8"?>
<ver:mput>
<ver:attachments xmlns:ver="http://petals.ow2.org/components/filetransfer/version-3">
<!--1 or more repetitions:-->
<ver:filename><xop:Include xmlns:xop="http://www.w3.org/2004/08/xop/include" href="cid:test1.xml"/></ver:filename>
<ver:filename><xop:Include xmlns:xop="http://www.w3.org/2004/08/xop/include" href="cid:test2.xml"/></ver:filename>
</ver:attachments>
</ver:mput>
{code}
The service does not return a message.
The available exchange pattern is : *InOnly*.
h3. Get Operation
When the get operation is set on the incoming IN message, the component retrieve ONE file from the configured directory and return it as an XML message content.
\\
The name of the file to retrieve is set in the XML IN content of the message.
\\
The IN message looks like :
\\
{code:lang=xml}<?xml version="1.0" encoding="UTF-8"?>
<ver:get xmlns:ver="http://petals.ow2.org/components/filetransfer/version-3">
<ver:filename>file name to retrieve</ver:filename>
<!--Optional:-->
<ver:connection>
...
</ver:connection>
</ver:get>
{code}
The OUT message returned to the consumer is the content of the XML file
\\
The service might return a Fault when an element in the request is missing or if an IO error occurs
\\
The available exchange patterns is : *InOut*.
{info}Only xml file could be processed otherwise an error will be raised.{info}
h3. GetAsAttachement Operation
h3. MGet Operation
h3. Del Operation
When the del operation is set on the incoming IN message, the component delete the remote file. The IN message looks like :
{code:lang=xml}<?xml version="1.0" encoding="UTF-8"?>
<ver:del xmlns:ver="http://petals.ow2.org/components/filetransfer/version-3">
<ver:filename>?</ver:filename>
</ver:del>
{code}
The service does not return a message.
The available exchange pattern is : *InOnly*.
h3. CheckFile Operation
When the check operation is set on the incoming IN message, the component check
if the specified file exist. The IN message looks like :
{code:lang=xml}
<ver:checkFile xmlns:ver="http://petals.ow2.org/components/filetransfer/version-3">
<ver:filename>?</ver:filename>
</ver:checkFile>
{code}
The OUT message returned to the consumer looks like :
{code:lang=xml}
<ver:checkFileResponse xmlns:ver="http://petals.ow2.org/components/filetransfer/version-3">
<ver:filename>?</ver:filename>
<ver:exist>true|false</ver:exist>
</ver:checkFileResponse>
{code}
The service might return an ioFault.
The available exchange pattern is : *InOut*.
h2. Configuration
{include:0 CDK SU Provide Configuration}
*Service Unit attributes to provide services*
{table-plus}
E-mail
...