Package com.sshtools.client.tasks

Class DownloadFileTask

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.DownloadFileTask

All Implemented Interfaces:

RequestFuture, Runnable

public class DownloadFileTask
extends AbstractFileTask

An SFTP Task that downloads complete files. You cannot directly create a DownloadFileTask, instead use DownloadFileTask.DownloadFileTaskBuilder.

 client.addTask(DownloadFileTaskBuilder.create().
                withLocalFile(new File("local.txt")).
      withRemotePath("/path/to/remote.txt").
      build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DownloadFileTask.DownloadFileTaskBuilder	Builder for DownloadFileTask.

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.AbstractFileTask

progress

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

clientSupplier

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

con, lastError

Constructor Summary

Constructors

Constructor	Description
DownloadFileTask(Connection<SshClientContext> con, String path)	Deprecated, for removal: This API element is subject to removal in a future version.
DownloadFileTask(Connection<SshClientContext> con, String path, File localFile)	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
void	doTask()
File	getDownloadedFile()

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

Constructor Details

DownloadFileTask

@Deprecated(forRemoval=true,
            since="3.1.0")
public DownloadFileTask(Connection<SshClientContext> con,
 String path,
 File localFile)

Deprecated, for removal: This API element is subject to removal in a future version.

Construct a new download local task. Deprecated since 3.1.0. Use a DownloadFileTask.DownloadFileTaskBuilder instead.

Parameters:

con - connection

path - path

localFile - local local

See Also:

• DownloadFileTask.DownloadFileTaskBuilder

DownloadFileTask

@Deprecated(forRemoval=true,
            since="3.1.0")
public DownloadFileTask(Connection<SshClientContext> con,
 String path)

Deprecated, for removal: This API element is subject to removal in a future version.

Construct a new download local task. Deprecated since 3.1.0. Use a DownloadFileTask.DownloadFileTaskBuilder instead.

Parameters:

con - connection

path - path

See Also:

• DownloadFileTask.DownloadFileTaskBuilder

Method Details

doTask

public void doTask()

Specified by:

doTask in class ConnectionAwareTask

getDownloadedFile

public File getDownloadedFile()