Package com.sshtools.client.tasks

Class CommandTask

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.AbstractSessionTask<SessionChannelNG>

com.sshtools.client.tasks.AbstractCommandTask

com.sshtools.client.tasks.CommandTask

All Implemented Interfaces:

RequestFuture, Closeable, AutoCloseable, Runnable

public final class CommandTask
extends AbstractCommandTask

Task for executing commands.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CommandTask.CommandTaskBuilder	Builder for CommandTask.
static interface	CommandTask.CommandTaskEvent	Functional interface for tasks run on certain command task events.

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

AbstractSessionTask.AbstractSessionTaskBuilder<B extends AbstractSessionTask.AbstractSessionTaskBuilder<B,SC,TT>,SC extends AbstractSessionChannel,TT extends AbstractSessionTask<SC>>

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

EXIT_CODE_NOT_RECEIVED

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 final void	beforeExecuteCommand(SessionChannelNG session)
protected void	closeOnTaskComplete()	Deprecated, for removal: This API element is subject to removal in a future version.
protected final SessionChannelNG	createSession(SshConnection con)
final String	getCommand()
final int	getExitCode()
protected final void	onCloseSession(SessionChannelNG session)	Deprecated, for removal: This API element is subject to removal in a future version.
protected final void	onOpenSession(SessionChannelNG session)

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

setupSession

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

changeTerminalDimensions, close, disconnect, doTask, getChannelFuture, getSession, isClosed

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

onCloseSession

@Deprecated(since="3.1.0",
            forRemoval=true)
protected final void onCloseSession(SessionChannelNG session)

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

Overrides:

onCloseSession in class AbstractCommandTask

getExitCode

public final int getExitCode()

Overrides:

getExitCode in class AbstractCommandTask

getCommand

public final String getCommand()

Overrides:

getCommand in class AbstractCommandTask

createSession

protected final SessionChannelNG createSession(SshConnection con)

Overrides:

createSession in class AbstractCommandTask

closeOnTaskComplete

@Deprecated(since="3.1.0",
            forRemoval=true)
protected void closeOnTaskComplete()

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

Overrides:

closeOnTaskComplete in class AbstractSessionTask<SessionChannelNG>

onOpenSession

protected final void onOpenSession(SessionChannelNG session)
                            throws IOException

Specified by:

onOpenSession in class AbstractSessionTask<SessionChannelNG>

Throws:

IOException

beforeExecuteCommand

protected final void beforeExecuteCommand(SessionChannelNG session)

Overrides:

beforeExecuteCommand in class AbstractCommandTask