[jboss-svn-commits] JBL Code SVN: r6286 - in labs/jbossesb/branches/JBESB_4_0_Beta1_maint/product/core/listeners/src/org/jboss/soa/esb: actions listeners

jboss-svn-commits at lists.jboss.org jboss-svn-commits at lists.jboss.org
Mon Sep 18 16:14:36 EDT 2006


Author: estebanschifman
Date: 2006-09-18 16:14:30 -0400 (Mon, 18 Sep 2006)
New Revision: 6286

Added:
   labs/jbossesb/branches/JBESB_4_0_Beta1_maint/product/core/listeners/src/org/jboss/soa/esb/actions/FtpClientUtil.java
   labs/jbossesb/branches/JBESB_4_0_Beta1_maint/product/core/listeners/src/org/jboss/soa/esb/actions/FtpDownloader.java
   labs/jbossesb/branches/JBESB_4_0_Beta1_maint/product/core/listeners/src/org/jboss/soa/esb/actions/FtpUploader.java
   labs/jbossesb/branches/JBESB_4_0_Beta1_maint/product/core/listeners/src/org/jboss/soa/esb/listeners/RemoteDirectoryPoller.java
Modified:
   labs/jbossesb/branches/JBESB_4_0_Beta1_maint/product/core/listeners/src/org/jboss/soa/esb/actions/AbstractFileAction.java
Log:
New FTP classes and fixes to accomodate them

Modified: labs/jbossesb/branches/JBESB_4_0_Beta1_maint/product/core/listeners/src/org/jboss/soa/esb/actions/AbstractFileAction.java
===================================================================
--- labs/jbossesb/branches/JBESB_4_0_Beta1_maint/product/core/listeners/src/org/jboss/soa/esb/actions/AbstractFileAction.java	2006-09-18 20:12:14 UTC (rev 6285)
+++ labs/jbossesb/branches/JBESB_4_0_Beta1_maint/product/core/listeners/src/org/jboss/soa/esb/actions/AbstractFileAction.java	2006-09-18 20:14:30 UTC (rev 6286)
@@ -57,8 +57,16 @@
 	public File getErrorFile() { return ((Params)m_oCurr).oErrF; }
 	public File getDoneOkFile(){ return ((Params)m_oCurr).oDoneF; }
 	
