FeatureThe SFTP component is a Binding Component (BC) which supports SFTP command. This component provide a set of 5 operation:
These operations are described in an embedded WSDL.
Recommend usagePetals SFTP binding component allows JBI consumers to call SFTP command. A JBI endpoint is registered into the JBI environment, and is linked to an SFTP server, with a configured user/password. To use this service, the consumer has to call explicitely the {service namespace}get/getAsAttachment/mget/put/mput/dir/del operations.When the SFTP component receives a message exchange from Petals platform, it call the SFTP command associate with the jbi operation. Exposing a SFTP connection as a serviceIn provide mode, the component expose an external service in the JBI environment to send SFTP commands on an SFTP server UsageWhen 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.
... <!--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> ... Put OperationWhen 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 OperationWhen 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 OperationWhen 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.
GetAsAttachment OperationWhen 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: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: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 OperationWhen 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.
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 OperationWhen the dir operation is set on the incoming IN message, the component returns the file names listed from the SFTP <?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 OperationWhen the del operation is set on the incoming IN message, the component delete the remote file. <?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. ConfigurationConfiguration of a Service Unit to provide a service (JBI)
Configuration of a Service Unit to provide a service (CDK)
Service Unit attributes to provide services
Service Unit descriptorThe service unit is configurable via its extensions in the jbi.xml file:
<?xml version="1.0" encoding="UTF-8"?> <!-- JBI descriptor for PEtALS' "petals-bc-" (), version 3.3 --> <jbi:jbi version="1.0" </jbi:jbi> Service Unit contentThe Service Unit has to contain the following elements, packaged in an archive:
service-unit.zip + META-INF - jbi.xml (as defined above) - service.wsdl (optional) Component ConfigurationThe following attributes can be set during the installation phase to configure the component, using the params element of the jbi-install-component ANT task: Unable to render {include} Couldn't find a page to include called: 0 CDK Component Configuration Table
Definition of CDK parameter scope :
|
Table of contents Contributors
No contributors found for: authors on selected page(s)
|