Java FTP Utility Class with Spring Integration for Upload, Download, and Delete Operations

Introduction

When working on a project that needs to interact with an FTP server, two common design patterns emerge: a singleton utility class or a dedicated Spring-managed service. Each has pros and cons regarding code reuse and configuration management.

The author proposes a hybrid solution that combines the advantages of both approaches by defining a Spring bean that encapsulates FTP operations, allowing property injection for configuration while retaining reusable methods.

Implementation

The core of the solution is the FtpUtil class, which provides methods for file upload, download, and deletion. It uses Apache Commons Net's FTPClient and is configured via Spring @Value annotations to read FTP connection details from a properties file.

package com.cky.util;

import java.io.*;
import org.apache.commons.net.ftp.*;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

//@Component
public class FtpUtil {
    @Value("${ftp.host}") private String host;
    @Value("${ftp.port}") private int port;
    @Value("${ftp.username}") private String username;
    @Value("${ftp.password}") private String password;
    @Value("${ftp.basePath}") private String basePath;
    // constructors, getters, setters omitted for brevity

    public boolean fileUpload(String path, String filename, InputStream input) { /* implementation */ }
    public boolean downloadFile(String filename, String localPath) { /* implementation */ }
    public boolean deleteFile(String filename) { /* implementation */ }
    private void clearDirectory(FTPClient ftp, String basePath, String path) throws IOException { /* implementation */ }
    public static void main(String[] args) { /* test examples */ }
}

Configuration

Configure Spring to load the FTP properties and declare the utility as a bean.

Spring XML

<context:property-placeholder location="classpath:*.properties"/>

ftp.properties

ftp.host=192.168.100.77
ftp.port=21
ftp.username=ftpuser
ftp.password=ftp54321
ftp.basePath=/home/ftpuser/

Bean Declaration (XML)

<bean id="ftpUtil" class="com.cky.util.FtpUtil">
    <property name="host" value="${ftp.host}"/>
    <property name="port" value="${ftp.port}"/>
    <property name="username" value="${ftp.username}"/>
    <property name="password" value="${ftp.password}"/>
    <property name="basePath" value="${ftp.basePath}"/>
</bean>

Component Scan (Annotation)

<context:component-scan base-package="com.cky.util"/>

Injection Example

@Autowired
private FtpUtil ftpUtil;

Common FTP Issues

Connection failures : Verify that the FTP server is running and that firewall rules allow traffic on the configured port.

File creation/upload failures : Ensure the FTP user has appropriate read/write permissions and that directories are created with the correct ownership.

Conclusion

The provided utility class offers a reusable, Spring‑managed solution for common FTP operations, simplifying configuration and error handling while allowing developers to integrate file transfer capabilities into their Java applications efficiently.