-	public boolean renameToError() { return getWorkFile().renameTo(getErrorFile()); }
-	public boolean renameToDone () { return getWorkFile().renameTo(getDoneOkFile()); }
+	public boolean renameToError() 
+	{	
+		getErrorFile().delete();
+		return getWorkFile().renameTo(getErrorFile()); 
+	}
+	public boolean renameToDone () 
+	{ 	
+		getDoneOkFile().delete();
+		return getWorkFile().renameTo(getDoneOkFile()); 
+	}
 
 /**
  * Overrides run() in AbstractAction

Added: labs/jbossesb/branches/JBESB_4_0_Beta1_maint/product/core/listeners/src/org/jboss/soa/esb/actions/FtpClientUtil.java
===================================================================
--- labs/jbossesb/branches/JBESB_4_0_Beta1_maint/product/core/listeners/src/org/jboss/soa/esb/actions/FtpClientUtil.java	2006-09-18 20:12:14 UTC (rev 6285)
+++ labs/jbossesb/branches/JBESB_4_0_Beta1_maint/product/core/listeners/src/org/jboss/soa/esb/actions/FtpClientUtil.java	2006-09-18 20:14:30 UTC (rev 6286)
@@ -0,0 +1,255 @@
+package org.jboss.soa.esb.actions;
+
+import com.enterprisedt.net.ftp.*;
+
+import java.io.*;
+
+import org.jboss.soa.esb.helpers.*;
+
+/**
+ * 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>
+ */
+
+public class FtpClientUtil
+{
+  public  static final String PARMS_FTP_SERVER = "ftpServer";
+  public  static final String PARMS_USER    = "ftpUser";
+  public  static final String PARMS_PASSWD  = "ftpPassword";
+  public  static final String PARMS_PORT    = "ftpPort";
+  public  static final String PARMS_REMOTE_DIR = "ftpRemoteDir";
+  public  static final String PARMS_LOCAL_DIR  = "ftpLocalDir";
+  public  static final String PARMS_ASCII      = "ftpAscii";
+  
+  private static final String TMP_SUFFIX	= ".rosettaPart";
+  private static final String DONE_SUFFIX	= ".rosettaDone";
+
+  public enum XFER_TYPE
+  {ascii
+  ,binary
+  };
+
+  private DomElement	m_oParms;
+  private String    	m_sFtpServer  ,m_sUser        ,m_sPasswd;
+  private String    	m_sRemoteDir  ,m_sLocalDir;
+  private int			m_iPort;
+  public  String getRemoteDir()  { return m_sRemoteDir; }
+
+  private FTPClient  	m_oConn = new FTPClient();
+  private FTPTransferType m_oXferType = FTPTransferType.BINARY;
+
+  /**
+   * Checks validity and completeness of parameters, and keeps the info internally
+   * for subsequent FTP requests
+   * @param p_oP DomElement
+   * @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>
+   */
+
+  public FtpClientUtil (DomElement p_oP, boolean p_bConnect) throws Exception
+   { m_oParms = p_oP;
+     checkParms();
+
+     if (p_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	(FTPConnectMode.ACTIVE);
+     }
+   } //_________________________________
+
+   /**
+    * Terminates ftp session and frees resources
+    * <li>Well behaved programs should make sure to call this method </li>
+    */
+   public void quit ()
+   { if (null != m_oConn)
+      try { m_oConn.quit(); }
+      catch (Exception e) {}
+   } //_________________________________
+
+   /**
+    * Deletes specified file in remote directory
+    * @param p_sFile String : filename to delete.  Method will attempt to delete
+    * file with rightmost node of argument within remote directory specified in 'remoteDirURI'
+    * @throws Exception : if ftp connection cannot be established, or file
+    * cannot be deleted in remote directory
+    */
+   public void deleteRemoteFile (String p_sFile) throws Exception
+   { m_oConn.delete(getRemoteDir()+"/"+new File(p_sFile).getName());
+   } //_________________________________
+
+   public void remoteDelete (File p_oFile) throws Exception
+   { m_oConn.delete(fileToFtpString(p_oFile));
+   } //_________________________________
+
+   /**
+    * Gets the list of files in the remote directory that end with arg0
+    * @param p_sSuffix String : retrieve only files that end with that suffix - all files if null
+    * @throws Exception : if ftp connection cannot be established, or problems encountered
+    */
+   public String[] getFileListFromRemoteDir (String p_sSuffix) throws Exception
+   { 
+	   String sSuffix = (null==p_sSuffix)?"*":"*"+p_sSuffix;
+	   return m_oConn.dir(sSuffix);
+   } //_________________________________
+
+   /**
+    * Change remote directory
+    * @param p_sDir String : directory to set 
+    * @throws Exception : if ftp connection cannot be established, or problems encountered
+    */
+   public void setRemoteDir (String p_sDir) throws Exception
+   {
+	   m_oConn.chdir(p_sDir);
+   } //_________________________________
+
+   /**
+    * Renames specified file in remote directory to specified new name
+    * @param p_sFrom String : filename to rename
+    * @param p_sTo String : new filename
+    * @throws Exception : if ftp connection cannot be established, or file
+    * cannot be renamed to new name in remote directory
+    * <li>Method will attempt to rename file with rightmost node of argument
+    * within remote directory specified in 'remoteDirURI', to new name inside
+    * the SAME remote directory
+    */
+   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);
+     }
+   } //_________________________________
+
+   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);
+     }
+   } //_________________________________
+
+   /**
+    * Uploads specified file from local directory (localDirURI) to remote
+    * directory (remoteDirURI)
+    * @param p_sFile String : filename to upload
+    * @throws Exception : if ftp connection cannot be established, or file
+    * cannot be uploaded
+    * <li> local file will be renamed during transfer ('.xferNotReady' appended
+    * to name)</li>
+    * <li> upon successful completion. the suffix '.xferDone' will be appended
+    * to the original filename </li>
+    */
+   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);
+   } //_________________________________
+
+   /**
+    * Downloads specified file from remote directory (remoteDirURI) to local
+    * directory (localDirURI)
+    * @param p_sFile String : filename to download
+    * @throws Exception : if ftp connection cannot be established, or file
+    * cannot be downloaded
+    * <li> local file is assigned a temporary name during transfer  </li>
+    * <li> upon successful completion, local temporary file will be renamed to
+    * name specified in argument, and suffix '.xferDone' will be appended
+    * to the original filename in the remote directory </li>
+    */
+   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 { oLclFile.delete(); }
+     catch (Exception e) {}
+     m_oConn.setType(m_oXferType);
+     m_oConn.get(fileToFtpString(oLclFile),p_sFile);
+
+     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.getAttr(PARMS_FTP_SERVER);
+     if (null==m_sFtpServer) throw new Exception ("No FTP server specified");
+
+     m_sUser       = m_oParms.getAttr(PARMS_USER);
+     if (null==m_sUser) throw new Exception ("No username specified for FTP");
+
+     m_sPasswd     = m_oParms.getAttr(PARMS_PASSWD);
+     if (null==m_sPasswd) throw new Exception ("No password specified for FTP");
+
+     m_sRemoteDir  = m_oParms.getAttr(PARMS_REMOTE_DIR);
+     if (null==m_sRemoteDir)
+    	 m_sRemoteDir = "";
+     
+     m_sLocalDir  = m_oParms.getAttr(PARMS_LOCAL_DIR);
+     if (null==m_sLocalDir)
+    	 m_sLocalDir = ".";
+     
+     String sAux	= m_oParms.getAttr(PARMS_PORT);
+     m_iPort = (null==sAux) ? 21 : Integer.parseInt(sAux);
+
+     boolean bAscii = false;
+     sAux = m_oParms.getAttr(PARMS_ASCII);
+     if (null!=sAux)
+    	 bAscii = Boolean.parseBoolean(sAux);
+     setXferType((bAscii)?XFER_TYPE.ascii:XFER_TYPE.binary);
+     return;
+   } //__________________________________
+
+   public static String fileToFtpString(File p_oF)
+	{
+		return(null==p_oF) ? null
+			: p_oF.toString().replace("\\","/");		
+    } //________________________________
+	
+} //____________________________________________________________________________

