[jboss-svn-commits] JBL Code SVN: r12571 - in labs/jbossesb/workspace/dbevenius/product/core/listeners/src/org/jboss/soa/esb/listeners/gateway: remotestrategies and 1 other directories.

jboss-svn-commits at lists.jboss.org jboss-svn-commits at lists.jboss.org
Thu Jun 14 03:26:37 EDT 2007


Author: beve
Date: 2007-06-14 03:26:37 -0400 (Thu, 14 Jun 2007)
New Revision: 12571

Modified:
   labs/jbossesb/workspace/dbevenius/product/core/listeners/src/org/jboss/soa/esb/listeners/gateway/ReadOnlyRemoteGatewayListener.java
   labs/jbossesb/workspace/dbevenius/product/core/listeners/src/org/jboss/soa/esb/listeners/gateway/remotestrategies/ReadOnlyRemoteFileSystemStrategy.java
   labs/jbossesb/workspace/dbevenius/product/core/listeners/src/org/jboss/soa/esb/listeners/gateway/remotestrategies/cache/DeleteOnEvictTreeCacheListener.java
   labs/jbossesb/workspace/dbevenius/product/core/listeners/src/org/jboss/soa/esb/listeners/gateway/remotestrategies/cache/FtpFileCache.java
Log:
Updated documentation


Modified: labs/jbossesb/workspace/dbevenius/product/core/listeners/src/org/jboss/soa/esb/listeners/gateway/ReadOnlyRemoteGatewayListener.java
===================================================================
--- labs/jbossesb/workspace/dbevenius/product/core/listeners/src/org/jboss/soa/esb/listeners/gateway/ReadOnlyRemoteGatewayListener.java	2007-06-14 06:43:11 UTC (rev 12570)
+++ labs/jbossesb/workspace/dbevenius/product/core/listeners/src/org/jboss/soa/esb/listeners/gateway/ReadOnlyRemoteGatewayListener.java	2007-06-14 07:26:37 UTC (rev 12571)
@@ -35,8 +35,12 @@
 import org.jboss.soa.esb.util.ClassUtil;
 
 /**
+ * This class extends {@link RemoteGatewayListener} and is intended to be used
+ * when the remote file system does not support write operations.
+ * <p>
+ * 
+ * <pre>
  * Sample Listener Configuration:
- * <pre>
  * &lt;ftp-listener name="FtpGateway"
  *  busidref="helloFTPChannel"
  *   maxThreads="1"
@@ -181,7 +185,6 @@
 	 */
     protected void doDestroy() throws ManagedLifecycleException
     {
-		_logger.info( "destroy method of ReadOnlyRemoteGate... called" );
 		remotefileSystemStrategy.destroy();
 		super.doDestroy();
     }
@@ -205,7 +208,6 @@
 			{
 				ReadOnlyRemoteFileSystemStrategy rm = (ReadOnlyRemoteFileSystemStrategy) remotefileSystemStrategy;
 				String cacheListener = _config.getAttribute( REMOTE_FILE_SYSTEM_STRATEGY_CACHE_LISTENER );
-				_logger.debug( "cacheListener : " + cacheListener );
 				
 				if ( cacheListener != null )
 				{
@@ -221,7 +223,7 @@
 		} 
 		catch (ClassNotFoundException e)
 		{
-			_logger.error( "Could not configure the remoteFileSystemStrategy.", e );
+			_logger.error( "ClassNotFound while trying to create the the remoteFileSystemStrategy.", e );
 			throw new ConfigurationException(e);
 		}
 	}

Modified: labs/jbossesb/workspace/dbevenius/product/core/listeners/src/org/jboss/soa/esb/listeners/gateway/remotestrategies/ReadOnlyRemoteFileSystemStrategy.java
===================================================================
--- labs/jbossesb/workspace/dbevenius/product/core/listeners/src/org/jboss/soa/esb/listeners/gateway/remotestrategies/ReadOnlyRemoteFileSystemStrategy.java	2007-06-14 06:43:11 UTC (rev 12570)
+++ labs/jbossesb/workspace/dbevenius/product/core/listeners/src/org/jboss/soa/esb/listeners/gateway/remotestrategies/ReadOnlyRemoteFileSystemStrategy.java	2007-06-14 07:26:37 UTC (rev 12571)
@@ -70,7 +70,7 @@
 	 * @param file		the file to delete. Ignored
 	 * @return true	always returns true without deleting the filee
 	 */
-	public boolean deleteFile( File file ) throws RemoteFileSystemStrategyException
+	public boolean deleteFile( final File file ) throws RemoteFileSystemStrategyException
 	{
 		return true;
 	}
@@ -82,7 +82,7 @@
 	 * @param to		the new file. Ignored
 	 * @return true	always returns true without deleting the filee
 	 */
-	public boolean renameFile( File from, File to ) throws RemoteFileSystemStrategyException
+	public boolean renameFile( final File from, final File to ) throws RemoteFileSystemStrategyException
 	{
 		return true;
 	}
@@ -95,7 +95,7 @@
 	 * @param suffix	the suffix. This will be ignored
 	 * @return File	the file untouched
 	 */
-	public File getWorkFileName( File file, String suffix )
+	public File getWorkFileName( final File file, final String suffix )
 	{
 		return file;
 	}
@@ -142,7 +142,6 @@
 	
 	public void destroy()
 	{
-		log.info( "destroy method of ReadOnlyRemoteFile... called" );
 		ftpFileCache.destroy();
 	}
 

