Package com.sshtools.client.tasks

Class UploadFileContentTask

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

All Implemented Interfaces:

RequestFuture, Runnable

public class UploadFileContentTask
extends AbstractFileTask

An SFTP Task that uploads string content to a remote file. You cannot directly create a UploadFileContentTask, instead use UploadInputStreamTask.UploadInputStreamTaskBuilder.

 client.addTask(UploadFileContentTask.create().
                withContent("Hello World!").
      withRemotePath("/remote/on/remote/remote.txt").
      build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	UploadFileContentTask.UploadFileContentTaskBuilder	Builder for UploadFileContentTask.

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
UploadFileContentTask(SshClient ssh, String content, String encoding, String path)	Deprecated, for removal: This API element is subject to removal in a future version.
UploadFileContentTask(Connection<SshClientContext> con, String content, String encoding, String path)	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
void	doTask()

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

UploadFileContentTask

@Deprecated(forRemoval=true,
            since="3.1.0")
public UploadFileContentTask(SshClient ssh,
 String content,
 String encoding,
 String path)

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

Construct a new upload content task. Deprecated since 3.1.0. Use a UploadFileContentTask.UploadFileContentTaskBuilder instead.

Parameters:

con - connection

localFile - local file

remote - remote

See Also:

• UploadFileContentTask.UploadFileContentTaskBuilder

UploadFileContentTask

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

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

Construct a new upload content task. Deprecated since 3.1.0. Use a UploadFileContentTask.UploadFileContentTaskBuilder instead.

Parameters:

con - connection

content - content

encoding - encoding

remote - remote

See Also:

• UploadFileContentTask.UploadFileContentTaskBuilder

Method Details

doTask

public void doTask()

Specified by:

doTask in class ConnectionAwareTask