Accord Odette FTP Camel Component

The Camel OFTP Component is an adaptor for the Apache Camel framework that enables developers to leverage Odette FTP support on scenarios of file transfer between B2B applications. It is well suited for projects that need to have support for OFTP 1.3, 1.4 and OFTP2 on ESBs (Enterprise Service Bus) like Apache ServiceMix., JEE-based applications and any route-enabled architectures.

Quick Start

To enable OFTP2 support on a Camel project, it is required to add a Maven dependency for the Accord Camel OFTP component:

 <dependency>
    <groupId>org.neociclo.accord.odetteftp</groupId>
    <artifactId>camel-oftp</artifactId>
    <version>1.2-SNAPSHOT</version>
 </dependency>

We hardly recommend to use Apache Maven to integrate this component within your application. If you are not using Maven, you can download Apache Camel's distribution and then download Accord Odette Camel from Maven repository. We are not planing on releasing

Example

 from("oftp://odetteid:password@10.10.1.1?workpath=odette/work")
    .to("file:odette/inbox");

You can check more examples on project's unit tests.

How it works

Each endpoint connects to a remote OFTP server. It is possible to send and receive files, as well delivery notifications (EERPs). To receive anything, one must configure the endpoint as consumer, like in the example above.

To send files or Delivery Notifications, the endpoint must be configured as producer. If you want to send and receive files, two routes are needed.

The component will use the same OFTP session to both send and receive data if applicable. This means outgoing data sent to an OFTP endpoint will be actually delivered when a connection is estabilished, saving resources. An internal queue is used to store this outgoing data. In the mean time, incoming data will be sent to endpoint's consumer.

It is, however, possible to have an endpoint with both consumer and producer, but on specific OFTP transfer modes. This is necessary to be able to send Delivery Notifications on different sessions. For instance, when a file arrives but no EERP is sent back automatically.

Reference

The Camel OFTP component's URI follows the pattern below:

 oftp[s]://[oid[:pass]@]hostname[:port]?param=value

Observation:

If URI is preffixed with 'oftps' scheme, then SSL will be enabled

Following the parameter reference table for Camel OFTP's URI:

These parameters are related to SSL-enabled endpoints (oftps://)