Added: labs/jbossesb/branches/JBESB_4_0_Beta1_maint/product/core/listeners/src/org/jboss/soa/esb/actions/FtpDownloader.java
===================================================================
--- labs/jbossesb/branches/JBESB_4_0_Beta1_maint/product/core/listeners/src/org/jboss/soa/esb/actions/FtpDownloader.java	2006-09-18 20:12:14 UTC (rev 6285)
+++ labs/jbossesb/branches/JBESB_4_0_Beta1_maint/product/core/listeners/src/org/jboss/soa/esb/actions/FtpDownloader.java	2006-09-18 20:14:30 UTC (rev 6286)
@@ -0,0 +1,147 @@
+/*
+* 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.soa.esb.actions;
+
+import java.io.*;
+
+import org.jboss.soa.esb.helpers.DomElement;
+import org.jboss.soa.esb.listeners.GpListener;
+
+public class FtpDownloader extends AbstractFileAction 
+{
+	FtpClientUtil 	_ftpClient;
+	String			_sMsg;
+/**
+ * Will connect to an existing FTP server, and download the file
+ * @param p_oP DomElement - Parameter tree passed by controlling listener
+ * @param p_oCurr Object  - This is the object that's going to get processed
+ * <br/>Receives an instance of AbstractFileAction.Params class containing info 
+ * needed to rename the file in different stages of processing 
+ */
+	public FtpDownloader(DomElement p_oP, Object p_oCurr)
+	{	super(p_oP,p_oCurr);
+	} //________________________________
+
+/**
+ * Overrides run() in AbstractFileAction
+ * <p/>Files processed by action classes need to be renamed during processing to
+ * disable other listeners (or other threads launched by the same listener that
+ * started this thread) to pick up the same file
+ * <br/>Once processing ends a suffix will be added to the name of the original
+ * file that has been processed.  The suffix will be different according to the
+ * result of processing (OK or Exception).  Files could be moved to different
+ * directories as well
+ * <br/> Parameters for these options can be provided at run time in the
+ * DomElement (arg 0 in constructor)
+ */
+	public void run()
+	{
+		try 
+		{ 
+			processCurrentObject();
+			if (isPostDelete())
+				_ftpClient.remoteDelete(getWorkFile());
+			else
+				renameToDone();
+			GpListener.notifyOK(m_oParms,getOkNotification());
+		} 
+		catch (Exception e) 
+		{
+			e.printStackTrace();
+			// Leave it just as it was in the source directory, so next poll will try again
+			getWorkFile().renameTo(getInputFile());
+			GpListener.notifyError(m_oParms,e,getErrorNotification());
+		}
+		finally 
+		{	
+			if (null!=_ftpClient)
+				_ftpClient.quit();
+			setChanged();
+			notifyObservers(new Integer(-1)); 
+		}
+	} //________________________________
+
+	@Override
+	public void processCurrentObject() throws Exception 
+	{
+		try
+		{	_ftpClient = new FtpClientUtil(m_oParms,true);
+			_sMsg = new StringBuilder()
+				.append("Upload ").append(getInputFile())
+				.append(" to ").append(_ftpClient.getRemoteDir())
+				.toString();
+			String sFrom = FtpClientUtil.fileToFtpString(getWorkFile());
+			_ftpClient.downloadFile(sFrom,getInputFile().getName());
+		}
+		catch (Exception e)
+		{
+			e.printStackTrace();
+			throw e;
+		}
+	} //________________________________
+
+	@Override
+	public boolean renameToError()
+	{	
+		try 
+		{ _ftpClient.remoteDelete(getErrorFile());
+		  _ftpClient.remoteRename(getWorkFile(),getErrorFile());
+		  return true;
+		}
+		catch (Exception e)
+		{
+			m_oLogger.error("renameToError() FAILED",e);
+			return false;
+		}
+	} //________________________________
+
+	@Override
+	public boolean renameToDone () 
+	{ 	
+		try { _ftpClient.remoteDelete(getDoneOkFile()); }
+		catch (Exception eDel) {/*  OK do nothing - It just wasn't there  */}
+		try 
+		{ 
+		  _ftpClient.remoteRename(getWorkFile(),getDoneOkFile());
+		  return true;
+		}
+		catch (Exception e)
+		{
+			m_oLogger.error("renameToDone() FAILED",e);
+			return false;
+		}
+	} //________________________________
+
+	@Override
+	public Serializable getOkNotification() 
+	{
+		return _sMsg + " - OK";
+	} //________________________________
+	
+	@Override
+	public Serializable getErrorNotification() 
+	{
+		return "Failed to "+ _sMsg;
+	} //________________________________
+	
+} //____________________________________________________________________________

