jatoo.exec.remote

Class RemoteCommandExecutor

java.lang.Object

jatoo.exec.remote.RemoteCommandExecutor

public final class RemoteCommandExecutor
extends Object

Handy class to ease the remote execution of commands.

Version:

1.3, July 24, 2014

Author:

Cristian Sulea

Constructor Summary

Constructors

Constructor and Description
RemoteCommandExecutor()

Method Summary

Methods

Modifier and Type	Method and Description
void	connect(String host, int port, String username, String password) Connects this executor to the remote system.
void	disconnect() Disconnects this executor to the remote system.
int	exec(String command) Handy method for exec(String, OutputStream, boolean) with no dump output stream.
int	exec(String command, OutputStream dumpOutputStream) Handy method for exec(String, OutputStream, boolean) with specified dump output stream (but no closing).
int	exec(String command, OutputStream dumpOutputStream, boolean closeDumpOutputStream) Executes the specified command.
int	exec(String command, OutputStream dumpOutputStream, boolean closeDumpOutputStream, RemoteCommandExecutorCallback callback) Executes the specified command.
boolean	isConnected() Checks if this executor is connected to the remote system.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RemoteCommandExecutor

public RemoteCommandExecutor()

Method Detail

connect

public void connect(String host,
           int port,
           String username,
           String password)
             throws com.jcraft.jsch.JSchException

Connects this executor to the remote system.

Parameters:

host - the host name, or address, of the remote system

port - the port number of the remote system

username - the user name

password - the user's password

Throws:

com.jcraft.jsch.JSchException - if a JCraft error occurs

isConnected

public boolean isConnected()

Checks if this executor is connected to the remote system.

Returns:

true if executor is connected, false otherwise

disconnect

public void disconnect()

Disconnects this executor to the remote system.

exec

public int exec(String command)
         throws IOException,
                com.jcraft.jsch.JSchException

Handy method for exec(String, OutputStream, boolean) with no dump output stream.

Parameters:

command - the command to be executed

Returns:

the exit value of the process (by convention, the value 0 indicates normal termination | take care that JSch is also returning -1)

Throws:

IOException - if an I/O error occurs

com.jcraft.jsch.JSchException - if a JCraft error occurs

exec

public int exec(String command,
       OutputStream dumpOutputStream)
         throws IOException,
                com.jcraft.jsch.JSchException

Handy method for exec(String, OutputStream, boolean) with specified dump output stream (but no closing).

Parameters:

command - the command to be executed

dumpOutputStream - the stream where the process will dump (exhaust) his contents

Returns:

the exit value of the process (by convention, the value 0 indicates normal termination | take care that JSch is also returning -1)

Throws:

IOException - if an I/O error occurs

com.jcraft.jsch.JSchException - if a JCraft error occurs

exec

public int exec(String command,
       OutputStream dumpOutputStream,
       boolean closeDumpOutputStream)
         throws IOException,
                com.jcraft.jsch.JSchException

Executes the specified command.

Parameters:

command - the command to be executed

dumpOutputStream - the stream where the process will dump (exhaust) his contents

closeDumpOutputStream - true if the dump stream should be closed when the execution ends, false otherwise

Returns:

the exit value of the process (by convention, the value 0 indicates normal termination | take care that JSch is also returning -1)

Throws:

IOException - if an I/O error occurs

com.jcraft.jsch.JSchException - if a JCraft error occurs

exec

public int exec(String command,
       OutputStream dumpOutputStream,
       boolean closeDumpOutputStream,
       RemoteCommandExecutorCallback callback)
         throws IOException,
                com.jcraft.jsch.JSchException

Executes the specified command.

Parameters:

command - the command to be executed

dumpOutputStream - the stream where the process will dump (exhaust) his contents

closeDumpOutputStream - true if the dump stream should be closed when the execution ends, false otherwise

callback - the callback used to do things after the execution started

Returns:

the exit value of the process (by convention, the value 0 indicates normal termination | take care that JSch is also returning -1)

Throws:

IOException - if an I/O error occurs

com.jcraft.jsch.JSchException - if a JCraft error occurs