org.kepler.ssh

Class SshExec

java.lang.Object

org.kepler.ssh.RemoteExec

org.kepler.ssh.SshExec

All Implemented Interfaces:

ExecInterface

Direct Known Subclasses:

SftpExec

public class SshExec
extends RemoteExec

This class provides functionality to use an SSH session to execute remote commands and to transfer files on a remote machine. A session can be opened using one the following authentication protocols: - public-key - password - keyboard-interactive You can create several sessions to different sites and use any of them referring to it with its user@host. An Ssh object can be used then by anyone anytime to copy file or execute commands without authenticating again. If the session becomes disconnected, the connection will be reopened at the next use, and authentication will be either automatic (public-key, or stored

Author:

Norbert Podhorszki Based on - JSch examples http://www.jcraft.com/jsch - OpenSSH 4.3 source code http://www.openssh.com/ - org.sdm.spa.Ssh2Exec Kepler actor Authors of the Kepler actor: Ilkay Altintas, Xiaowen Xin

Field Summary

Fields

Modifier and Type	Field and Description
protected com.jcraft.jsch.Session	jschSession
protected org.kepler.ssh.SshSession	session

Constructor Summary

Constructors

Constructor and Description
SshExec(java.lang.String target) Create and SshExec object from a combined target string.
SshExec(java.lang.String user, java.lang.String host)
SshExec(java.lang.String user, java.lang.String host, int port)

Method Summary

Modifier and Type	Method and Description
protected int	_copyTo(java.io.File lfile, java.lang.String targetPath, boolean recursive) Copy _one_ local file to a remote directory Input: file of type File (which can be a directory) Input must not have wildcards. targetPath is either a directory or filename
void	addIdentity(java.io.File identity)
void	addIdentity(java.lang.String identity) Add identity file Public-key authentication can be used if you add identity files
void	addPortForwardL(java.lang.String spec) Add a local port forwarding to an open connection.
void	addPortForwardR(java.lang.String spec) Add a remote port forwarding to an open connection.
protected static int	checkAck(java.io.InputStream in)
void	closeConnection() Close the connection This should be called only when there is no more use of the connection to this user@host Important: the ssh session remains opened as long as this method is not called, therefore, the the whole java application will hang at the end until this method is called.
int	copyFrom(java.lang.String rfile, java.io.File localPath, boolean recursive) Copy a remote file into a local file Input: 'rfile' of type String (can be a directory or filename) 'localPath' is either a directory or filename Only if 'recursive' is set, will directories copied recursively.
int	executeCmd(java.lang.String command, java.io.OutputStream streamOut, java.io.OutputStream streamErr) Execute a command on the remote machine.
int	executeCmd(java.lang.String command, java.io.OutputStream streamOut, java.io.OutputStream streamErr, java.lang.String thirdPartyTarget) Execute a command on the remote machine and expect a password/passphrase question from the command.
boolean	getForcedCleanUp()
int	getTimeout()
java.lang.String	getwildcardFileListingBBCP(java.lang.String srcConn, java.lang.String wildcardPattern)
boolean	isRemoteFileDirectory(java.lang.String fileName) Anand: New method added to check if remote file is a directory Run "cd" command on given file.
boolean	openConnection() Open the connection to the remote machine now.
void	removePortForwardL(int port, boolean closeIfLast) Remove a local port forwarding.
void	removePortForwardR(int port, boolean closeIfLast) Remove a remote port forwarding.
void	setcmdLineOptions(java.lang.String cmdLineOptions)
void	setForcedCleanUp(boolean foo) Specify if killing of remote processes (i.e. clean-up) after error or timeout is required.
void	setPortForwardingL(java.lang.String spec) Set a local port forwarding before the connection is made.
void	setPortForwardingR(java.lang.String spec) Set a remote port forwarding before the connection is made.
void	setProtocolPath(java.lang.String protocolPath)
void	setPseudoTerminal(boolean pseudoTerminal)
void	setTimeout(int seconds) Set timeout for the operations.
void	setTimeout(int seconds, boolean stdout, boolean stderr) Set timeout for the operations.

Methods inherited from class org.kepler.ssh.RemoteExec

copyFrom, copyTo, copyTo, createDir, deleteFile, kill

Methods inherited from class java.lang.Object

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

Field Detail

session

protected org.kepler.ssh.SshSession session

jschSession

protected com.jcraft.jsch.Session jschSession

Constructor Detail

SshExec

public SshExec(java.lang.String user,
               java.lang.String host)

SshExec

public SshExec(java.lang.String user,
               java.lang.String host,
               int port)

SshExec

public SshExec(java.lang.String target)

Create and SshExec object from a combined target string. Input: string of format [user@]host[:port]

Method Detail

openConnection

public boolean openConnection()
                       throws SshException

Open the connection to the remote machine now. It is not necessary to call this method! If you do not want to prolong making the connection until the first executeCmd / copyTo / copyFrom, then you need to use this method.

Specified by:

openConnection in interface ExecInterface

Specified by:

openConnection in class RemoteExec

Throws:

SshException

closeConnection

public void closeConnection()

Close the connection This should be called only when there is no more use of the connection to this user@host Important: the ssh session remains opened as long as this method is not called, therefore, the the whole java application will hang at the end until this method is called.

Specified by:

closeConnection in interface ExecInterface

Specified by:

closeConnection in class RemoteExec

addIdentity

public void addIdentity(java.lang.String identity)

Add identity file Public-key authentication can be used if you add identity files

addIdentity

public void addIdentity(java.io.File identity)

setPortForwardingL

public void setPortForwardingL(java.lang.String spec)
                        throws SshException

Set a local port forwarding before the connection is made. Format of the specification: lport:rhost:rport (int:string:int). lport on this host will be forwarded through this session and the remote host to the specified rhost:rport address.

Throws:

SshException

addPortForwardL

public void addPortForwardL(java.lang.String spec)

Add a local port forwarding to an open connection. Format of the specification: lport:rhost:rport (int:string:int). lport on this host will be forwarded through this session and the remote host to the specified rhost:rport address.

setPortForwardingR

public void setPortForwardingR(java.lang.String spec)
                        throws SshException

Set a remote port forwarding before the connection is made. Format of the specification: rport:lhost:lport (int:string:int). rport on remote host will be forwarded through this session and our local host to the specified lhost:lport address.

Throws:

SshException

addPortForwardR

public void addPortForwardR(java.lang.String spec)

Add a remote port forwarding to an open connection. Format of the specification: rport:lhost:lport (int:string:int). rport on remote host will be forwarded through this session and our local host to the specified lhost:lport address.

removePortForwardL

public void removePortForwardL(int port,
                               boolean closeIfLast)
                        throws SshException

Remove a local port forwarding.

Parameters:

port - the local port that is forwarded.

closeIfLast - If true, and there are no additional local ports forwarded, close the connection.

Throws:

SshException

removePortForwardR

public void removePortForwardR(int port,
                               boolean closeIfLast)
                        throws SshException

Remove a remote port forwarding.

Parameters:

port - the remote port that is forwarded.

closeIfLast - If true, and there are no additional remote ports forwarded, close the connection.

Throws:

SshException

setTimeout

public void setTimeout(int seconds,
                       boolean stdout,
                       boolean stderr)

Set timeout for the operations. Timeout should be given in seconds. If 'stdout' is set to true, the timer is restarted whenever there is data on stdout. If 'stderr' is set to true, the timer is restarted whenever there is data on stderr. executeCmd will throw an ExecException, an instance of ExecTimeoutException if the timeout limit is reached. 'seconds' = 0 means no timeout at all. Note: copyTo and copyFrom operations currently do not support timeout. Note: currently, the timer cannot be restarted on stderr events in executeCmd

setForcedCleanUp

public void setForcedCleanUp(boolean foo)

Specify if killing of remote processes (i.e. clean-up) after error or timeout is required. Unix specific solution is used for clean-up, so do not use it when connecting to another servers. Default is false, of course, but use it whenever you can (i.e. connect to unix machines).

executeCmd

public int executeCmd(java.lang.String command,
                      java.io.OutputStream streamOut,
                      java.io.OutputStream streamErr)
               throws ExecException

Execute a command on the remote machine. The streams streamOut and streamErr should be provided to get the output and errors.

Returns:

exit code of command if execution succeeded,

Throws:

ExecTimeoutException - if the command failed because of timeout

SshException - if an error occurs for the ssh connection during the command execution

ExecException

executeCmd

public int executeCmd(java.lang.String command,
                      java.io.OutputStream streamOut,
                      java.io.OutputStream streamErr,
                      java.lang.String thirdPartyTarget)
               throws ExecException

Execute a command on the remote machine and expect a password/passphrase question from the command. The stream streamOut should be provided to get the output and errors merged. streamErr is not used in this method (it will be empty string finally).

Returns:

exit code of command if execution succeeded,

Throws:

ExecTimeoutException - if the command failed because of timeout

SshException - if an error occurs for the ssh connection during the command execution Note: in this method, the SSH Channel is forcing a pseudo-terminal allocation {see setPty(true)} to allow remote commands to read something from their stdin (i.e. from us here), thus, (1) remote environment is not set from .bashrc/.cshrc and (2) stdout and stderr come back merged in one stream.

ExecException

_copyTo

protected int _copyTo(java.io.File lfile,
                      java.lang.String targetPath,
                      boolean recursive)
               throws SshException

Copy _one_ local file to a remote directory Input: file of type File (which can be a directory) Input must not have wildcards. targetPath is either a directory or filename

Specified by:

_copyTo in class RemoteExec

Returns:

number of files copied successfully SshException is thrown in case of error.

Throws:

SshException

checkAck

protected static int checkAck(java.io.InputStream in)
                       throws java.io.IOException,
                              SshException

Throws:

java.io.IOException

SshException

isRemoteFileDirectory

public boolean isRemoteFileDirectory(java.lang.String fileName)
                              throws java.lang.Exception

Anand: New method added to check if remote file is a directory Run "cd" command on given file. It success, it is a directory, else it is not.

Parameters:

fileName - : file which is to be checked to see if it is a directory

Returns:

: true if it is a directory, else false

Throws:

java.lang.Exception

copyFrom

public int copyFrom(java.lang.String rfile,
                    java.io.File localPath,
                    boolean recursive)
             throws SshException

Copy a remote file into a local file Input: 'rfile' of type String (can be a directory or filename) 'localPath' is either a directory or filename Only if 'recursive' is set, will directories copied recursively.

Specified by:

copyFrom in interface ExecInterface

Specified by:

copyFrom in class RemoteExec

Returns:

number of files copied successfully SshException is thrown in case of error.

Throws:

SshException

setPseudoTerminal

public void setPseudoTerminal(boolean pseudoTerminal)

setProtocolPath

public void setProtocolPath(java.lang.String protocolPath)

setcmdLineOptions

public void setcmdLineOptions(java.lang.String cmdLineOptions)

getForcedCleanUp

public boolean getForcedCleanUp()

Specified by:

getForcedCleanUp in class RemoteExec

getTimeout

public int getTimeout()

Specified by:

getTimeout in class RemoteExec

setTimeout

public void setTimeout(int seconds)

Description copied from interface: ExecInterface

Set timeout for the operations.

getwildcardFileListingBBCP

public java.lang.String getwildcardFileListingBBCP(java.lang.String srcConn,
                                                   java.lang.String wildcardPattern)
                                            throws ExecException

Throws:

ExecException