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.
The SFTP (SSH File Transfer Protocol / Secure File Transfer Protocol) protocol is described at : SFTP protocol is described at : http://www.ietf.org/proceedings/05mar/IDs/draft-ietf-secsh-filexfer-06.txt

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.

All attachment are processed by using XOP rules.(XML-binary Optimized Packaging : http://www.w3.org/TR/xop10/ )

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

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.

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

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

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

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 :

<?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>
   <!--Optional:-->
   <ver:connection>
      ...
   </ver:connection>
</ver:put>

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.

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 :

<?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>
     <!--Optional:-->
   <ver:connection>
     ...
   </ver:connection>
</ver:mput>

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.

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 :

<?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>
    <!--Optional:-->
    <ver:connection>
      ...
    </ver:connection>
 </ver:get>

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.

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

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 :

<?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>
    <!--Optional:-->
    <ver:connection>
      ...
    </ver:connection>
 </ver:getAsAttachment>

The OUT message returned to the consumer contains files, as attachments, and an XML message report :

<?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>

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.

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 :

<?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>
    <!--Optional:-->
    <ver:connection>
     ...
    </ver:connection>
</ver:mget>

The OUT message returned to the consumer contains files, as attachments, and an XML message report :

<?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>

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.

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 :

<?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>

The OUT message returned to the consumer is defined as follow :

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

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.

Del Operation

When the del operation is set on the incoming IN message, the component delete the remote file.
The IN message looks like :

<?xml version="1.0" encoding="UTF-8"?><ver:del xmlns:ver="http://petals.ow2.org/components//version-3>
  <ver:filename>?</ver:filename>
  <!--Optional:-->
  <ver:connection>
      ...
  </ver:connection>
</ver:del>

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.

Configuration

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

Unknown macro: {service namespace}

get/mget/put/mput/dir operations.

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:

<?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>

Configuration of a Service Unit to provide a service (CDK)

Parameter	Description	Default	Required
timeout	Timeout in milliseconds of a synchronous send. This parameter is used by the method `sendSync` (Exchange exchange) proposes by the CDK `Listeners` classes. Set it to 0 for an infinite timeout.	0	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
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

Configuration of a Service Unit to provide a service (SFTP)

Parameter	Description	Default	Required
server	IP or DNS name of the server	-	Yes except when using Dynamic mode
port	the port number of the server	21	No
user	the user login name used to connect to the server	-	Yes except when using Dynamic mode
password	the user password	-	Yes except when using Dynamic mode
folder	the folder on the server	-	No
privatekey	the path to the user's private key (on the PEtALS machine)	-	Yes except when using dynamic mode or password authentication
passphrase	the passphrase matching the given private key	-	No

Interceptor

Example of an interceptor configuration:

<?xml version="1.0" encoding="UTF-8"?>
<!--...-->
<petalsCDK:su-interceptors>
  <petalsCDK:send>
    <petalsCDK:interceptor name="myInterceptorName">
      <petalsCDK:param name="myParamName">myParamValue</petalsCDK:param>
      <petalsCDK:param name="myParamName2">myParamValue2</petalsCDK:param>
    </petalsCDK:interceptor>
  </petalsCDK:send>
  <petalsCDK:accept>
    <petalsCDK:interceptor name="myInterceptorName">
      <petalsCDK:param name="myParamName">myParamValue</petalsCDK:param>
    </petalsCDK:interceptor>
  </petalsCDK:accept>
  <petalsCDK:send-response>
    <petalsCDK:Interceptor name="myInterceptorName">
      <petalsCDK:param name="myParamName">myParamValue</petalsCDK:param>
    </petalsCDK:Interceptor>
  </petalsCDK:send-response>
  <petalsCDK:accept-response>
    <petalsCDK:Interceptor name="myInterceptorName">
      <petalsCDK:param name="myParamName">myParamValue</petalsCDK:param>
    </petalsCDK:Interceptor>
  </petalsCDK:accept-response>
</petalsCDK:su-interceptors>
<!--...-->

Interceptors configuration for SU (CDK)

Parameter	Description	Default	Required
send	Interceptor dedicated to send phase, for an exchange sent by a consumer	-	No
accept	Interceptor dedicated to receive phase, for an exchange received by a provider	-	No
send-response	Interceptor dedicated to send phase, for an exchange (a response) received by a consumer	-	No
accept-response	Interceptor dedicated to receive phase, for an exchange sent (a response) by a provider	-	No
interceptor - name	Logical name of the interceptor instance. It can be referenced to add extended parameters by a SU Interceptor configuration.	-	Yes
param[] - name	The name of the parameter to use for the interceptor for this SU	-	No
param[]	The value of the parameter to use for the interceptor for this SU	-	No

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

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

Component Configuration

Configuration of the component (CDK)

Parameter	Description	Default	Required	Required
acceptor-pool-size	The size of the thread pool used to accept Message Exchanges from the NMR. Once a message is accepted, its processing is delegated to the processor pool thread.	3	Yes	Runtime
processor-pool-size	The size of the thread pool used to process Message Exchanges. Once a message is accepted, its processing is delegated to one of the thread of this pool.	10	Yes	Runtime
processor-max-pool-size	The maximum size of the thread pool used to process Message Exchanges. The difference between this size and the processorpool-size represents the dynamic threads that can be created and destroyed during overhead processing time.	50	No	Runtime
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 |

external-listener-class-name

Qualified name of the class extending AbstractExternalListener

Only for BC components.

-

No

Component

jbi-listener-class-name

Qualified name of the class extending AbstractJBIListener

-

Yes

Component

Definition of CDK parameter scope :

Installation: The parameter can be set during the installation of the component, by using the installation MBean (see JBI specifications for details about the installation sequence). If the parameter is optional and has not been defined during the development of the component, it is not available at installation time.
Runtime: The paramater can be set during the installation of the component and during runtime. The runtime configuration can be changed using the CDK custom MBean named RuntimeConfiguration. If the parameter is optional and has not been defined during the development of the component, it is not available at installation and runtime times.

Interceptor

Interceptors can be defined to inject some post or pre processing in the component during service processing.

Using interceptor is very sensitive and must be manipulate only by power users. An non properly coded interceptor engaged in a component can lead to uncontrolled behaviors, out of the standard process.

Example of an interceptor configuration:

<?xml version="1.0" encoding="UTF-8"?>
<!--...-->
<petalsCDK:component-interceptors>
  <petalsCDK:interceptor active="true" class="org.ow2.petals.myInterceptor" name="myInterceptorName">
    <petalsCDK:param name="myParamName">myParamValue</petalsCDK:param>
    <petalsCDK:param name="myParamName2">myParamValue2</petalsCDK:param>
  </petalsCDK:interceptor>
</petalsCDK:component-interceptors>
<!--...-->

Interceptors configuration for Component (CDK)

Parameter	Description	Default	Required
interceptor - class	Name of the interceptor class to implement. This class must extend the abstract class org.ow2.petals.component.common.interceptor.Interceptor. This class must be loadable from the component classloader, or in a dependent Shared Library classloader.	-	Yes
interceptor - name	Logical name of the interceptor instance. It can be referenced to add extended parameters by a SU Interceptor configuration.	-	Yes
interceptor - active	If true, the Interceptor instance is activated for every SU deployed on the component. If false, the Interceptor can be activated: -by the InterceptorManager Mbean at runtime, to activate the interceptor for every deployed SU. -by a SU configuration	-	Yes
param[] - name	The name of the parameter to use for the interceptor.	-	No
param[]	The value of the parameter to use for the interceptor.	-	No