Package org.apache.maven.wagon.providers.ssh

Class ScpHelper

java.lang.Object

org.apache.maven.wagon.providers.ssh.ScpHelper

public class ScpHelper
extends java.lang.Object

Scp helper for general algorithms on ssh server. See putDirectory(...) for more info on bulk directory upload.

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_SSH_PORT
private CommandExecutor	executor
static char	PATH_SEPARATOR

Constructor Summary

Constructors

Constructor	Description
ScpHelper(CommandExecutor executor)

Method Summary

Modifier and Type	Method	Description
void	createRemoteDirectories(java.lang.String path, RepositoryPermissions permissions)
static void	createZip(java.util.List<java.lang.String> files, java.io.File zipName, java.io.File basedir)
private static java.io.File	findPrivateKey()
java.util.List<java.lang.String>	getFileList(java.lang.String destinationDirectory, Repository repository)
protected static java.lang.String	getPath(java.lang.String basedir, java.lang.String dir)
static java.io.File	getPrivateKey(AuthenticationInfo authenticationInfo)
static Resource	getResource(java.lang.String resourceName)
static java.lang.String	getResourceDirectory(java.lang.String resourceName)
static java.lang.String	getResourceFilename(java.lang.String r)
void	putDirectory(Wagon wagon, java.io.File sourceDirectory, java.lang.String destinationDirectory)	Put a whole directory content, by transferring a unique zip file and uncompressing it on the target ssh server with unzip command.
boolean	resourceExists(java.lang.String resourceName, Repository repository)
private static void	writeZipEntry(java.util.zip.ZipOutputStream jar, java.io.File source, java.lang.String entryName)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PATH_SEPARATOR

public static final char PATH_SEPARATOR

See Also:

Constant Field Values

DEFAULT_SSH_PORT

public static final int DEFAULT_SSH_PORT

See Also:

Constant Field Values

executor

private final CommandExecutor executor

Constructor Detail

ScpHelper

public ScpHelper(CommandExecutor executor)

Method Detail

getResourceDirectory

public static java.lang.String getResourceDirectory(java.lang.String resourceName)

getResourceFilename

public static java.lang.String getResourceFilename(java.lang.String r)

getResource

public static Resource getResource(java.lang.String resourceName)

getPrivateKey

public static java.io.File getPrivateKey(AuthenticationInfo authenticationInfo)
                                  throws java.io.FileNotFoundException

Throws:

java.io.FileNotFoundException

findPrivateKey

private static java.io.File findPrivateKey()

createZip

public static void createZip(java.util.List<java.lang.String> files,
                             java.io.File zipName,
                             java.io.File basedir)
                      throws java.io.IOException

Throws:

java.io.IOException

writeZipEntry

private static void writeZipEntry(java.util.zip.ZipOutputStream jar,
                                  java.io.File source,
                                  java.lang.String entryName)
                           throws java.io.IOException

Throws:

java.io.IOException

getPath

protected static java.lang.String getPath(java.lang.String basedir,
                                          java.lang.String dir)

putDirectory

public void putDirectory(Wagon wagon,
                         java.io.File sourceDirectory,
                         java.lang.String destinationDirectory)
                  throws TransferFailedException,
                         ResourceDoesNotExistException,
                         AuthorizationException

Put a whole directory content, by transferring a unique zip file and uncompressing it on the target ssh server with unzip command.

Throws:

TransferFailedException

ResourceDoesNotExistException

AuthorizationException

getFileList

public java.util.List<java.lang.String> getFileList(java.lang.String destinationDirectory,
                                                    Repository repository)
                                             throws TransferFailedException,
                                                    ResourceDoesNotExistException,
                                                    AuthorizationException

Throws:

TransferFailedException

ResourceDoesNotExistException

AuthorizationException

resourceExists

public boolean resourceExists(java.lang.String resourceName,
                              Repository repository)
                       throws TransferFailedException,
                              AuthorizationException

Throws:

TransferFailedException

AuthorizationException

createRemoteDirectories

public void createRemoteDirectories(java.lang.String path,
                                    RepositoryPermissions permissions)
                             throws CommandExecutionException

Throws:

CommandExecutionException