{section}
{column}

h1. Feature

The SFTP component is a Binding Component which supports SFTP commands.

This component provide a set of 5 operation:

* *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.
* *getAsAttachment:* Retrieve the first file corresponding to a pattern, from a folder. Return it as message's attachment.(XOP standard)
* *mGet:* Retrieve files corresponding to a pattern, from a folder. Return them as message's attachment.
* *del:* Delete one file.
* *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}


{column}
{column:width=25%}
{panel:title=Table of contents}{toc:outline=true}{panel}
{panel:title=Contributors}{contributors:order=name|mode=list|showAnonymous=true|showCount=true|showLastTime=true}{panel}
{column}
{section}

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.

The component can expose directly a generic SFTP service without deploying a service unit (*Generic mode*) or use a service-unit (*Service-unit mode*).

In generic mode, parameter for the SFTP connection are set in the XML message request in a connection node (see [Generic Mode configuration|#GenericModeConfiguration]).


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.

{info}* Operation need to be call explicitely in the form : \{service-namespace}operation
Example : \{[http://petals.ow2.org/components/sftp/version-1]}put



* All operations support wild card character{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.
\\

The IN message looks like :

{code:lang=xml}<?xml version="1.0" encoding="UTF-8"?>
<ver:put xmlns:ver="http://petals.ow2.org/components/sftp/version-1">
<ver:body>xml body</ver:body>
<ver:filename>file name on the server</ver:filename>
</ver:put>
{code}
The service does not return a message.

The service might return an error when an element in the request is missing or if the SFTP connection failed.

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 SFTP server.

The IN message looks like :

{code:lang=xml}<?xml version="1.0" encoding="UTF-8"?>
<ver:mput xmlns:ver="http://petals.ow2.org/components/sftp/version-1">
<ver:attachments>
<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 service might return an error when an element in the request is missing or if the SFTP connection failed.

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 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">
<ver:filename>file name to retrieve</ver:filename>
</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 the SFTP connection failed
\\

The available exchange patterns is : *InOut*.

{info}Only xml file could be processed otherwise an error will be raised.{info}



h3. GetAsAttachment Operation

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 attachment.

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:getAsAttachment xmlns:ver="http://petals.ow2.org/components/sftp/version-1">
<ver:filename>file name to retrieve</ver:filename>
</ver:getAsAttachment>
{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:getAsAttachmentResponse xmlns:tns="http://petals.ow2.org/components/sftp/version-1">
<tns:attachment>
<tns:filename><xop:Include xmlns:xop="http://www.w3.org/2004/08/xop/include" href="cid:test1.xml"/></tns:filename>
<tns:filename><xop:Include xmlns:xop="http://www.w3.org/2004/08/xop/include" href="cid:test2.xml"/></tns:filename>
</tns:attachment>
</tns:getAsAttachmentResponse>
{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. 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">
<!--1 or more repetitions:-->
<ver:filename>*.xml</ver:filename>
<ver:filename>myFile.txt</ver:filename>
</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">
<tns:attachments>
<tns:filename><xop:Include xmlns:xop="http://www.w3.org/2004/08/xop/include" href="cid:test1.xml"/></tns:filename>
<tns:filename><xop:Include xmlns:xop="http://www.w3.org/2004/08/xop/include" href="cid:test2.xml"/></tns:filename>
</tns:attachments>
</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>
</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*.


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//version-3>
<ver:filename>?</ver:filename>
</ver:del>
{code}
The service does not return a message.
The service might return an Error when an element in the request is missing or if the SFTP connection failed.
The available exchange pattern is : InOnly.

h2. Configuration

{anchor:GenericModeConfiguration}

h3. Generic Mode

To allow the component to provide his generic service, the component must have a wsdl with the name : component.wsdl. An example of this file is available in the component.

To deactivate the generic service supplies by the component,simply erase the file : component.wsdl.

To configure the SFTP connection in your XML message request, you have to provide a connection element.
\\
{code:lang=xml}
...
<!--Optional:-->
<ver:connection>
<ver:server>?</ver:server>
<ver:port>?</ver:port>
<ver:user>?</ver:user>

<!--Optional:-->
<ver:password>?</ver:password>
<ver:folder>?</ver:folder>
<ver:passphrase>?</ver:passphrase>
<ver:private-key>?</ver:private-key>
</ver:connection>
...
{code}

Example of a PUT request :

{code:lang=xml}
<sftp:put xmlns:sftp="http://petals.ow2.org/components/sftp/generic/version-1">
<sftp:body>xml body</sftp:body>
<sftp:filename>file name on the server</sftp:filename>
<!--Optional:-->
<sftp:connection>
<sftp:host>192.168.1.206</sftp:host>
<sftp:port>22</sftp:port>
<sftp:user>user1</sftp:user>
<sftp:password>test</sftp:password>
</sftp:connection>
</sftp:put>
{code}


h3. Service Unit descriptor

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.2 of the component.
-->
<jbi:jbi version="1.0"
xmlns:generatedNs="http://petals.ow2.org/components/sftp/version-1"
xmlns:jbi="http://java.sun.com/xml/ns/jbi"
xmlns:petalsCDK="http://petals.ow2.org/components/extensions/version-5"
xmlns:sftp="http://petals.ow2.org/components/sftp/version-1"
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="generatedNs:SftpInterface"
service-name="generatedNs:SftpService"
endpoint-name="SftpServiceEndpoint">

<!-- CDK specific elements -->
<petalsCDK:timeout>30000</petalsCDK:timeout>
<petalsCDK:validate-wsdl>true</petalsCDK:validate-wsdl>
<petalsCDK:forward-security-subject>false</petalsCDK:forward-security-subject>
<petalsCDK:forward-message-properties>false</petalsCDK:forward-message-properties>
<petalsCDK:forward-attachments>false</petalsCDK:forward-attachments>
<petalsCDK:wsdl>SftpService.wsdl</petalsCDK:wsdl>

<!-- Component specific elements -->
<sftp:host>192.168.1.206</sftp:host>
<sftp:port>22</sftp:port>
<sftp:user>user1</sftp:user>

<sftp:password>test</sftp:password>
<!-- Authentication is done either by password or by privatekey/passphrase
<sftp:privatekey></sftp:privatekey>
<sftp:passphrase></sftp:passphrase>-->
</jbi:provides>
</jbi:services>
</jbi:jbi>{code}


{include:0 CDK SU Provide Configuration}

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

{table-plus}








|| Parameter || Description || Default || Required ||
| server | IP or DNS name of the server | {center}\-{center} | {center}Yes{center} {center}except when using Dynamic mode{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}

h4. 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

{include:0 CDK Component Configuration Table 5.4.0}
{include:0 CDK Parameter scope}
{include:0 CDK Component Interceptor configuration}

h1. Monitoring the component

{warning}In this documentation, the term "Allocated threads" must be understood as "Active threads", see [PETALSDISTRIB-37|https://jira.petalslink.com/browse/PETALSDISTRIB-37]. This naming error will be fixed in the next version.{warning}

h2. Using metrics

Several probes providing metrics are included in the component, and are available through the JMX MBean '{{org.ow2.petals:type=custom,name=monitoring_*<component-id>*}}', where {{*<component-id>*}} is the unique JBI identifier of the component.

h3. Common metrics

{include:0 CDK Component Monitoring Metrics 5.4.0}

h3. Dedicated metrics

No dedicated metric is available.

h2. Receiving alerts

Several alerts are notified by the component through notification of the JMX MBean '{{org.ow2.petals:type=custom,name=monitoring_*<component-id>*}}', where {{*<component-id>*}} is the unique JBI identifier of the component.

{tip}To integrate these alerts with Nagios, see [petalsesbsnapshot:Receiving Petals ESB defects in Nagios].{tip}

h3. Common alerts

{include:0 CDK Component Monitoring Alerts 5.4.0}

h3. Dedicated alerts

No dedicated alert is available.