- Last Updated on 19 July 2014
Although it is possible to use Java networking API (by using the interfaces and classes available in the packages java.net and javax.net) to write code that communicates with a FTP server, that approach is discouraged because you will have to spend a lot of time on understanding the underlying FTP protocol, implementing the protocol handlers, testing, fixing bugs… and finally you re-invent the wheel! Instead, it’s advisable to look around and pick up some ready-made libraries, and that definitely saves your time! The Apache Commons Net library is an ideal choice for developing FTP based applications. It’s not just for only FTP, but for all common standard internet protocols such as NNTP, SMTP, POP3, Telnet… to name just a few.
With built-in Java API, we can use the java.net.URLConnection to do some FTP operations such as listing files and directories, upload and download. However that is very limited in terms of controllability and flexibility.
So, if you are going to write a Java application that needs to communicate with a FTP server, go on with Apache Commons Net.
- Home page: http://commons.apache.org/net/
- Download page: http://commons.apache.org/net/download_net.cgi
- Latest version: 3.2
- Java doc: http://commons.apache.org/proper/commons-net/javadocs/api-3.2/index.html
Download a zipped binary distribution of the library (commons-net-3.2-bin.zip) and extract the zip file to a desired location on your computer. The following screenshot shows content of the distribution:
You can find the following items included in the distribution:
- Directory apidocs: contains Java doc for Commons Net 3.2 API. You should consult this documentation for API reference.
- Directory examples: contains Java source code for examples. The examples are categorized by protocol (ftp, mail, telnet…) and designed as standalone programs, so that you can run and experiment the examples yourself.
- File commons-net-3.2.jar: this is the JAR library to which your application must refer, in order to use APIs related to FTP protocol.
- File commons-net-examples-3.2.jar: Compiled example programs are packed inside this JAR file. You can use this syntax:
java –jar commons-net-examples-3.2.jar <main-class> <arguments>
to execute the example programs. Consult example source code to choose a correct main class and arguments needed.
So to compile and run your code, you must have commons-net-3.2.jar file present in your project’s classpath.
The package org.apache.commons.net.ftp contains interfaces and classes for working with FTP protocol. The FTPClient class implements necessary functions for developing a FTP client program.
And that’s only the first step. Check out our tutorials dedicated to Java FTP programming with Apache Commons Net library:
- Directory and content listing:
- Create a directory on FTP server
- Creating nested directory structure on a FTP server
- List files and directories on a FTP server
- List files and directories recursively on a FTP server
- Remove an empty directory on a FTP server
- How to remove a non-empty directory on a FTP server
- Determine if a directory or file exists on FTP server
- Change working directory on a FTP server
- For java.net.URLConnection-based approach: