Class SCPDownloadClient

java.lang.Object

net.schmizz.sshj.xfer.scp.AbstractSCPClient

net.schmizz.sshj.xfer.scp.SCPDownloadClient

public class SCPDownloadClient
extends AbstractSCPClient

Support for downloading files over a connected link using SCP.

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	recursiveMode

Fields inherited from class AbstractSCPClient

bandwidthLimit, engine

Constructor Summary

Constructors

Constructor	Description
SCPDownloadClient(SCPEngine engine)
SCPDownloadClient(SCPEngine engine, int bandwidthLimit)

Method Summary

Modifier and Type	Method	Description
int	copy(String sourcePath, LocalDestFile targetFile)	Download a file from sourcePath on the connected host to targetPath locally.
int	copy(String sourcePath, LocalDestFile targetFile, ScpCommandLine.EscapeMode escapeMode)
int	copy(String sourcePath, LocalDestFile targetFile, ScpCommandLine.EscapeMode escapeMode, ScpCommandLine commandLine)
boolean	getRecursiveMode()
private long	parseLong(String longString, String valType)
private int	parsePermissions(String cmd)
private boolean	process(TransferListener listener, String bufferedTMsg, String msg, LocalDestFile f)
private void	processDirectory(TransferListener listener, String dMsg, String tMsg, LocalDestFile f)
private void	processFile(TransferListener listener, String cMsg, String tMsg, LocalDestFile f)
private void	setAttributes(LocalDestFile f, int perms, String tMsg)
void	setRecursiveMode(boolean recursive)
private void	startCopy(LocalDestFile targetFile, ScpCommandLine commandLine)
private static List<String>	tokenize(String msg, int totalParts, boolean consolidateTail)

Methods inherited from class Object

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

Field Details

recursiveMode

private boolean recursiveMode

Constructor Details

SCPDownloadClient

SCPDownloadClient(SCPEngine engine)

SCPDownloadClient

SCPDownloadClient(SCPEngine engine,
 int bandwidthLimit)

Method Details

copy

public int copy(String sourcePath,
 LocalDestFile targetFile)
         throws IOException

Download a file from sourcePath on the connected host to targetPath locally.

Throws:

IOException

copy

public int copy(String sourcePath,
 LocalDestFile targetFile,
 ScpCommandLine.EscapeMode escapeMode)
         throws IOException

Throws:

IOException

copy

public int copy(String sourcePath,
 LocalDestFile targetFile,
 ScpCommandLine.EscapeMode escapeMode,
 ScpCommandLine commandLine)
         throws IOException

Throws:

IOException

getRecursiveMode

public boolean getRecursiveMode()

setRecursiveMode

public void setRecursiveMode(boolean recursive)

startCopy

private void startCopy(LocalDestFile targetFile,
 ScpCommandLine commandLine)
                throws IOException

Throws:

IOException

parseLong

private long parseLong(String longString,
 String valType)
                throws SCPException

Throws:

SCPException

parsePermissions

private int parsePermissions(String cmd)
                      throws SCPException

Throws:

SCPException

process

private boolean process(TransferListener listener,
 String bufferedTMsg,
 String msg,
 LocalDestFile f)
                 throws IOException

Throws:

IOException

processDirectory

private void processDirectory(TransferListener listener,
 String dMsg,
 String tMsg,
 LocalDestFile f)
                       throws IOException

Throws:

IOException

processFile

private void processFile(TransferListener listener,
 String cMsg,
 String tMsg,
 LocalDestFile f)
                  throws IOException

Throws:

IOException

setAttributes

private void setAttributes(LocalDestFile f,
 int perms,
 String tMsg)
                    throws IOException

Throws:

IOException

tokenize

private static List<String> tokenize(String msg,
 int totalParts,
 boolean consolidateTail)
                              throws IOException

Throws:

IOException