Added: labs/jbossesb/branches/JBESB_4_0_Beta1_maint/product/core/listeners/src/org/jboss/soa/esb/actions/FtpUploader.java
===================================================================
--- labs/jbossesb/branches/JBESB_4_0_Beta1_maint/product/core/listeners/src/org/jboss/soa/esb/actions/FtpUploader.java	2006-09-18 20:12:14 UTC (rev 6285)
+++ labs/jbossesb/branches/JBESB_4_0_Beta1_maint/product/core/listeners/src/org/jboss/soa/esb/actions/FtpUploader.java	2006-09-18 20:14:30 UTC (rev 6286)
@@ -0,0 +1,114 @@
+/*
+* 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.soa.esb.actions;
+
+import java.io.*;
+
+import org.jboss.soa.esb.helpers.DomElement;
+import org.jboss.soa.esb.listeners.GpListener;
+
+public class FtpUploader extends AbstractFileAction 
+{
+	FtpClientUtil 	_ftpClient;
+	String			_sMsg;
+/**
+ * Will connect to an existing FTP server, and upload the file
+ * @param p_oP DomElement - Parameter tree passed by controlling listener
+ * @param p_oCurr Object  - This is the object that's going to get processed
+ * <br/>Receives an instance of the AbstractFileAction.Params class containing info 
+ * needed to rename the file in different stages of processing 
+ */
+	public FtpUploader(DomElement p_oP, Object p_oCurr)
+	{	super(p_oP,p_oCurr);
+	} //________________________________
+
+/**
+ * Overrides run() in AbstractFileAction
+ * <p/>Files processed by action classes need to be renamed during processing to
+ * disable other listeners (or other threads launched by the same listener that
+ * started this thread) to pick up the same file
+ * <br/>Once processing ends a suffix will be added to the name of the original
+ * file that has been processed.  The suffix will be different according to the
+ * result of processing (OK or Exception).  Files could be moved to different
+ * directories as well
+ * <br/> Parameters for these options can be provided at run time in the
+ * DomElement (arg 0 in constructor)
+ */
+	public void run()
+	{
+		try 
+		{ 
+			processCurrentObject();
+			if (isPostDelete())
+				getWorkFile().delete();
+			else
+				renameToDone();
+			GpListener.notifyOK(m_oParms,getOkNotification());
+		} 
+		catch (Exception e) 
+		{
+			// Leave it just as it was in the source directory, so next poll will try again
+			getWorkFile().renameTo(getInputFile());
+			GpListener.notifyError(m_oParms,e,getErrorNotification());
+		}
+		finally 
+		{	
+			if (null!=_ftpClient)
+				_ftpClient.quit();
+			setChanged();
+			notifyObservers(new Integer(-1)); 
+		}
+	} //________________________________
+
+	@Override
+	public void processCurrentObject() throws Exception 
+	{
+		try
+		{	_ftpClient = new FtpClientUtil(m_oParms,true);
+			_sMsg = new StringBuilder()
+				.append("Upload ").append(getInputFile())
+				.append(" to ").append(_ftpClient.getRemoteDir())
+				.toString();
+			String sRemote = getInputFile().getName();
+			_ftpClient.uploadFile(getWorkFile(),sRemote);
+		}
+		finally
+		{
+			if (null!= _ftpClient)
+				_ftpClient.quit();
+		}
+	} //________________________________
+
+	@Override
+	public Serializable getOkNotification() 
+	{
+		return _sMsg + " - OK";
+	} //________________________________
+	
+	@Override
+	public Serializable getErrorNotification() 
+	{
+		return "Failed to "+ _sMsg;
+	} //________________________________
+	
+} //____________________________________________________________________________

