Java FTPClientコード(二)マルチスレッドと接続多重化をサポート


このリリースでは、主に次の機能が追加されました.
1、マルチスレッド同時サポート
2、接続多重
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.SocketException;

import org.apache.commons.net.ftp.FTPClient;
import org.apache.commons.net.ftp.FTPReply;
import org.apache.log4j.Logger;

/**
 * FTP   
 * 
 * @author summersun_ym
 * @version $Id: FTPClientTemplate.java 2010-11-22   12:54:47 $
 */
public class FTPClientTemplate {
    //---------------------------------------------------------------------
    // Instance data
    //---------------------------------------------------------------------
    /** logger */
    protected final Logger         log                  = Logger.getLogger(getClass());
    private ThreadLocal<FTPClient> ftpClientThreadLocal = new ThreadLocal<FTPClient>();

    private String                 host;
    private int                    port;
    private String                 username;
    private String                 password;

    private boolean                binaryTransfer       = true;
    private boolean                passiveMode          = true;
    private String                 encoding             = "UTF-8";
    private int                    clientTimeout        = 1000 * 30;

    public String getHost() {
        return host;
    }

    public void setHost(String host) {
        this.host = host;
    }

    public int getPort() {
        return port;
    }

    public void setPort(int port) {
        this.port = port;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }

    public boolean isBinaryTransfer() {
        return binaryTransfer;
    }

    public void setBinaryTransfer(boolean binaryTransfer) {
        this.binaryTransfer = binaryTransfer;
    }

    public boolean isPassiveMode() {
        return passiveMode;
    }

    public void setPassiveMode(boolean passiveMode) {
        this.passiveMode = passiveMode;
    }

    public String getEncoding() {
        return encoding;
    }

    public void setEncoding(String encoding) {
        this.encoding = encoding;
    }

    public int getClientTimeout() {
        return clientTimeout;
    }

    public void setClientTimeout(int clientTimeout) {
        this.clientTimeout = clientTimeout;
    }

    //---------------------------------------------------------------------
    // private method
    //---------------------------------------------------------------------
    /**
     *     FTPClient  
     * 
     * @throws FTPClientException
     */
    private FTPClient getFTPClient() throws FTPClientException {
        if (ftpClientThreadLocal.get() != null && ftpClientThreadLocal.get().isConnected()) {
            return ftpClientThreadLocal.get();
        } else {
            FTPClient ftpClient = new FTPClient(); //    FtpClient  
            ftpClient.setControlEncoding(encoding); //     
    
            connect(ftpClient); //   ftp   
    
            //   passive  
            if (passiveMode) {
                ftpClient.enterLocalPassiveMode();
            }
            setFileType(ftpClient); //        
    
            try {
                ftpClient.setSoTimeout(clientTimeout);
            } catch (SocketException e) {
                throw new FTPClientException("Set timeout error.", e);
            }
            ftpClientThreadLocal.set(ftpClient);
            return ftpClient;
        }
    }

    /**
     *         
     * 
     * @throws FTPClientException
     * @throws IOException
     */
    private void setFileType(FTPClient ftpClient) throws FTPClientException {
        try {
            if (binaryTransfer) {
                ftpClient.setFileType(FTPClient.BINARY_FILE_TYPE);
            } else {
                ftpClient.setFileType(FTPClient.ASCII_FILE_TYPE);
            }
        } catch (IOException e) {
            throw new FTPClientException("Could not to set file type.", e);
        }
    }

    /**
     *    ftp   
     * 
     * @param ftpClient
     * @return       true,    false
     * @throws FTPClientException
     */
    private boolean connect(FTPClient ftpClient) throws FTPClientException {
        try {
            ftpClient.connect(host, port);

            //                  
            int reply = ftpClient.getReplyCode();

            if (FTPReply.isPositiveCompletion(reply)) {
                //   ftp   
                if (ftpClient.login(username, password)) {
                    setFileType(ftpClient);
                    return true;
                }
            } else {
                ftpClient.disconnect();
                throw new FTPClientException("FTP server refused connection.");
            }
        } catch (IOException e) {
            if (ftpClient.isConnected()) {
                try {
                    ftpClient.disconnect(); //    
                } catch (IOException e1) {
                    throw new FTPClientException("Could not disconnect from server.", e1);
                }

            }
            throw new FTPClientException("Could not connect to server.", e);
        }
        return false;
    }


