Package com.sshtools.client.tasks

Class ShellTask

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<T>

com.sshtools.client.tasks.AbstractShellTask<SessionChannelNG>

com.sshtools.client.tasks.ShellTask

All Implemented Interfaces:

RequestFuture, Closeable, AutoCloseable, Runnable

public class ShellTask
extends AbstractShellTask<SessionChannelNG>

A Task that starts a remote shell with an allocated PTY. You cannot directly create a ShellTask, instead use ShellTask.ShellTaskBuilder.

 client.addTask(ShellTaskBuilder.create().
      withTermType("vt320").
      withColumns(132).
      withRows(48).
      onClose((task, session) -> System.out.println("Closed!")).
      build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ShellTask.ShellTaskBuilder	Builder for ShellTask.
static interface	ShellTask.ShellTaskEvent	Functional interface for tasks run on certain shell 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.AbstractConnectionTask

clientSupplier

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

con, lastError

Constructor Summary

Constructors

Constructor	Description
ShellTask(SshClient ssh)	Deprecated.
ShellTask(SshConnection con)	Deprecated.

Method Summary

Modifier and Type	Method	Description
protected void	beforeStartShell(SessionChannelNG session)	Deprecated.
protected void	closeOnTaskComplete()	Deprecated, for removal: This API element is subject to removal in a future version.
protected SessionChannelNG	createSession(SshConnection con)	Deprecated.
protected void	onCloseSession(SessionChannelNG session)	Deprecated.
protected void	onOpenSession(SessionChannelNG session)	Deprecated.

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

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

Constructor Details

ShellTask

@Deprecated
public ShellTask(SshConnection con)

Deprecated.

Construct a shell task. Deprecated since 3.1.0. Use a ShellTask.ShellTaskBuilder instead.

Parameters:

con - connection

See Also:

• ShellTask.ShellTaskBuilder

ShellTask

@Deprecated
public ShellTask(SshClient ssh)

Deprecated.

Construct a shell task. Deprecated since 3.1.0. Use a ShellTask.ShellTaskBuilder instead.

Parameters:

ssh - client

See Also:

• ShellTask.ShellTaskBuilder

Method Details

onOpenSession

@Deprecated(since="3.1.0")
protected void onOpenSession(SessionChannelNG session)
                      throws IOException,
SshException,
ShellTimeoutException

Deprecated.

Deprecated for overriding, will be made final at 3.2.0.

Specified by:

onOpenSession in class AbstractSessionTask<SessionChannelNG>

Throws:

IOException

SshException

ShellTimeoutException

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>

beforeStartShell

@Deprecated(since="3.1.0")
protected void beforeStartShell(SessionChannelNG session)

Deprecated.

Deprecated for overriding, will be made final at 3.2.0.

Overrides:

beforeStartShell in class AbstractShellTask<SessionChannelNG>

onCloseSession

@Deprecated(since="3.1.0")
protected void onCloseSession(SessionChannelNG session)

Deprecated.

Deprecated for overriding, will be made final at 3.2.0.

Specified by:

onCloseSession in class AbstractSessionTask<SessionChannelNG>

createSession

@Deprecated(since="3.1.0")
protected SessionChannelNG createSession(SshConnection con)

Deprecated.

Deprecated for overriding, will be made final at 3.2.0.

Specified by:

createSession in class AbstractSessionTask<SessionChannelNG>