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

All Implemented Interfaces:

RequestFuture, java.lang.Runnable

Direct Known Subclasses:

AbstractCommandTask, AbstractShellTask

public abstract class AbstractSessionTask<T extends AbstractSessionChannel>
extends Task

An abstract task for using the SSH session

Field Summary

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

con

Constructor Summary

Constructors

Constructor and Description
AbstractSessionTask(SshClient ssh, ChannelRequestFuture future)
AbstractSessionTask(SshConnection con)
AbstractSessionTask(SshConnection con, ChannelRequestFuture future)

Method Summary

Modifier and Type	Method and Description
void	changeTerminalDimensions(int cols, int rows, int width, int height)
void	close()
protected abstract T	createSession(SshConnection con)
void	disconnect()
void	doTask()
ChannelRequestFuture	getChannelFuture()
java.lang.Throwable	getLastError()
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.common.ssh.ConnectionAwareTask

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 java.lang.Runnable

run

Constructor Detail

AbstractSessionTask

public AbstractSessionTask(SshClient ssh,
                           ChannelRequestFuture future)

AbstractSessionTask

public AbstractSessionTask(SshConnection con,
                           ChannelRequestFuture future)

AbstractSessionTask

public AbstractSessionTask(SshConnection con)

Method Detail

getSession

public T getSession()

disconnect

public void disconnect()

getLastError

public final java.lang.Throwable getLastError()

Overrides:

getLastError in class ConnectionAwareTask

getChannelFuture

public ChannelRequestFuture getChannelFuture()

doTask

public void doTask()

Specified by:

doTask in class ConnectionAwareTask

createSession

protected abstract T createSession(SshConnection con)

setupSession

protected abstract void setupSession(T session)

onOpenSession

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

Throws:

java.io.IOException

SshException

ShellTimeoutException

onCloseSession

protected abstract void onCloseSession(T session)

close

public void close()

isClosed

public boolean isClosed()

changeTerminalDimensions

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