You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2012/05/06 22:03:36 UTC
svn commit: r1334747 - in
/maven/wagon/trunk/wagon-providers/wagon-ssh-common/src/main/java/org/apache/maven/wagon/providers/ssh:
LSParser.java ScpHelper.java
Author: hboutemy
Date: Sun May 6 20:03:36 2012
New Revision: 1334747
URL: http://svn.apache.org/viewvc?rev=1334747&view=rev
Log:
improved javadoc
Modified:
maven/wagon/trunk/wagon-providers/wagon-ssh-common/src/main/java/org/apache/maven/wagon/providers/ssh/LSParser.java
maven/wagon/trunk/wagon-providers/wagon-ssh-common/src/main/java/org/apache/maven/wagon/providers/ssh/ScpHelper.java
Modified: maven/wagon/trunk/wagon-providers/wagon-ssh-common/src/main/java/org/apache/maven/wagon/providers/ssh/LSParser.java
URL: http://svn.apache.org/viewvc/maven/wagon/trunk/wagon-providers/wagon-ssh-common/src/main/java/org/apache/maven/wagon/providers/ssh/LSParser.java?rev=1334747&r1=1334746&r2=1334747&view=diff
==============================================================================
--- maven/wagon/trunk/wagon-providers/wagon-ssh-common/src/main/java/org/apache/maven/wagon/providers/ssh/LSParser.java (original)
+++ maven/wagon/trunk/wagon-providers/wagon-ssh-common/src/main/java/org/apache/maven/wagon/providers/ssh/LSParser.java Sun May 6 20:03:36 2012
@@ -30,7 +30,7 @@ import java.util.regex.Matcher;
import java.util.regex.Pattern;
/**
- * LSParser
+ * Parser for the output of <code>ls</code> command from any ssh server on any OS.
*
* @author <a href="mailto:joakim@erdfelt.com">Joakim Erdfelt</a>
* @version $Id$
Modified: maven/wagon/trunk/wagon-providers/wagon-ssh-common/src/main/java/org/apache/maven/wagon/providers/ssh/ScpHelper.java
URL: http://svn.apache.org/viewvc/maven/wagon/trunk/wagon-providers/wagon-ssh-common/src/main/java/org/apache/maven/wagon/providers/ssh/ScpHelper.java?rev=1334747&r1=1334746&r2=1334747&view=diff
==============================================================================
--- maven/wagon/trunk/wagon-providers/wagon-ssh-common/src/main/java/org/apache/maven/wagon/providers/ssh/ScpHelper.java (original)
+++ maven/wagon/trunk/wagon-providers/wagon-ssh-common/src/main/java/org/apache/maven/wagon/providers/ssh/ScpHelper.java Sun May 6 20:03:36 2012
@@ -45,6 +45,10 @@ import java.util.List;
import java.util.zip.ZipEntry;
import java.util.zip.ZipOutputStream;
+/**
+ * Scp helper for general algorithms on ssh server.
+ * See {@link #putDirectory(Wagon, File, String) putDirectory(...)} for more info on bulk directory upload.
+ */
public class ScpHelper
{
public static final char PATH_SEPARATOR = '/';
@@ -198,6 +202,10 @@ public class ScpHelper
return path;
}
+ /**
+ * Put a whole directory content, by transferring a unique zip file and uncompressing it
+ * on the target ssh server with <code>unzip</code> command.
+ */
public void putDirectory( Wagon wagon, File sourceDirectory, String destinationDirectory )
throws TransferFailedException, ResourceDoesNotExistException, AuthorizationException
{