{section}
{column}

h1. Feature

The SFTP component is a Binding Component (BC) which supports SFTP command. The petals-bc-sftp component allows to put, get or list files on an SFTP server.

* *put:* Write the received JBI messages in a file with a specified name.
* *mput:* Write the JBI message attachments it receives into files.
* *get:* Retrieve *Xml* file corresponding to a pattern, from a folder. Return it as message payload.
* *mGet:* Retrieve files corresponding to a pattern, from a folder. Return them as message's attachment.
* *dir:* List the content of a folder.

These operations are described in an embedded WSDL.
{info}All attachment are processed by using XOP rules.(XML-binary Optimized Packaging : [http://www.w3.org/TR/xop10/] ){info}

h1. Exposing a SFTP connection as a service

In provide mode, the component expose an external service in the JBI environment to send SFTP commands on an SFTP server.

This service can either connects to an SFTP server configured in the ServiceUnit, or retrieve the SFTP server information in the XML message request (*Dynamic mode*).
\\

h2. Usage

When using the SFTP service, you can optionnaly define the SFTP connection information in your XML request. If you don't, the service unit parameters are used.

To configure the SFTP connection in your XML message request, you have to provide a {{connection}} element.
\\ {code:lang=xml}
...
<!--
Note : you must use one of the above authentication modes when
using dynamic configuration (ie using SU configuration)
-->
<!-- When using user / password authentication -->
<ver:connection>
<ver:server>server</ver:server>
<ver:port>port</ver:port>
<ver:user>user</ver:user>
<ver:password>password</ver:password>
<ver:folder>folder</ver:folder>
</ver:connection>
<!-- When using private key authentication -->
<ver:connection>
<ver:server>server</ver:server>
<ver:port>port</ver:port>
<ver:user>user</ver:user>
<ver:password>pathtoprivatekey</ver:password>
<ver:folder>folder</ver:folder>
</ver:connection>

{code}
{info}Operation need to be call explicitely in the form : \{service-namespace}operation

Example : \{[http://petals.ow2.org/components/sftp/version-1]}put{info}


h3. Put Operation

When the put operation is set on the incoming IN message, the component write the XML message to the SFTP server.

When the mput operation is set on the incoming IN message, the component write the attachments on the SFTP server.

When the get operation is set on the incoming IN message, the component retrieve ONE file from the SFTP server 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/sftp/version-1.0">
<ver:filename>file name to retrieve</ver:filename>
<!--Optional:-->
<ver:connection>
...

The service might return a Fault when an element in the request is missing or if the SFTP connection failed.
The available exchange patterns are: {{InOut}}.

h3. MGet Operation

When the mget operation is set on the incoming IN message, the component retrieves files from the SFTP server, according to the file names (or filters) set in the XML request.
There is no recursivity, sub folders are ignored.

Each file is set in the OUT message as an attachment. The IN message looks like:
{code:lang=xml}<?xml version="1.0" encoding="UTF-8"?>
<ver:mget xmlns:ver="http://petals.ow2.org/components/sftp/version-1.0">
<!--1 or more repetitions:-->
<ver:filename>*.xml</ver:filename>
<ver:filename>myFile.txt</ver:filename>
<!--Optional:-->
<ver:connection>
...
</ver:connection>
</ver:mget>

{code}
The OUT message returned to the consumer contains files, as attachments, and an XML message report:
\\
{code:lang=xml}<?xml version="1.0" encoding="UTF-8"?>
<tns:mgetResponse xmlns:tns="http://petals.ow2.org/components/sftp/version-1.0">
<tns:filename>source.xml</tns:filename>
<tns:filename>source2.xml</tns:filename>
<tns:filename>myFile.txt</tns:filename>
</tns:mgetResponse>

{code}
The service might return a Fault when an element in the request is missing or if the SFTP connection failed.

The available exchange pattern is: *InOut*.

h3. Dir Operation

When the dir operation is set on the incoming IN message, the component returns the file names listed from the SFTP
server.
The IN message looks like :{code:lang=xml}
<?xml version="1.0" encoding="UTF-8"?><ver:dir xmlns:ver="http://petals.ow2.org/components/sftp/version-1>
<!--Optional:-->
<ver:connection>
...
</ver:connection>
</ver:dir>{code}
The OUT message returned to the consumer is defined as follow :

{code:lang=xml}<tns:dirResponse xmlns:tns="http://petals.ow2.org/components/sftp/version-1">
<!--Zero or more repetitions:-->
<tns:filename>file1.txt</tns:filename>
<tns:filename>linux.jpg</tns:filename>
</tns:dirResponse>
{code}
The service might return a Fault when an element in the request is missing or if the SFTP connection failed

The available exchange pattern is : *InOut*.

h2. Configuration

{note:title=Put XML content or send SFTP commands to the SFTP server}
PROVIDE SERVICE : Expose an external service in the JBI environment to put XML messages or send SFTP commands on an SFTP server
Petals SFTP binding component allows JBI consumers to send XML messages to an SFTP server. A JBI endpoint is registered into the JBI environment, and is linked to an SFTP server, with a configured user/password. When the SFTP component receives a message exchange from Petals platform, the XML content of the message is put on the SFTP server.
The component can also provide a generic SFTP service. This service allows the consumer to call SFTP commands. This service can either connects to an SFTP server configured in the ServiceUnit, or retrieves the SFTP server information in the XML message request.
To use this generic service, the consumer has to call explicitely the \{service namespace}get/mget/put/mput/dir operations.
{note}

h3. Service Unit descriptor

The service unit is configurable via its extensions in the jbi.xml file:
Excample of a Service Unit descriptor to provide a SFTP service:
{code:lang=xml}
<?xml version="1.0" encoding="UTF-8"?>
<!--
JBI descriptor for the PEtALS' "petals-bc-sftp" component (SFTP).
Originally created for the version 1.0 of the component.
-->
<jbi:jbi version="1.0"
xmlns:interfaceNs="http://petals.ow2.org/sample/sftp"
xmlns:jbi="http://java.sun.com/xml/ns/jbi"
xmlns:sftp="http://petals.ow2.org/components/sftp/version-1.0"
xmlns:petalsCDK="http://petals.ow2.org/components/extensions/version-4.0"
xmlns:serviceNs="http://petals.ow2.org/sample/sftp"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<!-- Import a Service into PEtALS or Expose a PEtALS Service => use a BC. -->
<jbi:services binding-component="true">
<!-- Import a Service into PEtALS => provides a Service. -->
<jbi:provides
interface-name="interfaceNs:SampleSftpInterface"
service-name="serviceNs:SampleSftpService"
endpoint-name="SampleSftpServiceEndpoint">
<!-- CDK specific elements -->
<petalsCDK:wsdl xsi:nil="true" />
<!-- Component specific elements -->
<sftp:server>server</sftp:server>
<sftp:port>22</sftp:port>
<!-- When using user / password authentication -->
<sftp:user>user</sftp:user>
<sftp:password>password</sftp:password>
<!-- When using private key authentication -->
<sftp:user>user</sftp:user>
<sftp:privatekey>pathtoprivatekey</sftp:privatekey>
<sftp:passphrase>passphrase</sftp:passphrase>
<!--
Note : you must use one of the above authentication modes when
using static configuration (ie using SU configuration)
-->
<sftp:folder>folder</sftp:folder>
</jbi:provides>
</jbi:services>
</jbi:jbi>
{code}

{center}{*}Configuration of a Service Unit to provide a service (CDK)*{center}
{table-plus:columnAttributes=,,style="text-align:center;",style="text-align:center;"}

| message-properties | This sections defines the list of properties to set to the JBI message when processing a service. | \- | No |
| org.ow2.petals.transport.compress | *To be used only in platform (distributed) Petals distribution.* Check PEtALS container document for further details. This propety activates the compression of the messages payload when set to {{true}}. | \- | No |
| validate-wsdl | Activates the validation of the WSDL when deploying the SU. | true | No |
| wsdl | Path to the WSDL document describing services and operations exposed by the provided JBI endpoints defined in the SU. \\
The value of this parameter is: \\
* an URL

{center}{*}Configuration of a Service Unit to provide a service (SFTP)*{center}

| port | the port number of the server | {center}21{center} | {center}No{center} |
| user | the user login name used to connect to the server | {center}\-{center} | {center}Yes{center}{center}except when using Dynamic mode{center} |
| password | the user password | {center}\-{center} | {center}Yes{center}{center}except when using Dynamic mode{center} |
| folder | the folder on the server | {center}\-{center} | {center}No{center} |
| privatekey | the path to the user's private key (on the PEtALS machine) | {center}\-{center} | {center}Yes{center}{center}except when using dynamic mode or password authentication{center} |
| passphrase | the passphrase matching the given private key | {center}\-{center} | {center}No{center} |
{table-plus}

{include:0 CDK SU Interceptor configuration}

h3. Service Unit content

The Service Unit has to contain the following elements, packaged in an archive:
\\
* The META-INF/jbi.xml descriptor file, has described above,
* An optional wsdl file describing the related service

{code}service-unit.zip
+ META-INF
- jbi.xml (as defined above)
- service.wsdl (optional)
{code}

h1. Component Configuration

| notifications | Enable the EDA mode. The component produces and consumes notifications. See the EDA documentation for further details. \\ | false | No | Installation |
| ignored-status | When the component receives an acknowledgement message exchange, it can skip the processing of these messages according to the type of the acknowledgement. If you decide to not ignore some acknowledgement, the component listeners must take care of them. \\
Accepted values: {{DONE_AND_ERROR_IGNORED, DONE_IGNORED, ERROR_IGNORED}} or {{NOTHING_IGNORED}}. | {{DONE_AND_ERROR_IGNORED}} | Yes | Component |
| properties-file | Name of the file containing properties used as reference by other parameters. Parameters reference the property name in the following pattern $\{myPropertyName}. At runtime, the expression is replaced by the value of the property. \\
\\
The value of this parameter is :
* an URL \\
* a file relative to the PEtALS installation path \\
* an empty value to stipulate a non-using file | \- | No | Installation |

{table-plus:columnAttributes=,,style="text-align:center;",style="text-align:center;"}

Set it to 0 for an infinite timeout. | 0 | No |
| operation | Operation used to invoke the target service. If no operation is set by the component code, the CDK set this MEP to the exchange to send to the target service. | \- | No |
| mep | Message Exchange Pattern used to invoke the target service. If no MEP is set by the component code, the CDK set this MEP to the exchange to send to the target service. \\
Admitted values are {{InOnly, RobustInOnly, InOptionalOut}} et {{InOut}}. | \- | No |
| exchange-properties | This section defines the list of properties to set to the JBI exschange when processing a service. | \- | No |
| org.ow2.petals.router.consumer.noack | Check PEtALS container document for further details. This propety activates the bypass of acknowledgment messages destinated to this SU. | \- | No |
| org.ow2.petals.router.strategy | *To be used only in platform (distributed) Petals distribution.* Check PEtALS container document for further details. Ovveride the default routing strategy for Message Exchanges sent by this SU. | \- | No |

{panel:title=Table of contents}{toc}{panel}
{panel:title=Contributors}{contributors:order=name|mode=list}{panel}
{column}
{section}