Package com.sshtools.client.tasks

Class AbstractOptimisedTask<TARGET,LOCALFILE>

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<TARGET,LOCALFILE>

All Implemented Interfaces:

RequestFuture, Runnable

Direct Known Subclasses:

PullTask, PushTask

public abstract class AbstractOptimisedTask<TARGET,LOCALFILE>
extends AbstractFileTask

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractOptimisedTask.AbstractOptimisedTaskBuilder<B extends AbstractOptimisedTask.AbstractOptimisedTaskBuilder<B,T,LOCALFILE>,T extends AbstractOptimisedTask<?,?>,LOCALFILE>
protected static class	AbstractOptimisedTask.FileTransferProgressWrapper
static interface	AbstractOptimisedTask.ProgressMessages	Interface to be implemented by classes that monitor the progress of file transfers and output feedback.

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

Modifier and Type	Field	Description
protected final int	blocksize
protected final int	buffersize
protected final Function<LOCALFILE,FileTransferProgress>	chunkProgress
protected final int	chunks
protected final LinkedList<SshClient>	clients
protected final RemoteHash	digest
protected final boolean	ignoreIntegrity
protected final int	outstandingRequests
protected final SftpClient	primarySftpClient
protected final Optional<AbstractOptimisedTask.ProgressMessages>	progressMessages
protected final boolean	verboseOutput
protected final boolean	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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractOptimisedTask(AbstractOptimisedTask.AbstractOptimisedTaskBuilder<?,?,LOCALFILE> builder)

Method Summary

Modifier and Type	Method	Description
protected final void	checkErrors(Collection<Throwable> errors)
protected final void	configureConnections()
protected abstract TARGET	configureTargetFolder()
protected final void	displayMessage(String message, Object... args)
final void	doTask()
protected final void	printChunkMessages(long chunkLength)
protected abstract void	transferFiles(TARGET targetFolder)
protected final void	verboseMessage(String message, Object... args)
protected final void	verifyIntegrity(Path localPath, String remotePath)

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

Field Details

chunks

protected final int chunks

blocksize

protected final int blocksize

buffersize

protected final int buffersize

outstandingRequests

protected final int outstandingRequests

verifyIntegrity

protected final boolean verifyIntegrity

digest

protected final RemoteHash digest

ignoreIntegrity

protected final boolean ignoreIntegrity

primarySftpClient

protected final SftpClient primarySftpClient

progressMessages

protected final Optional<AbstractOptimisedTask.ProgressMessages> progressMessages

chunkProgress

protected final Function<LOCALFILE,FileTransferProgress> chunkProgress

clients

protected final LinkedList<SshClient> clients

verboseOutput

protected final boolean verboseOutput

Constructor Details

AbstractOptimisedTask

protected AbstractOptimisedTask(AbstractOptimisedTask.AbstractOptimisedTaskBuilder<?,?,LOCALFILE> builder)

Method Details

doTask

public final void doTask()

Specified by:

doTask in class ConnectionAwareTask

transferFiles

protected abstract void transferFiles(TARGET targetFolder)
                               throws SftpStatusException,
SshException,
TransferCancelledException,
IOException,
PermissionDeniedException,
ChannelOpenException

Throws:

SftpStatusException

SshException

TransferCancelledException

IOException

PermissionDeniedException

ChannelOpenException

displayMessage

protected final void displayMessage(String message,
 Object... args)

verboseMessage

protected final void verboseMessage(String message,
 Object... args)

configureConnections

protected final void configureConnections()
                                   throws IOException,
SshException

Throws:

IOException

SshException

configureTargetFolder

protected abstract TARGET configureTargetFolder()
                                         throws IOException,
SshException,
PermissionDeniedException,
SftpStatusException

Throws:

IOException

SshException

PermissionDeniedException

SftpStatusException

checkErrors

protected final void checkErrors(Collection<Throwable> errors)
                          throws IOException,
TransferCancelledException

Throws:

IOException

TransferCancelledException

printChunkMessages

protected final void printChunkMessages(long chunkLength)

verifyIntegrity

protected final void verifyIntegrity(Path localPath,
 String remotePath)
                              throws SshException,
SftpStatusException,
IOException,
PermissionDeniedException

Throws:

SshException

SftpStatusException

IOException

PermissionDeniedException