|
Key
This line was removed.
This word was removed. This word was added.
This line was added.
|
Changes (11)
View Page History...
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*).
\\
\\
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.
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
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>
\\ {code:lang=xml}
...
<!--Optional:-->
<ver:connection>
<ver:server>?</ver:server>
<ver:port>?</ver:port>
<ver:user>?</ver:user>
Example : \{[http://petals.ow2.org/components/sftp/version-1]}put
* All operations support wild card character{info}
* All operations support wild card character{info}
<!--Optional:-->
<ver:password>?</ver:password>
<ver:folder>?</ver:folder>
<ver:passphrase>?</ver:passphrase>
<ver:private-key>?</ver:private-key>
</ver:connection>
...
{code}
{info}Operation need to be call explicitely in the form : \{service-namespace}operation
<ver:password>?</ver:password>
<ver:folder>?</ver:folder>
<ver:passphrase>?</ver:passphrase>
<ver:private-key>?</ver:private-key>
</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
...
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}
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}
h3. Service Unit descriptor
...
{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} |
| server | IP or DNS name of the server | {center}\-{center} | {center}Yes{center} {center}except when using Dynamic mode{center} |
...
{include:0 CDK SU Interceptor configuration}
h34. Service Unit content
The Service Unit has to contain the following elements, packaged in an archive:
...