Modified: labs/jbossesb/workspace/dbevenius/product/core/listeners/src/org/jboss/soa/esb/listeners/gateway/remotestrategies/cache/DeleteOnEvictTreeCacheListener.java
===================================================================
--- labs/jbossesb/workspace/dbevenius/product/core/listeners/src/org/jboss/soa/esb/listeners/gateway/remotestrategies/cache/DeleteOnEvictTreeCacheListener.java	2007-06-14 06:43:11 UTC (rev 12570)
+++ labs/jbossesb/workspace/dbevenius/product/core/listeners/src/org/jboss/soa/esb/listeners/gateway/remotestrategies/cache/DeleteOnEvictTreeCacheListener.java	2007-06-14 07:26:37 UTC (rev 12571)
@@ -46,7 +46,7 @@
 	
 	private TreeCache treeCache;
 	
-	public DeleteOnEvictTreeCacheListener( TreeCache treeCache ) 
+	public DeleteOnEvictTreeCacheListener( final TreeCache treeCache ) 
 	{
 		if ( treeCache == null )
 			throw new IllegalArgumentException( "treeCache must not be null" );

Modified: labs/jbossesb/workspace/dbevenius/product/core/listeners/src/org/jboss/soa/esb/listeners/gateway/remotestrategies/cache/FtpFileCache.java
===================================================================
--- labs/jbossesb/workspace/dbevenius/product/core/listeners/src/org/jboss/soa/esb/listeners/gateway/remotestrategies/cache/FtpFileCache.java	2007-06-14 06:43:11 UTC (rev 12570)
+++ labs/jbossesb/workspace/dbevenius/product/core/listeners/src/org/jboss/soa/esb/listeners/gateway/remotestrategies/cache/FtpFileCache.java	2007-06-14 07:26:37 UTC (rev 12571)
@@ -94,7 +94,7 @@
 	 * @param path			the path to the JBossCache configuration file
 	 * @return InputStream	the inputstream for the passed-in path	
 	 */
-	protected InputStream getConfigInputStream( String path ) 
+	protected InputStream getConfigInputStream( final String path ) 
 	{
 		InputStream in = null;
 		File configFile = new File( path );
@@ -151,7 +151,7 @@
 	 * @param fileName
 	 * @throws CacheException 
 	 */
-	public void putFileName(String fileName) throws CacheException
+	public void putFileName( final String fileName) throws CacheException
 	{
 		treeCache.put ( fqn, fileName, fileName );
 	}
@@ -162,7 +162,7 @@
 	 * @param fileName
 	 * @throws CacheException
 	 */
-	public Object getFileName(String fileName) throws CacheException
+	public Object getFileName( final String fileName) throws CacheException
 	{
 		return treeCache.get ( fqn, fileName );
 	}
@@ -174,7 +174,7 @@
 	 * @return Object			the value of the removed object
 	 * @throws CacheException
 	 */
-	public Object deleteFile( String fileName ) throws CacheException
+	public Object deleteFile( final String fileName ) throws CacheException
 	{
 		return treeCache.remove( fqn, fileName );
 	}
@@ -185,7 +185,7 @@
 	 * @param fileName	the filename to look for
 	 * @return true	if the file exists in the cache
 	 */
-	public boolean containsFile( String fileName )
+	public boolean containsFile( final String fileName )
 	{
 		return treeCache.exists(  fqn, fileName );
 	}
@@ -230,7 +230,7 @@
 		treeCache.addTreeCacheListener( new DeleteOnEvictTreeCacheListener( treeCache) );
 	}
 	
-	public void addCacheListener( TreeCacheListener listener )
+	public void addCacheListener( final TreeCacheListener listener )
 	{
 		if ( listener != null )
 			treeCache.addTreeCacheListener( listener );
@@ -241,7 +241,7 @@
 		return treeCache.getTreeCacheListeners();
 	}
 	
-	public void setCacheListener( Class cacheListenerClass ) throws FtpFileCacheException
+	public void setCacheListener( final Class cacheListenerClass ) throws FtpFileCacheException
 	{
 		if ( cacheListenerClass == null )
 			return;
@@ -257,33 +257,33 @@
 		} 
 		catch (SecurityException e)
 		{
-			throw createFtpFileCacheException( e );
+			throw createFtpFileCacheException( "SecurityException while trying set the CacheListener:",  e );
 		} 
 		catch (NoSuchMethodException e)
 		{
-			throw createFtpFileCacheException( e );
+			throw createFtpFileCacheException( "NoSuchMethodException while trying set the CacheListener:",  e );
 		} 
 		catch (IllegalArgumentException e)
 		{
-			throw createFtpFileCacheException( e );
+			throw createFtpFileCacheException( "IllegalArgumentException while trying set the CacheListener:",  e );
 		} 
 		catch (InstantiationException e)
 		{
-			throw createFtpFileCacheException( e );
+			throw createFtpFileCacheException( "InstantiationException while trying set the CacheListener:",  e );
 		} 
 		catch (IllegalAccessException e)
 		{
-			throw createFtpFileCacheException( e );
+			throw createFtpFileCacheException( "IllegalAccessException while trying set the CacheListener:",  e );
 		} 
 		catch (InvocationTargetException e)
 		{
-			throw createFtpFileCacheException( e );
+			throw createFtpFileCacheException( "InvocationTargetException while trying set the CacheListener:",  e );
 		}
 	}
 	
-	private FtpFileCacheException createFtpFileCacheException( Exception e )
+	private FtpFileCacheException createFtpFileCacheException( final String msg,  Exception e )
 	{
-		log.error( e );
+		log.error( msg, e );
 		return new FtpFileCacheException( e );
 	}
 	




More information about the jboss-svn-commits mailing list