ch.ethz.ssh2

Interface ServerSessionCallback

All Known Implementing Classes:

SimpleServerSessionCallback

public interface ServerSessionCallback

The interface for an object that receives events based on requests that a client sends on a session channel. Once the session channel has been set up, a program is started at the server end. The program can be a shell, an application program, or a subsystem with a host-independent name. Only one of these requests can succeed per channel.

CAUTION: These event methods are being called from the receiver thread. The receiving of messages will be blocked until your event handler returns. To signal to the client that you are willing to accept its request, return a Runnable object which will be executed in a new thread after the acknowledgment has been sent back to the client.

If a method does not allow you to return a Runnable, then the SSH protocol does not allow to send a status back to the client (more exactly, the client cannot request an acknowledgment). In these cases, if you need to invoke methods on the ServerSession or plan to execute long-running activity, then please do this from within a new Thread.

If you want to signal a fatal error, then please throw an IOException. Currently, this will tear down the whole SSH connection.

Author:

Christian

See Also:

ServerSession

Method Summary

Methods

Modifier and Type	Method and Description
Runnable	requestEnv(ServerSession ss, String name, String value)
Runnable	requestExec(ServerSession ss, String command)
Runnable	requestPtyReq(ServerSession ss, PtySettings pty)
Runnable	requestShell(ServerSession ss)
Runnable	requestSubsystem(ServerSession ss, String subsystem)
void	requestWindowChange(ServerSession ss, int term_width_columns, int term_height_rows, int term_width_pixels, int term_height_pixels) When the window (terminal) size changes on the client side, it MAY send a message to the other side to inform it of the new dimensions.

Method Detail

requestPtyReq

Runnable requestPtyReq(ServerSession ss,
                     PtySettings pty)
                       throws IOException

Throws:

IOException

requestEnv

Runnable requestEnv(ServerSession ss,
                  String name,
                  String value)
                    throws IOException

Throws:

IOException

requestShell

Runnable requestShell(ServerSession ss)
                      throws IOException

Throws:

IOException

requestExec

Runnable requestExec(ServerSession ss,
                   String command)
                     throws IOException

Throws:

IOException

requestSubsystem

Runnable requestSubsystem(ServerSession ss,
                        String subsystem)
                          throws IOException

Throws:

IOException

requestWindowChange

void requestWindowChange(ServerSession ss,
                       int term_width_columns,
                       int term_height_rows,
                       int term_width_pixels,
                       int term_height_pixels)
                         throws IOException

When the window (terminal) size changes on the client side, it MAY send a message to the other side to inform it of the new dimensions.

Parameters:

ss - the corresponding session

term_width_columns -

term_height_rows -

term_width_pixels -

Throws:

IOException