    //---------------------------------------------------------------------
    // public method
    //---------------------------------------------------------------------
    /**
     *   ftp  
     * 
     * @throws FTPClientException
     */
    public void disconnect() throws FTPClientException {
        try {
            FTPClient ftpClient = getFTPClient();
            ftpClient.logout();
            if (ftpClient.isConnected()) {
                ftpClient.disconnect();
                ftpClient = null;
            }
        } catch (IOException e) {
            throw new FTPClientException("Could not disconnect from server.", e);
        }
    }
    
    public boolean mkdir(String pathname) throws FTPClientException {
        return mkdir(pathname, null);
    }
    
    /**
     *  ftp        (           )
     * 
     *                 
     * 
     * @param pathname
     * @return
     * @throws FTPClientException
     */
    public boolean mkdir(String pathname, String workingDirectory) throws FTPClientException {
        return mkdir(pathname, workingDirectory, true);
    }
    
    /**
     *  ftp        (           )
     * 
     * @param pathname
     * @param autoClose           
     * @return
     * @throws FTPClientException
     */
    public boolean mkdir(String pathname, String workingDirectory, boolean autoClose) throws FTPClientException {
        try {
            getFTPClient().changeWorkingDirectory(workingDirectory);
            return getFTPClient().makeDirectory(pathname);
        } catch (IOException e) {
            throw new FTPClientException("Could not mkdir.", e);
        } finally {
            if (autoClose) {
                disconnect(); //    
            }
        }
    }

    /**
     *                
     * 
     * @param remoteAbsoluteFile      (      )
     * @param localAbsoluteFile      (      )
     * @return    ,  true,    false
     * @throws FTPClientException
     */
    public boolean put(String remoteAbsoluteFile, String localAbsoluteFile) throws FTPClientException {
        return put(remoteAbsoluteFile, localAbsoluteFile, true);
    }

    /**
     *                
     * 
     * @param remoteAbsoluteFile      (      )
     * @param localAbsoluteFile      (      )
     * @param autoClose           
     * @return    ,  true,    false
     * @throws FTPClientException
     */
    public boolean put(String remoteAbsoluteFile, String localAbsoluteFile, boolean autoClose) throws FTPClientException {
        InputStream input = null;
        try {
            //     
            input = new FileInputStream(localAbsoluteFile);
            getFTPClient().storeFile(remoteAbsoluteFile, input);
            log.debug("put " + localAbsoluteFile);
            return true;
        } catch (FileNotFoundException e) {
            throw new FTPClientException("local file not found.", e);
        } catch (IOException e) {
            throw new FTPClientException("Could not put file to server.", e);
        } finally {
            try {
                if (input != null) {
                    input.close();
                }
            } catch (Exception e) {
                throw new FTPClientException("Couldn't close FileInputStream.", e);
            }
            if (autoClose) {
                disconnect(); //    
            }
        }
    }

    /**
     *                 
     * 
     * @param remoteAbsoluteFile      (      )
     * @param localAbsoluteFile      (      )
     * @return    ,  true,    false
     * @throws FTPClientException
     */
    public boolean get(String remoteAbsoluteFile, String localAbsoluteFile) throws FTPClientException {
        return get(remoteAbsoluteFile, localAbsoluteFile, true);
    }

    /**
     *                 
     * 
     * @param remoteAbsoluteFile      (      )
     * @param localAbsoluteFile      (      )
     * @param autoClose           
     * 
     * @return    ,  true,    false
     * @throws FTPClientException
     */
    public boolean get(String remoteAbsoluteFile, String localAbsoluteFile, boolean autoClose) throws FTPClientException {
        OutputStream output = null;
        try {
            output = new FileOutputStream(localAbsoluteFile);
            return get(remoteAbsoluteFile, output, autoClose);
        } catch (FileNotFoundException e) {
            throw new FTPClientException("local file not found.", e);
        } finally {
            try {
                if (output != null) {
                    output.close();
                }
            } catch (IOException e) {
                throw new FTPClientException("Couldn't close FileOutputStream.", e);
            }
        }
    }

