What is the difference between the 'shell' channel and the 'exec' channel in JSch

Solution 1:

An overview about the differences and similarities between these streams you can find at »Shell, Exec or Subsystem Channel« in the JSch wiki. Here some details for your use case.

In the exec channel, the commands come from the command string you did give with setCommand(). The SSH server will pass them at once to the shell (using something like bash -c '<command>').

They will all be executed, if the shell does not somehow exit before for some reason. (You could send a whole shell script here which implements some logic using if and similar, if this is wanted.)

So, to execute multiple commands, you could pass them to the exec channel by separating them with ; or newline (\n). As you can't wait for the results before giving all the commands, here you can only use multiple exec channels (but as each channel spawns a new shell, they don't conserve state between them, like working directory or shell variables).

In the shell channel, the shell will read input from the stream, and interpret the first line as a command (or several ones).

Then it will execute this command. The command itself might read more input from the stream, if it wants.

Then the shell will read the next line, interpret it as a command, and execute.

(In some cases the shell has to read more than one line, for example for long strings or composed commands like if or loops.)

This will go on until either the end of the stream (e.g. stream.close() at your side) or executing an explicit exit command.

If you don't send any input to the shell via the channels input/output stream, the shell will simply wait until you either send more or close the stream. Thus you can quietly read the output of one command, do some calculations on the client side and then decide which command to send next.

Just make sure you don't mix input to one command with the text of the next command - preferably don't use any commands which will read from standard input.

Solution 2:

With shell channel the shell (on unix it's sh or bash or something like that, on Windows it's usually cmd.exe) is started and console is created (the same you see on the screen if you run them locally). You have a prompt which you can parse or use for detection of completion of command.

With command channel a shell instance is started for each command (actually the channel is opened for each command) and a command is passed as a parameter for the shell (on Windows it would look like "cmd.exe /c ".

It's easier to use command channel cause you don't need to deal with command prompt.

Solution 3:

well, I found out that this works and it's really convenient if you want to preserve state like a regular shell would:

Session session = jsch.getSession(user, host, 22);

Channel channel = session.openChannel("shell");

OutputStream inputstream_for_the_channel = channel.getOutputStream();
PrintStream commander = new PrintStream(inputstream_for_the_channel, true);

channel.setOutputStream(System.out, true);

channel.connect();

commander.println("ls -la");    
commander.println("cd folder");
commander.println("ls -la");
commander.println("exit");
commander.close();

do {
    Thread.sleep(1000);
} while(!channel.isEOF());

session.disconnect();

You could change

channel.setOutputStream(System.out, true);

with

InputStream outputstream_from_the_channel = channel.getInputStream();
BufferedReader br = new BufferedReader(new InputStreamReader(outputstream_from_the_channel));
String line;
while ((line = br.readLine()) != null)
    System.out.print(line+"\n");

if you want more control on the output.

=============================================================================

EDITED: follow up

why sometimes the commands I send through the PrintStream appear randomly in the output. i.e. the following code:

shell[0].println("cd ..");
shell[0].println("cd ..");
shell[0].println("ls -la");
shell[0].println("exit");

produces this: (marked with {thing} are things that shouldnt be there!)

Last login: Thu Jul 21 21:49:13 2011 from gateway

Manifests: trunk-latest

[host ~]$ cd ..
{cd ..}[host home]$
[host home]$ cd ..
[host /]$
[host /]$ ls -la
{exit}

total 9999
---------- 27 root root 4096 Jan 26 2010 .
---------- 27 root root 4096 Jan 26 2010 ..
---------- 1 root root 0 Mar 14 19:16 .autojyk
---------- 1 root root 0 Feb 9 2009 .automan
---------- 1 root root 3550 May 14 2010 .bash_history
d--------- 2 root root 4096 Apr 26 04:02 put
d--------- 5 root root 4024 Apr 25 19:31 boot
[m[host /]$
[host /]$ exit
logout