[NET-584] Error when using org.apache.commons.net.ftp.FTPClient setControlKeepAliveTimeout

• Type: Bug
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 3.7
• Component/s: FTP
• Assignee: Unassigned
• Reporter: Kazantsev Andrey Sergeevich
• Created: 17/Dec/15 09:20
• Updated: 06/Aug/20 12:27
• Resolved: 20/Mar/17 21:21

Description

I have a question about using library commons-net-3.4.jar
Question is about org.apache.commons.net.ftp.FTPClient method setControlKeepAliveTimeout.

Read about using it on:
https://commons.apache.org/proper/commons-net/apidocs/org/apache/commons/net/ftp/FTPClient.html

When I use it in my code I get this error:

java.net.SocketTimeoutException: Read timed out
	at java.net.SocketInputStream.socketRead0(Native Method)
	at java.net.SocketInputStream.read(SocketInputStream.java:163)
	at java.net.SocketInputStream.read(SocketInputStream.java:133)
	at sun.nio.cs.StreamDecoder.readBytes(StreamDecoder.java:322)
	at sun.nio.cs.StreamDecoder.implRead(StreamDecoder.java:364)
	at sun.nio.cs.StreamDecoder.read(StreamDecoder.java:210)
	at java.io.InputStreamReader.read(InputStreamReader.java:205)
	at java.io.BufferedReader.fill(BufferedReader.java:165)
	at java.io.BufferedReader.read(BufferedReader.java:186)
	at org.apache.commons.net.io.CRLFLineReader.readLine(CRLFLineReader.java:58)
	at org.apache.commons.net.ftp.FTP.__getReply(FTP.java:313)
	at org.apache.commons.net.ftp.FTP.__getReplyNoReport(FTP.java:303)
	at org.apache.commons.net.ftp.FTPClient$CSL.cleanUp(FTPClient.java:3838)
	at org.apache.commons.net.ftp.FTPClient._storeFile(FTPClient.java:695)
	at org.apache.commons.net.ftp.FTPClient.__storeFile(FTPClient.java:643)
	at org.apache.commons.net.ftp.FTPClient.storeFile(FTPClient.java:2033)
	at ru.mdm.File.Transfer.FTP.PutRemoteFileBinary(FTP.java:192)
	at ru.mdm.File.Transfer.TimeLimit.Thread.Protocol.PutRemoteFileBinaryThread.actionsToExecute(PutRemoteFileBinaryThread.java:23)
	at ru.mdm.File.Transfer.TimeLimit.OperationThread.run(OperationThread.java:60)

Without enabling this option all works fine.

Here is the code:

package ru.mdm.File.Transfer;
import bin.ru.osa.common.utils.*;
import java.util.List;
import java.io.*;
import com.ibm.broker.javacompute.MbJavaComputeNode;
import com.ibm.broker.plugin.*;
import org.apache.commons.net.ftp.*;
import org.apache.commons.net.*;
import ru.mdm.File.Transfer.Options.OptionsXMLProcessor;

public class FTP implements Protocol 
{
	
	FTPClient client = new FTPClient();
	
	OptionsXMLProcessor optionsXMLProcessor;
	
	
	boolean   st;
	String LastMessage = new String();
	
	boolean   ignoreErrors = false;
	
	
	public FTP() 
	{
		super();		
	}

	
	protected void finalize() { disconnect(); }

	
	public void connect(String CntName, 
						String Host, 
						String Port, 
						String L, 
						String P)  throws Exception
	{
	  try
	  {		
		client.setControlKeepAliveTimeout(300);
	    client.connect(Host);
	    client.login(L, P);
	    CheckState();	    
	  }
	  catch(Exception e)
	  {
	     LastMessage=client.getReplyString();	     	     
	     if(LastMessage == null) LastMessage = e.getMessage();
	     
	     e.printStackTrace();
	     
		 throw e;
	  }
	}	
	
	public void disconnect()
	{
		try
		{
			if(client.isConnected())
			{
				client.logout();  
				client.disconnect();
			}
		}
		catch(Exception e)
		{			
			e.printStackTrace();
		}
	}	
	
