Package com.sshtools.client.tasks

Class AbstractSessionTask<T extends AbstractSessionChannel>

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>

All Implemented Interfaces:

RequestFuture, Closeable, AutoCloseable, Runnable

Direct Known Subclasses:

AbstractCommandTask, AbstractShellTask

public abstract class AbstractSessionTask<T extends AbstractSessionChannel>
extends AbstractConnectionTask
implements Closeable

An abstract task for using the SSH session

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AbstractSessionTask.AbstractSessionTaskBuilder<B extends AbstractSessionTask.AbstractSessionTaskBuilder<B,SC,TT>,SC extends AbstractSessionChannel,TT extends AbstractSessionTask<SC>>	Builder for AbstractSessionTask.

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
AbstractSessionTask(SshClient ssh, ChannelRequestFuture future)	Deprecated.
AbstractSessionTask(AbstractSessionTask.AbstractSessionTaskBuilder<?,T,?> builder)
AbstractSessionTask(SshConnection con)
AbstractSessionTask(SshConnection con, ChannelRequestFuture future)	Deprecated.

Method Summary

Modifier and Type	Method	Description
void	changeTerminalDimensions(int cols, int rows, int width, int height)
final void	close()
protected void	closeOnTaskComplete()	Deprecated.
protected abstract T	createSession(SshConnection con)
void	disconnect()
void	doTask()
ChannelRequestFuture	getChannelFuture()
T	getSession()
boolean	isClosed()
protected abstract void	onCloseSession(T session)
protected abstract void	onOpenSession(T session)
protected abstract void	setupSession(T session)

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

AbstractSessionTask

public AbstractSessionTask(AbstractSessionTask.AbstractSessionTaskBuilder<?,T,?> builder)

AbstractSessionTask

@Deprecated
public AbstractSessionTask(SshClient ssh,
 ChannelRequestFuture future)

Deprecated.

AbstractSessionTask

@Deprecated
public AbstractSessionTask(SshConnection con,
 ChannelRequestFuture future)

Deprecated.

AbstractSessionTask

public AbstractSessionTask(SshConnection con)

Method Details

getSession

public T getSession()

disconnect

public void disconnect()

getChannelFuture

public ChannelRequestFuture getChannelFuture()

doTask

public void doTask()

Specified by:

doTask in class ConnectionAwareTask

closeOnTaskComplete

@Deprecated(since="3.1.0")
protected void closeOnTaskComplete()

Deprecated.

createSession

protected abstract T createSession(SshConnection con)

setupSession

protected abstract void setupSession(T session)

onOpenSession

protected abstract void onOpenSession(T session)
                               throws IOException,
SshException,
ShellTimeoutException

Throws:

IOException

SshException

ShellTimeoutException

onCloseSession

protected abstract void onCloseSession(T session)

close

public final void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

isClosed

public boolean isClosed()

changeTerminalDimensions

public void changeTerminalDimensions(int cols,
 int rows,
 int width,
 int height)