Package com.sshtools.client.tasks

Class PullTask

java.lang.Object

com.sshtools.common.ssh.AbstractRequestFuture

com.sshtools.common.ssh.ConnectionAwareTask

com.sshtools.client.tasks.Task

com.sshtools.client.tasks.AbstractConnectionTask

com.sshtools.client.tasks.AbstractFileTask

com.sshtools.client.tasks.AbstractOptimisedTask<Path,String>

com.sshtools.client.tasks.PullTask

All Implemented Interfaces:

RequestFuture, Runnable

public final class PullTask
extends AbstractOptimisedTask<Path,String>

An SFTP Task that downloads complete paths in multiple chunks concurrently. You cannot directly create a PullTask, instead use PullTask.PullTaskBuilder.

 client.addTask(PullTaskBuilder.create().
                withPaths("a/b/c.txt", "/d/e/f/g.txt").
                withLocalFolder("/path/on/local").
                withChunks(5).
                build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PullTask.PullTaskBuilder	Builder for PullTask.

Nested classes/interfaces inherited from class com.sshtools.client.tasks.AbstractOptimisedTask

AbstractOptimisedTask.AbstractOptimisedTaskBuilder<B extends AbstractOptimisedTask.AbstractOptimisedTaskBuilder<B,T,LOCALFILE>,T extends AbstractOptimisedTask<?,?>,LOCALFILE>, AbstractOptimisedTask.FileTransferProgressWrapper, AbstractOptimisedTask.ProgressMessages

Nested classes/interfaces inherited from class com.sshtools.client.tasks.AbstractFileTask

AbstractFileTask.AbstractFileTaskBuilder<B extends AbstractFileTask.AbstractFileTaskBuilder<B,T>,T extends AbstractConnectionTask>

Nested classes/interfaces inherited from class com.sshtools.client.tasks.AbstractConnectionTask

AbstractConnectionTask.AbstractConnectionTaskBuilder<B extends AbstractConnectionTask.AbstractConnectionTaskBuilder<B,T>,T extends AbstractConnectionTask>

Nested classes/interfaces inherited from class com.sshtools.client.tasks.Task

Task.TaskRunnable<T>

Field Summary

Fields inherited from class com.sshtools.client.tasks.AbstractOptimisedTask

blocksize, buffersize, chunkProgress, chunks, clients, digest, ignoreIntegrity, outstandingRequests, primarySftpClient, progressMessages, verboseOutput, verifyIntegrity

Fields inherited from class com.sshtools.client.tasks.AbstractFileTask

progress

Fields inherited from class com.sshtools.client.tasks.AbstractConnectionTask

clientSupplier

Fields inherited from class com.sshtools.common.ssh.ConnectionAwareTask

con, lastError

Method Summary

Modifier and Type	Method	Description
protected Path	configureTargetFolder()
protected void	transferFiles(Path target)

Methods inherited from class com.sshtools.client.tasks.AbstractOptimisedTask

checkErrors, configureConnections, displayMessage, doTask, printChunkMessages, verboseMessage, verifyIntegrity

Methods inherited from class com.sshtools.client.tasks.AbstractFileTask

doTaskUntilDone

Methods inherited from class com.sshtools.client.tasks.Task

ofRunnable

Methods inherited from class com.sshtools.common.ssh.ConnectionAwareTask

getLastError, run

Methods inherited from class com.sshtools.common.ssh.AbstractRequestFuture

addFutureListener, done, isDone, isSuccess, waitFor, waitForever

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sshtools.common.ssh.RequestFuture

isDoneAndSuccess

Methods inherited from interface java.lang.Runnable

run

Method Details

transferFiles

protected void transferFiles(Path target)
                      throws SftpStatusException,
SshException,
TransferCancelledException,
IOException,
PermissionDeniedException,
ChannelOpenException

Specified by:

transferFiles in class AbstractOptimisedTask<Path,String>

Throws:

SftpStatusException

SshException

TransferCancelledException

IOException

PermissionDeniedException

ChannelOpenException

configureTargetFolder

protected Path configureTargetFolder()
                              throws IOException,
SshException,
PermissionDeniedException,
SftpStatusException

Specified by:

configureTargetFolder in class AbstractOptimisedTask<Path,String>

Throws:

IOException

SshException

PermissionDeniedException

SftpStatusException