[jboss-svn-commits] JBL Code SVN: r7557 - labs/jbossesb/workspace/b_georges/product/core/rosetta/src/org/jboss/internal/soa/esb/util

jboss-svn-commits at lists.jboss.org jboss-svn-commits at lists.jboss.org
Sun Nov 12 11:02:04 EST 2006


Author: b_georges
Date: 2006-11-12 11:02:02 -0500 (Sun, 12 Nov 2006)
New Revision: 7557

Modified:
   labs/jbossesb/workspace/b_georges/product/core/rosetta/src/org/jboss/internal/soa/esb/util/EdtFtpImpl.java
Log:
Refactoring work. In progress

Modified: labs/jbossesb/workspace/b_georges/product/core/rosetta/src/org/jboss/internal/soa/esb/util/EdtFtpImpl.java
===================================================================
--- labs/jbossesb/workspace/b_georges/product/core/rosetta/src/org/jboss/internal/soa/esb/util/EdtFtpImpl.java	2006-11-12 15:57:44 UTC (rev 7556)
+++ labs/jbossesb/workspace/b_georges/product/core/rosetta/src/org/jboss/internal/soa/esb/util/EdtFtpImpl.java	2006-11-12 16:02:02 UTC (rev 7557)
@@ -1,24 +1,24 @@
 /*
-* JBoss, Home of Professional Open Source
-* Copyright 2006, JBoss Inc., and individual contributors as indicated
-* by the @authors tag. See the copyright.txt in the distribution for a
-* full listing of individual contributors.
-*
-* This is free software; you can redistribute it and/or modify it
-* under the terms of the GNU Lesser General Public License as
-* published by the Free Software Foundation; either version 2.1 of
-* the License, or (at your option) any later version.
-*
-* This software is distributed in the hope that it will be useful,
-* but WITHOUT ANY WARRANTY; without even the implied warranty of
-* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-* Lesser General Public License for more details.
-*
-* You should have received a copy of the GNU Lesser General Public
-* License along with this software; if not, write to the Free
-* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
-* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
-*/
+ * JBoss, Home of Professional Open Source
+ * Copyright 2006, JBoss Inc., and individual contributors as indicated
+ * by the @authors tag. See the copyright.txt in the distribution for a
+ * full listing of individual contributors.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ */
 package org.jboss.internal.soa.esb.util;
 
 import java.io.File;
@@ -34,233 +34,270 @@
 
 /**
  * Simplified FTP transfers
- * <p>Description:  Implements a simple set of FTP functionality
- * Parameters to establish the FTP connection are provided at construction time
- * and cannot change during the lifetime of the object
- * <br/>Hides low level details.  Current implementation is based on the
- * "Entreprise Distributed Technology edtFTPj" library
- * but this can be changed with no impact to existing code, just by changing
- * this class without modifying the signature of it's public methods
+ * <p>
+ * Description: Implements a simple set of FTP functionality Parameters to
+ * establish the FTP connection are provided at construction time and cannot
+ * change during the lifetime of the object <br/>Hides low level details.
+ * Current implementation is based on the "Entreprise Distributed Technology
+ * edtFTPj" library but this can be changed with no impact to existing code,
+ * just by changing this class without modifying the signature of it's public
+ * methods
  * </p>
  */
 
