ScpHelper (Apache Maven Wagon 3.2.0 API)

java.lang.Object
- org.apache.maven.wagon.providers.ssh.ScpHelper

```
public class ScpHelper
extends 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 and Description

static int DEFAULT_SSH_PORT

static char PATH_SEPARATOR

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_SSH_PORT`
`static char`	`PATH_SEPARATOR`

Constructor Summary

Constructors
Constructor and Description

ScpHelper(CommandExecutor executor)

Constructors
Constructor and Description
`ScpHelper(CommandExecutor executor)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`createRemoteDirectories(String path, RepositoryPermissions permissions)`
`static void`	`createZip(List<String> files, File zipName, File basedir)`
`List<String>`	`getFileList(String destinationDirectory, Repository repository)`
`protected static String`	`getPath(String basedir, String dir)`
`static File`	`getPrivateKey(AuthenticationInfo authenticationInfo)`
`static Resource`	`getResource(String resourceName)`
`static String`	`getResourceDirectory(String resourceName)`
`static String`	`getResourceFilename(String r)`
`void`	`putDirectory(Wagon wagon, File sourceDirectory, 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(String resourceName, Repository repository)`

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

Constructor Detail

ScpHelper

public ScpHelper(CommandExecutor executor)

Method Detail

getResourceDirectory

public static String getResourceDirectory(String resourceName)

getResourceFilename

public static String getResourceFilename(String r)

getResource

public static Resource getResource(String resourceName)

getPrivateKey

public static File getPrivateKey(AuthenticationInfo authenticationInfo)
                          throws FileNotFoundException

Throws:: FileNotFoundException

createZip

public static void createZip(List<String> files,
             File zipName,
             File basedir)
                      throws IOException

Throws:: IOException

getPath

protected static String getPath(String basedir,
             String dir)

putDirectory

public void putDirectory(Wagon wagon,
                File sourceDirectory,
                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 List<String> getFileList(String destinationDirectory,
                       Repository repository)
                         throws TransferFailedException,
                                ResourceDoesNotExistException,
                                AuthorizationException

Throws:: TransferFailedException; ResourceDoesNotExistException; AuthorizationException

resourceExists

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

Throws:: TransferFailedException; AuthorizationException

createRemoteDirectories

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

Throws:: CommandExecutionException

Class ScpHelper

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PATH_SEPARATOR

DEFAULT_SSH_PORT

Constructor Detail

ScpHelper

Method Detail

getResourceDirectory

getResourceFilename

getResource

getPrivateKey

createZip

getPath

putDirectory

getFileList

resourceExists

createRemoteDirectories