• Quick Start

Quick Start

Reading the Javadocs won't get you started exchanging files through the OFTP protocol. So follow these instructions on how to start developing your own OFTP-enabled Java program. This is a library that implements the OFTP protocol so from here, you have to develop your own GUI interface, either console or desktop.

  1. Check-out the Odette FTP library
    $ svn co svn checkout svn://svn.forge.objectweb.org/svnroot/accord/odetteftp/trunk odetteftp
  2. Build and install the Core API on your local repository
    $ cd odetteftp/core
    $ mvn install
  3. Create a Maven quickstart project
    $ cd ~/
    $ mvn archetype:generate -B -DarchetypeGroupId=org.apache.maven.archetypes 
    \ -DarchetypeArtifactId=maven-archetype-quickstart 
    \ -DgroupId=com.mycompany -DartifactId=myproject 
  4. Edit the file myproject/pom.xml and add the following dependency:
  5. Configure the project for your IDE
    1. Eclipse:
      $ cd myproject
      $ mvn eclipse:eclipse
  6. Import the project to your IDE's workspace
  7. Edit src/main/java/com/mycompany/App.java and start coding!


These are snippets of examples found on the examples module. You may look the source code for more details. Although the Accord OFTP has server feature, these examples were coded to validate the library by sending commands to a remote server running (probably) some other implementation. You must know one OFTP server up and running to run these tests.

Connect and Disconnect

This gives you a "Hello Odette!" snippet that connects and then disconnects from the remote OFTP server.

String server = "";
int port = 33005;
String odetteid = "MYODETTEID";
String password = "MYODETTEPWS";

SessionConfig conf = new SessionConfig();

OftpletFactory factory = new DefaultOftpletFactory(conf);
TcpClient oftp = new TcpClient(server, port, factory);


Sending File

Sending a file is the most important task the API must accomplish, right? See how it goes:


File payload = new File(args[4]);
DefaultVirtualFile vf = new DefaultVirtualFile();

Queue<OdetteFtpObject> filesToSend = new ConcurrentLinkedQueue<OdetteFtpObject>();

OftpletFactory factory = new InOutSharedQueueOftpletFactory(conf, filesToSend, null, null);
TcpClient oftp = new TcpClient(host, port, factory);

2006-2010 © Neociclo  | Last Published: 2010-10-05 02:57  | Version: 1.2.0-SNAPSHOT