-public class EdtFtpImpl implements RemoteFileSystem
-{
-  private static final String TMP_SUFFIX	= ".rosettaPart";
+public class EdtFtpImpl implements RemoteFileSystem {
+	private static final String TMP_SUFFIX = ".rosettaPart";
 
-  public enum XFER_TYPE
-  {ascii
-  ,binary
-  };
+	public enum XFER_TYPE {
+		ascii, binary
+	};
 
-  private ConfigTree	m_oParms;
-  private String    	m_sFtpServer  ,m_sUser        ,m_sPasswd;
-  private String    	m_sRemoteDir  ,m_sLocalDir;
-  private int			m_iPort;
-  private boolean		m_bPassive;
-  /* (non-Javadoc)
- * @see org.jboss.soa.esb.util.RemoteFileSystem#getRemoteDir()
- */
-public  String getRemoteDir()  { return m_sRemoteDir; }
+	private ConfigTree m_oParms;
 
-  private FTPClient  	m_oConn = new FTPClient();
-  private FTPTransferType m_oXferType = FTPTransferType.BINARY;
+	private String m_sFtpServer, m_sUser, m_sPasswd;
 
-  /**
-   * Checks validity and completeness of parameters, and keeps the info internally
-   * for subsequent FTP requests
-   * @param p_oP ConfigTree
-   * @throws Exception : if parameters are invalid or incomplete
-   * <li>Parameters: (XML attributes at the root level) </li>
-   * <li> ftpServer = name or IP of FTP server </li>
-   * <li> ftpUser = login ID for server </li>
-   * <li> ftpPassword </li>
-   * <li> localDirURI = absolute path in the local filesystem </li>
-   * <li> remoteDirURI = remote path is relative to ftp user home in remote
-   * computer </li>
-   */
+	private String m_sRemoteDir, m_sLocalDir;
 
-  public EdtFtpImpl (ConfigTree p_oP, boolean p_bConnect) throws Exception
-   { m_oParms = p_oP;
-   	 initialize(p_bConnect);
-   } //_________________________________
+	private int m_iPort;
 
-  public EdtFtpImpl (List<KeyValuePair> attribs, boolean connect) throws Exception
-  {
-	  m_oParms = new ConfigTree("fromProps");
-	  for (KeyValuePair oCurr : attribs)
-		m_oParms.setAttribute(oCurr.getKey(),oCurr.getValue());
-	  initialize(connect);
-  } //__________________________________
+	private boolean m_bPassive;
 
-  private void initialize(boolean bConnect) throws Exception
-  {
-	     checkParms();
-	     if (bConnect)
-	     {
-		     m_oConn.setRemoteHost	(m_sFtpServer);
-		     m_oConn.setRemotePort(m_iPort);
-		     m_oConn.connect();
-		     for (int i1=0; i1<10 && ! m_oConn.connected(); i1++)
-		    	 Thread.sleep(200);
-		     if (! m_oConn.connected())
-		    	 throw new Exception("Can't connect to FTP server");
-		     m_oConn.user	      	(m_sUser);
-		     m_oConn.password		(m_sPasswd);
-		     m_oConn.setConnectMode	((m_bPassive) ? FTPConnectMode.PASV : FTPConnectMode.ACTIVE);
-	     }
-  } //__________________________________
-   /* (non-Javadoc)
- * @see org.jboss.soa.esb.util.RemoteFileSystem#quit()
- */
-   public void quit ()
-   { if (null != m_oConn)
-      try { m_oConn.quit(); }
-      catch (Exception e) {}
-   } //_________________________________
+	/*
+	 * (non-Javadoc)
+	 * 
+	 * @see org.jboss.soa.esb.util.RemoteFileSystem#getRemoteDir()
+	 */
+	public String getRemoteDir() {
+		return m_sRemoteDir;
+	}
 
-   /* (non-Javadoc)
- * @see org.jboss.soa.esb.util.RemoteFileSystem#deleteRemoteFile(java.lang.String)
- */
-   public void deleteRemoteFile (String p_sFile) throws Exception
-   { m_oConn.delete(getRemoteDir()+"/"+new File(p_sFile).getName());
-   } //_________________________________
+	private FTPClient m_oConn = new FTPClient();
 
-   /* (non-Javadoc)
- * @see org.jboss.soa.esb.util.RemoteFileSystem#remoteDelete(java.io.File)
- */
-public void remoteDelete (File p_oFile) throws Exception
-   { m_oConn.delete(fileToFtpString(p_oFile));
-   } //_________________________________
+	private FTPTransferType m_oXferType = FTPTransferType.BINARY;
 
-   /* (non-Javadoc)
- * @see org.jboss.soa.esb.util.RemoteFileSystem#getFileListFromRemoteDir(java.lang.String)
- */
-   public String[] getFileListFromRemoteDir (String p_sSuffix) throws Exception
-   {
-	   String sSuffix = (null==p_sSuffix)?"*":"*"+p_sSuffix;
-	   return m_oConn.dir(sSuffix);
-   } //_________________________________
+	/**
+	 * Checks validity and completeness of parameters, and keeps the info
+	 * internally for subsequent FTP requests
+	 * 
+	 * @param p_oP
+	 *            ConfigTree
+	 * @throws Exception :
+	 *             if parameters are invalid or incomplete
+	 *             <li>Parameters: (XML attributes at the root level) </li>
+	 *             <li> ftpServer = name or IP of FTP server </li>
+	 *             <li> ftpUser = login ID for server </li>
+	 *             <li> ftpPassword </li>
+	 *             <li> localDirURI = absolute path in the local filesystem
+	 *             </li>
+	 *             <li> remoteDirURI = remote path is relative to ftp user home
+	 *             in remote computer </li>
+	 */
 
-   /* (non-Javadoc)
- * @see org.jboss.soa.esb.util.RemoteFileSystem#setRemoteDir(java.lang.String)
- */
-   public void setRemoteDir (String p_sDir) throws Exception
-   {
-	   m_oConn.chdir(p_sDir);
-   } //_________________________________
+	public EdtFtpImpl(ConfigTree p_oP, boolean p_bConnect) throws Exception {
+		m_oParms = p_oP;
+		initialize(p_bConnect);
+	}
+	
+	public EdtFtpImpl(List<KeyValuePair> attribs, boolean connect)
+			throws Exception {
+		m_oParms = new ConfigTree("fromProps");
+		for (KeyValuePair oCurr : attribs)
+			m_oParms.setAttribute(oCurr.getKey(), oCurr.getValue());
+		initialize(connect);
+	}
+	
+	private void initialize(boolean bConnect) throws Exception {
+		checkParms();
+		if (bConnect) {
+			m_oConn.setRemoteHost(m_sFtpServer);
+			m_oConn.setRemotePort(m_iPort);
+			m_oConn.connect();
+			for (int i1 = 0; i1 < 10 && !m_oConn.connected(); i1++)
+				Thread.sleep(200);
+			if (!m_oConn.connected())
+				throw new Exception("Can't connect to FTP server");
+			m_oConn.user(m_sUser);
+			m_oConn.password(m_sPasswd);
+			m_oConn.setConnectMode((m_bPassive) ? FTPConnectMode.PASV
+					: FTPConnectMode.ACTIVE);
+		}
+	}
+	
+	/*
+	 * (non-Javadoc)
+	 * 
+	 * @see org.jboss.soa.esb.util.RemoteFileSystem#quit()
+	 */
+	public void quit() {
+		if (null != m_oConn)
+			try {
+				m_oConn.quit();
+			} catch (Exception e) {
+			}
+	}
+	
+	/*
+	 * (non-Javadoc)
+	 * 
+	 * @see org.jboss.soa.esb.util.RemoteFileSystem#deleteRemoteFile(java.lang.String)
+	 */
+	public void deleteRemoteFile(String p_sFile) throws Exception {
+		m_oConn.delete(getRemoteDir() + "/" + new File(p_sFile).getName());
+	}
+	
+	/*
+	 * (non-Javadoc)
+	 * 
+	 * @see org.jboss.soa.esb.util.RemoteFileSystem#remoteDelete(java.io.File)
+	 */
+	public void remoteDelete(File p_oFile) throws Exception {
+		m_oConn.delete(fileToFtpString(p_oFile));
+	}
+	
+	/*
+	 * (non-Javadoc)
+	 * 
+	 * @see org.jboss.soa.esb.util.RemoteFileSystem#getFileListFromRemoteDir(java.lang.String)
+	 */
+	public String[] getFileListFromRemoteDir(String p_sSuffix) throws Exception {
+		String sSuffix = (null == p_sSuffix) ? "*" : "*" + p_sSuffix;
+		return m_oConn.dir(sSuffix);
+	}
+	
+	/*
+	 * (non-Javadoc)
+	 * 
+	 * @see org.jboss.soa.esb.util.RemoteFileSystem#setRemoteDir(java.lang.String)
+	 */
+	public void setRemoteDir(String p_sDir) throws Exception {
+		m_oConn.chdir(p_sDir);
+	}
+	
+	/*
+	 * (non-Javadoc)
+	 * 
+	 * @see org.jboss.soa.esb.util.RemoteFileSystem#renameInRemoteDir(java.lang.String,
+	 *      java.lang.String)
+	 */
+	public void renameInRemoteDir(String p_sFrom, String p_sTo)
+			throws Exception {
+		String sRmtFrom = new File(p_sFrom).getName();
+		String sRmtTo = new File(p_sTo).getName();
 
-   /* (non-Javadoc)
- * @see org.jboss.soa.esb.util.RemoteFileSystem#renameInRemoteDir(java.lang.String, java.lang.String)
- */
-   public void renameInRemoteDir (String p_sFrom, String p_sTo) throws Exception
-   {
-	 String sRmtFrom = new File(p_sFrom).getName();
-     String sRmtTo   = new File(p_sTo).getName();
+		try {
+			m_oConn.rename(getRemoteDir() + "/" + sRmtFrom, getRemoteDir()
+					+ "/" + sRmtTo);
+		} catch (Exception e) {
+			String sMess = this.getClass().getSimpleName()
+					+ " can't rename in remote directory <" + e.getMessage()
+					+ ">";
+			throw new Exception(sMess);
+		}
+	}
+	
+	/*
+	 * (non-Javadoc)
+	 * 
+	 * @see org.jboss.soa.esb.util.RemoteFileSystem#remoteRename(java.io.File,
+	 *      java.io.File)
+	 */
+	public void remoteRename(File p_oFrom, File p_oTo) throws Exception {
+		try {
+			m_oConn.rename(fileToFtpString(p_oFrom), fileToFtpString(p_oTo));
+		} catch (Exception e) {
+			String sMess = this.getClass().getSimpleName()
+					+ " can't rename in remote directory <" + e.getMessage()
+					+ ">";
+			throw new Exception(sMess);
+		}
+	}
+	
+	/*
+	 * (non-Javadoc)
+	 * 
+	 * @see org.jboss.soa.esb.util.RemoteFileSystem#uploadFile(java.io.File,
+	 *      java.lang.String)
+	 */
+	public void uploadFile(File p_oFile, String p_sRemoteName) throws Exception {
+		String sRemoteOK = getRemoteDir() + "/" + p_sRemoteName;
+		String sRemoteTmp = sRemoteOK + TMP_SUFFIX;
+		m_oConn.setType(m_oXferType);
+		m_oConn.put(fileToFtpString(p_oFile), sRemoteTmp);
+		m_oConn.rename(sRemoteTmp, sRemoteOK);
+	}
+	
+	/*
+	 * (non-Javadoc)
+	 * 
+	 * @see org.jboss.soa.esb.util.RemoteFileSystem#downloadFile(java.lang.String,
+	 *      java.lang.String)
+	 */
+	public void downloadFile(String p_sFile, String p_sFinalName)
+			throws Exception {
+		File oLocalDir = new File(m_sLocalDir);
+		File oLclFile = File.createTempFile("Rosetta_", TMP_SUFFIX, oLocalDir);
 
-     try { m_oConn.rename   (getRemoteDir()+"/"+sRmtFrom,getRemoteDir()+"/"+sRmtTo); }
-     catch (Exception e)
-     {	String sMess = this.getClass().getSimpleName()
-    	 +" can't rename in remote directory <"
-    	 +e.getMessage()+">"
-    	 ;
-    	 throw new Exception(sMess);
-     }
-   } //_________________________________
+		try {
+			oLclFile.delete();
+		} catch (Exception e) {
+		}
+		m_oConn.setType(m_oXferType);
+		m_oConn.get(fileToFtpString(oLclFile), p_sFile);
 
-   /* (non-Javadoc)
- * @see org.jboss.soa.esb.util.RemoteFileSystem#remoteRename(java.io.File, java.io.File)
- */
-public void remoteRename(File p_oFrom, File p_oTo) throws Exception
-   {
-     try { m_oConn.rename   (fileToFtpString(p_oFrom),fileToFtpString(p_oTo)); }
-     catch (Exception e)
-     {	String sMess = this.getClass().getSimpleName()
-    	 +" can't rename in remote directory <"
-    	 +e.getMessage()+">"
-    	 ;
-    	 throw new Exception(sMess);
-     }
-   } //_________________________________
+		File oNew = new File(oLocalDir, p_sFinalName);
+		if (oNew.exists())
+			oNew.delete();
+		oLclFile.renameTo(oNew);
+	}
+	
+	// Beware !!! The logic here seems wrong, but it works
+	// It appears that there's some kind of bug in the edtftpj.jar library
+	// The !XFER_TYPE.ascii.equals(p_oMode) should NOT be negated
+	// But it works when negated (newlines from Unix to DOS)
+	private void setXferType(XFER_TYPE p_oMode) {
+		m_oXferType = !XFER_TYPE.ascii.equals(p_oMode) ? FTPTransferType.ASCII
+				: FTPTransferType.BINARY;
+	}
+	
+	private void checkParms() throws Exception {
+		m_sFtpServer = m_oParms.getAttribute(PARMS_FTP_SERVER);
+		if (null == m_sFtpServer)
+			throw new Exception("No FTP server specified");
 
-   /* (non-Javadoc)
- * @see org.jboss.soa.esb.util.RemoteFileSystem#uploadFile(java.io.File, java.lang.String)
- */
-   public void uploadFile (File p_oFile, String p_sRemoteName) throws Exception
-   {
-	 String sRemoteOK	= getRemoteDir() + "/" + p_sRemoteName;
-     String sRemoteTmp	= sRemoteOK+TMP_SUFFIX;
-     m_oConn.setType(m_oXferType);
-     m_oConn.put(fileToFtpString(p_oFile),sRemoteTmp);
-     m_oConn.rename(sRemoteTmp,sRemoteOK);
-   } //_________________________________
+		m_sUser = m_oParms.getAttribute(PARMS_USER);
+		if (null == m_sUser)
+			throw new Exception("No username specified for FTP");
 
-   /* (non-Javadoc)
- * @see org.jboss.soa.esb.util.RemoteFileSystem#downloadFile(java.lang.String, java.lang.String)
- */
-   public void downloadFile (String p_sFile, String p_sFinalName)  throws Exception
-   {
-	 File oLocalDir = new File(m_sLocalDir);
-     File oLclFile= File.createTempFile("Rosetta_",TMP_SUFFIX,oLocalDir);
+		m_sPasswd = m_oParms.getAttribute(PARMS_PASSWD);
+		if (null == m_sPasswd)
+			throw new Exception("No password specified for FTP");
 
-     try { oLclFile.delete(); }
-     catch (Exception e) {}
-     m_oConn.setType(m_oXferType);
-     m_oConn.get(fileToFtpString(oLclFile),p_sFile);
+		m_sRemoteDir = m_oParms.getAttribute(PARMS_REMOTE_DIR);
+		if (null == m_sRemoteDir)
+			m_sRemoteDir = "";
 
-     File oNew = new File(oLocalDir,p_sFinalName);
-     if (oNew.exists()) oNew.delete();
-     oLclFile.renameTo(oNew);
-   } //_________________________________
+		m_sLocalDir = m_oParms.getAttribute(PARMS_LOCAL_DIR);
+		if (null == m_sLocalDir)
+			m_sLocalDir = ".";
 
-   // Beware !!!  The logic here seems wrong, but it works
-   //  It appears that there's some kind of bug in the edtftpj.jar library
-   //  The !XFER_TYPE.ascii.equals(p_oMode) should NOT be negated
-   //               But it works when negated (newlines from Unix to DOS)
-   private void setXferType (XFER_TYPE p_oMode)
-   {	m_oXferType = !XFER_TYPE.ascii.equals(p_oMode)
-	   		? FTPTransferType.ASCII : FTPTransferType.BINARY;
-   } //_________________________________
+		String sAux = m_oParms.getAttribute(PARMS_PORT);
+		m_iPort = (null == sAux) ? 21 : Integer.parseInt(sAux);
 
-   private void checkParms() throws Exception
-   {
-     m_sFtpServer  = m_oParms.getAttribute(PARMS_FTP_SERVER);
-     if (null==m_sFtpServer) throw new Exception ("No FTP server specified");
+		boolean bAscii = false;
+		sAux = m_oParms.getAttribute(PARMS_ASCII);
+		if (null != sAux)
+			bAscii = Boolean.parseBoolean(sAux);
+		setXferType((bAscii) ? XFER_TYPE.ascii : XFER_TYPE.binary);
 
-     m_sUser       = m_oParms.getAttribute(PARMS_USER);
-     if (null==m_sUser) throw new Exception ("No username specified for FTP");
+		m_bPassive = false;
+		sAux = m_oParms.getAttribute(PARMS_PASSIVE);
+		m_bPassive = (null != sAux) && Boolean.parseBoolean(sAux);
 
-     m_sPasswd     = m_oParms.getAttribute(PARMS_PASSWD);
-     if (null==m_sPasswd) throw new Exception ("No password specified for FTP");
-
-     m_sRemoteDir  = m_oParms.getAttribute(PARMS_REMOTE_DIR);
-     if (null==m_sRemoteDir)
-    	 m_sRemoteDir = "";
-
-     m_sLocalDir  = m_oParms.getAttribute(PARMS_LOCAL_DIR);
-     if (null==m_sLocalDir)
-    	 m_sLocalDir = ".";
-
-     String sAux	= m_oParms.getAttribute(PARMS_PORT);
-     m_iPort = (null==sAux) ? 21 : Integer.parseInt(sAux);
-
-     boolean bAscii = false;
-     sAux = m_oParms.getAttribute(PARMS_ASCII);
-     if (null!=sAux)
-    	 bAscii = Boolean.parseBoolean(sAux);
-     setXferType((bAscii)?XFER_TYPE.ascii:XFER_TYPE.binary);
-
-     m_bPassive = false;
-     sAux = m_oParms.getAttribute(PARMS_PASSIVE);
-     m_bPassive = (null!=sAux) && Boolean.parseBoolean(sAux);
-
-     return;
-   } //__________________________________
-
-   public static String fileToFtpString(File p_oF)
-	{
-		return(null==p_oF) ? null
-			: p_oF.toString().replace("\\","/");
-    } //________________________________
-
-} //____________________________________________________________________________
+		return;
+	}
+	
+	public static String fileToFtpString(File p_oF) {
+		return (null == p_oF) ? null : p_oF.toString().replace("\\", "/");
+	}
+	
+}
\ No newline at end of file




More information about the jboss-svn-commits mailing list