	public void chmod(String RemoteFile, String Rights)  throws Exception
	{
		client.sendSiteCommand("chmod "+RemoteFile+" "+Rights);
		CheckState();
	}
	
	
	public void lsMB(MbElement InputDir,MbElement filelist)   throws Exception, MbException
	{
		MbElement xfile;		
		
		for (FTPFile file : client.listFiles((String)InputDir.evaluateXPath("string(SOURCE_PATH)")))
        {
          if(!file.isFile()) continue; //-- No sub-dirs, No Symlinks !	                      
          
          xfile=filelist.createElementAsLastChild(MbElement.TYPE_NAME, "File", null);
          xfile.createElementAsLastChild(MbElement.TYPE_NAME, "FileName", file.getName());
          xfile.createElementAsLastChild(MbElement.TYPE_NAME, "FileSize", file.getSize());
          xfile.createElementAsLastChild(MbElement.TYPE_NAME, "SourcePath", (String)InputDir.evaluateXPath("string(SOURCE_PATH)"));
          xfile.createElementAsLastChild(MbElement.TYPE_NAME, "SourceGateway", (String)InputDir.evaluateXPath("string(GATEWAY_NAME)"));
        }		
	}
	
	public void mkdir(String RemotePath)   throws Exception
	{
	   client.makeDirectory(RemotePath);
	   CheckState();
	}

	
	public void chdir(String RemotePath)   throws Exception
	{
		client.changeWorkingDirectory(RemotePath);	
		CheckState();
	}


	
	public void delete(String RemotePath)   throws Exception
	{
		client.deleteFile(RemotePath);	
		CheckState();
	}
	
	
		
	public void rename(String RemoteFileSrc, String RemoteFileDst)    throws Exception
	{
	     client.rename(RemoteFileSrc, RemoteFileDst);
	     CheckState();
	}
	
		
   public void GetRemoteFileBinary(String RemoteFile, String LocalFile)     throws Exception
   {
	   client.enterLocalPassiveMode();
       client.setFileType(FTPClient.BINARY_FILE_TYPE);
       client.retrieveFile(RemoteFile, 
     		               new FileOutputStream(LocalFile));
       
       
       CheckState();
    }

  		
   public void PutRemoteFileBinary(String LocalFile, String RemoteFile)      throws Exception
   {
       client.enterLocalPassiveMode();
       client.setFileType(FTPClient.BINARY_FILE_TYPE);
       client.storeFile(RemoteFile, 
    		            new FileInputStream(LocalFile));	
       CheckState();
   }   
   
   
	public void ignoreErrors(boolean x)  { ignoreErrors=x;	}
   
	
	public boolean isOK()  { return st;	}

	
	public boolean isConnected()	
	{
		boolean answer=false;
		try {
			answer = client.sendNoOp();
		} catch (IOException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		}		
		st = answer;
		return answer;		
       
	}
	
	
	public String LastMessage() {	return LastMessage;	};
	
	
	public void CheckState(boolean state) throws Exception
	{
	    int reply = client.getReplyCode();
        if(FTPReply.isPositiveCompletion(reply))    st=true;
        else                                        st=false;
		
        LastMessage=client.getReplyString();	
		
		if(!st && !ignoreErrors)	
			throw new Exception(LastMessage);
	}
	
	public void CheckState() throws Exception
	{
	    int reply = client.getReplyCode();
        if(FTPReply.isPositiveCompletion(reply))    st=true;
        else                                        st=false;
		
        LastMessage=client.getReplyString();	
		
		if(!st && !ignoreErrors)	
			throw new Exception(LastMessage);
	}
	
	public void attachOptions(OptionsXMLProcessor optionsXMLProcessor) throws Exception 
	{
		this.optionsXMLProcessor = optionsXMLProcessor;
	}


	
	public String getIP() {
		
		return "";
	}
	
	public boolean isIgnoreErrors() 
	{		
		return ignoreErrors;
	}
}