    /**
     *                        
     * 
     * @param remoteAbsoluteFile
     * @param output
     * @return
     * @throws FTPClientException
     */
    public boolean get(String remoteAbsoluteFile, OutputStream output) throws FTPClientException {
        return get(remoteAbsoluteFile, output, true);
    }

    /**
     *                        
     * 
     * @param remoteAbsoluteFile
     * @param output
     * @param delFile
     * @return
     * @throws FTPClientException
     */
    public boolean get(String remoteAbsoluteFile, OutputStream output, boolean autoClose) throws FTPClientException {
        try {
            FTPClient ftpClient = getFTPClient();
            //     
            return ftpClient.retrieveFile(remoteAbsoluteFile, output);
        } catch (IOException e) {
            throw new FTPClientException("Couldn't get file from server.", e);
        } finally {
            if (autoClose) {
                disconnect(); //    
            }
        }
    }

    /**
     *  ftp          
     *             
     * 
     * @param delFile
     * @return
     * @throws FTPClientException
     */
    public boolean delete(String delFile) throws FTPClientException {
        return delete(delFile, true);
    }
    
    /**
     *  ftp          
     * 
     * @param delFile
     * @param autoClose           
     * 
     * @return
     * @throws FTPClientException
     */
    public boolean delete(String delFile, boolean autoClose) throws FTPClientException {
        try {
            getFTPClient().deleteFile(delFile);
            return true;
        } catch (IOException e) {
            throw new FTPClientException("Couldn't delete file from server.", e);
        } finally {
            if (autoClose) {
                disconnect(); //    
            }
        }
    }
    
    /**
     *     
     *             
     * 
     * @param delFiles
     * @return
     * @throws FTPClientException
     */
    public boolean delete(String[] delFiles) throws FTPClientException {
        return delete(delFiles, true);
    }

    /**
     *     
     * 
     * @param delFiles
     * @param autoClose           
     * 
     * @return
     * @throws FTPClientException
     */
    public boolean delete(String[] delFiles, boolean autoClose) throws FTPClientException {
        try {
            FTPClient ftpClient = getFTPClient();
            for (String s : delFiles) {
                ftpClient.deleteFile(s);
            }
            return true;
        } catch (IOException e) {
            throw new FTPClientException("Couldn't delete file from server.", e);
        } finally {
            if (autoClose) {
                disconnect(); //    
            }
        }
    }

    /**
     *               
     * 
     * @return                ,                 0     
     * @throws FTPClientException
     */
    public String[] listNames() throws FTPClientException {
        return listNames(null, true);
    }
    
    public String[] listNames(boolean autoClose) throws FTPClientException {
        return listNames(null, autoClose);
    }

    /**
     *             
     * 
     * @param remotePath      
     * @param autoClose           
     * 
     * @return              ,                 0     
     * @throws FTPClientException
     */
    public String[] listNames(String remotePath, boolean autoClose) throws FTPClientException {
        try {
            String[] listNames = getFTPClient().listNames(remotePath);
            return listNames;
        } catch (IOException e) {
            throw new FTPClientException("                 ", e);
        } finally {
            if (autoClose) {
                disconnect(); //    
            }
        }
    }

    public static void main(String[] args) throws FTPClientException, InterruptedException {
        FTPClientTemplate ftp = new FTPClientTemplate();
        ftp.setHost("localhost");
        ftp.setPort(2121);
        ftp.setUsername("admin");
        ftp.setPassword("admin");
        ftp.setBinaryTransfer(false);
        ftp.setPassiveMode(false);
        ftp.setEncoding("utf-8");

        //boolean ret = ftp.put("/group/tbdev/query/user-upload/12345678910.txt", "D:/099_temp/query/12345.txt");
        //System.out.println(ret);
        ftp.mkdir("asd", "user-upload");
        
        //ftp.disconnect();
        //ftp.mkdir("user-upload1");
        //ftp.disconnect();
        
        //String[] aa = {"/group/tbdev/query/user-upload/123.txt", "/group/tbdev/query/user-upload/SMTrace.txt"};
        //ftp.delete(aa);
    }
}