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

Method Summary

Modifier and Type	Method	Description
protected final void	beforeStartShell(SessionChannelNG session)
protected final SessionChannelNG	createSession(SshConnection con)
protected final void	onCloseSession(SessionChannelNG session)
protected final void	onOpenSession(SessionChannelNG session)

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

Method Details

onOpenSession

protected final void onOpenSession(SessionChannelNG session)
                            throws IOException,
SshException,
ShellTimeoutException

Specified by:

onOpenSession in class AbstractSessionTask<SessionChannelNG>

Throws:

IOException

SshException

ShellTimeoutException

beforeStartShell

protected final void beforeStartShell(SessionChannelNG session)

Overrides:

beforeStartShell in class AbstractShellTask<SessionChannelNG>

onCloseSession

protected final void onCloseSession(SessionChannelNG session)

Specified by:

onCloseSession in class AbstractSessionTask<SessionChannelNG>

createSession

protected final SessionChannelNG createSession(SshConnection con)

Specified by:

createSession in class AbstractSessionTask<SessionChannelNG>