Added: labs/jbossesb/branches/JBESB_4_0_Beta1_maint/product/core/listeners/src/org/jboss/soa/esb/listeners/RemoteDirectoryPoller.java
===================================================================
--- labs/jbossesb/branches/JBESB_4_0_Beta1_maint/product/core/listeners/src/org/jboss/soa/esb/listeners/RemoteDirectoryPoller.java	2006-09-18 20:12:14 UTC (rev 6285)
+++ labs/jbossesb/branches/JBESB_4_0_Beta1_maint/product/core/listeners/src/org/jboss/soa/esb/listeners/RemoteDirectoryPoller.java	2006-09-18 20:14:30 UTC (rev 6286)
@@ -0,0 +1,170 @@
+/*
+* 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.soa.esb.listeners;
+
+import java.io.*;
+import java.util.*;
+
+import org.jboss.soa.esb.actions.AbstractFileAction;
+import org.jboss.soa.esb.actions.FtpClientUtil;
+import org.jboss.soa.esb.helpers.*;
+
+public class RemoteDirectoryPoller extends AbstractPoller
+{
+  public static final String FILE_INPUT_DIR 	= "inputDir";
+  public static final String FILE_INPUT_SFX 	= "inputSuffix";
+  public static final String FILE_WORK_SFX 		= "workSuffix";
+  public static final String FILE_ERROR_DIR   	= "errorDir";
+  public static final String FILE_ERROR_SFX   	= "errorSuffix";
+  public static final String FILE_POST_DIR  	= "postDir";
+  public static final String FILE_POST_SFX  	= "postSuffix";
+  public static final String FILE_POST_DEL  	= "postDelete";
+
+  public RemoteDirectoryPoller(GpListener p_oDad, DomElement p_oParms) throws Exception
+  {
+	super(p_oDad,p_oParms);
+	checkMyParms();
+  } //__________________________________
+
+
+    protected File 			m_oInpDir	,m_oErrorDir	,m_oPostDir;
+    protected String 		m_sInpSfx	,m_sWrkSfx		,m_sErrSfx	,m_sPostSfx;
+    protected boolean		m_bPostDel;
+
+    /**
+     * 
+     * @param p_o Object - Must be a File representing the file that has to be processed
+     * @return Object - an array of 3 Files containing:
+     * <p/>[0] renamed file (workSuffix appended to input file name)
+     * <p/>[1] target file name in case actionClass is unable to complete successfuly
+     * <p/>[2] target file name in case actionClass finishes successfuly
+     */
+	@Override
+	public Object preProcess(Object p_o) throws Exception 
+	{
+		if (!(p_o instanceof File))
+			return null;
+		File oF = (File)p_o;
+		
+		AbstractFileAction.Params oCurr = new AbstractFileAction.Params();
+		oCurr.bPostDelete	= m_bPostDel;
+		oCurr.oInpF			= oF;
+		oCurr.oWrkF			= new File (oF.getParent(),oF.getName()+m_sWrkSfx);
+		oCurr.oErrF			= new File (m_oErrorDir	,oF.getName()+m_sErrSfx);
+		oCurr.oDoneF		= new File (m_oPostDir	,oF.getName()+m_sPostSfx);
+
+		FtpClientUtil oFtp = new FtpClientUtil(m_oParms,true);
+		try
+		{
+			oFtp.remoteRename(oF,oCurr.oWrkF);
+		}
+		finally 
+		{
+			if (null!=oFtp)
+				oFtp.quit();
+		}
+
+		return oCurr;
+	} //________________________________
+
+	@Override
+	protected List<Object> pollForCandidates()
+	{
+		List<Object> oRet = new ArrayList<Object>();
+		FtpClientUtil oFtp = null;
+		try
+		{	
+			oFtp = new FtpClientUtil(m_oParms,true);
+			oFtp.setRemoteDir(FtpClientUtil.fileToFtpString(m_oInpDir));
+			String[] sa = oFtp.getFileListFromRemoteDir(m_sInpSfx);
+			if (null!=sa)
+				for (String sCurr : sa)
+					oRet.add(new File(m_oInpDir,sCurr));
+		}
+		catch (Exception e)
+		{
+			m_oLogger.error("Problems with FTP",e);
+		}
+		finally
+		{
+			if (null!=oFtp)
+				oFtp.quit();
+		}
+		return oRet;
+		
+	} //________________________________
+
+	protected void checkMyParms() throws Exception
+    { 
+	//  INPUT directory and suffix  (used for FileFilter)
+	  String sInpDir = GpListener.obtainAtt(m_oParms,FILE_INPUT_DIR,null);
+      m_oInpDir = new File(sInpDir);
+
+      m_sInpSfx  = GpListener.obtainAtt(m_oParms,FILE_INPUT_SFX,null);
+      m_sInpSfx  = m_sInpSfx.trim();
+      if (m_sInpSfx.length()<1)
+    	  throw new Exception ("Invalid "+FILE_INPUT_SFX+" attribute");
+
+	//  WORK suffix (will rename in input directory)
+      m_sWrkSfx	= GpListener.obtainAtt(m_oParms,FILE_WORK_SFX,".esbWork").trim();
+      if (m_sWrkSfx.length()<1)
+    	  throw new Exception ("Invalid "+FILE_WORK_SFX+" attribute");
+      if (m_sInpSfx.equals(m_sWrkSfx))
+    	  throw new Exception("Work suffix must differ from input suffix <"+m_sWrkSfx+">");
+
+    //    ERROR directory and suffix (defaults to input dir and ".esbError" suffix)
+      String sErrDir = GpListener.obtainAtt(m_oParms,FILE_ERROR_DIR,sInpDir);
+      m_oErrorDir = new File(sErrDir);
+
+      m_sErrSfx  = GpListener.obtainAtt(m_oParms,FILE_ERROR_SFX,".esbError").trim();
+      if (m_sErrSfx.length()<1)
+    	  throw new Exception ("Invalid "+FILE_ERROR_SFX+" attribute");
+      if (m_oErrorDir.equals(m_oInpDir) && m_sInpSfx.equals(m_sErrSfx))
+    	  throw new Exception("Error suffix must differ from input suffix <"+m_sErrSfx+">");
+
+
+   //    Do users wish to delete files that were processed OK ?
+      String sPostDel = GpListener.obtainAtt(m_oParms,FILE_POST_DEL,"false").trim();
+      m_bPostDel = Boolean.parseBoolean(sPostDel);
+      if (m_bPostDel)
+    	  return;
+
+    //    POST (done) directory and suffix (defaults to input dir and ".esbDone" suffix)
+      String sPostDir = GpListener.obtainAtt(m_oParms,FILE_POST_DIR,sInpDir);
+      m_oPostDir = new File(sPostDir);
+      m_sPostSfx  = GpListener.obtainAtt(m_oParms,FILE_POST_SFX,".esbDone").trim();
+      if (m_oPostDir.equals(m_oInpDir))
+      {	if (m_sPostSfx.length()<1)
+    	  throw new Exception ("Invalid "+FILE_POST_SFX+" attribute");
+      	if (m_sPostSfx.equals(m_sInpSfx))
+    	  throw new Exception("Post process suffix must differ from input suffix <"+m_sPostSfx+">");
+      }
+      
+      
+      FtpClientUtil oFtp = new FtpClientUtil(m_oParms,false);
+      oFtp.quit();
+
+    } //________________________________
+	
+} //____________________________________________________________________________




More information about the jboss-svn-commits mailing list