org.ovirt.engine.core.utils.hostinstall

Class MinaInstallWrapper

java.lang.Object

org.ovirt.engine.core.utils.hostinstall.MinaInstallWrapper

All Implemented Interfaces:

IVdsInstallWrapper

public class MinaInstallWrapper
extends Object
implements IVdsInstallWrapper

This Class implements file upload/download and command execution over SSH. Currently the code is very ugly (!!!) since it implements file transfer using exec channel and large file upload using reverse SSH. The reason for this is mina's lack of SFTP/SCP functionality. Once Mina completes the SFTP (or SCP) functionality, this class should be fixed to use mina's built-in file transfer functionality. In this case the current UploadFile should be deleted (with uploadLargeFile), and leave only uploadSmallfile with proper SFTP implementation, which should be renamed to UploadFile.

Constructor Summary

Constructors

Modifier	Constructor and Description
	MinaInstallWrapper()
protected	MinaInstallWrapper(org.apache.sshd.SshClient sshClient)

Method Summary

Methods

Modifier and Type	Method and Description
static String	byteArrayToHexString(byte[] b, boolean fFormat) A utility method to convert bytes into a printable string.
protected void	callbackAddError(String message)
protected void	callbackAddMessage(String message)
protected void	callbackConnected()
protected void	callbackEndTransfer()
protected void	callbackFailed(String message)
boolean	ConnectToServer(String server)
boolean	ConnectToServer(String server, String rootPassword)
boolean	ConnectToServer(String server, String rootPassword, long timeout)
boolean	ConnectToServer(String server, String certPath, String password)
boolean	DownloadFile(String remoteSource, String localDestination) This implementation uses gzip at the remote end to create a binary stream we gunzip on local machine to the desired destination.
void	fastFileCopy(String srcFile, String dstFile, boolean overwrite) Optimized copy source file to destination, based on file size.
protected void	finalize() We use finalize in order to properly close the SSH client.
int	getPort()
protected boolean	haveCallback()
void	InitCallback(IVdsInstallCallBack callback)
protected String	readInput(InputStream input) Consume data from input stream and convert is into a String
protected String	readLineFromInput(InputStream input) Consume String lines from input stream
boolean	RunSSHCommand(String command) This method executes a given command in remote SSH shell.
void	setPort(int port)
boolean	UploadFile(String source, String destination) This implementation checks for file size, and uses the relevant implementation to upload the given file.
boolean	waitWithTimeout(org.apache.sshd.ClientChannel channel, int timeoutInMilliSeconds) A utility method to wait for channel to close.
void	wrapperShutdown()

Methods inherited from class java.lang.Object

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

Constructor Detail

MinaInstallWrapper

public MinaInstallWrapper()

MinaInstallWrapper

protected MinaInstallWrapper(org.apache.sshd.SshClient sshClient)

Method Detail

finalize

protected void finalize()
                 throws Throwable

We use finalize in order to properly close the SSH client. This is important in order to avoid leaks (memory/threads).

Overrides:

finalize in class Object

Throws:

Throwable

InitCallback

public final void InitCallback(IVdsInstallCallBack callback)

Specified by:

InitCallback in interface IVdsInstallWrapper

ConnectToServer

public final boolean ConnectToServer(String server)

Specified by:

ConnectToServer in interface IVdsInstallWrapper

ConnectToServer

public final boolean ConnectToServer(String server,
                      String rootPassword)

Specified by:

ConnectToServer in interface IVdsInstallWrapper

ConnectToServer

public final boolean ConnectToServer(String server,
                      String rootPassword,
                      long timeout)

Specified by:

ConnectToServer in interface IVdsInstallWrapper

ConnectToServer

public final boolean ConnectToServer(String server,
                      String certPath,
                      String password)

Specified by:

ConnectToServer in interface IVdsInstallWrapper

RunSSHCommand

public final boolean RunSSHCommand(String command)

This method executes a given command in remote SSH shell. The method returns false if session was not closed normally. Note: This method is using piped (in+out streams). This is possible only when producer & consumer are different threads. If it happens to run on the same thread it may create deadlocks.

Specified by:

RunSSHCommand in interface IVdsInstallWrapper

DownloadFile

public final boolean DownloadFile(String remoteSource,
                   String localDestination)

This implementation uses gzip at the remote end to create a binary stream we gunzip on local machine to the desired destination. Note, this implementation should be replaced by mina SSHD's standard scp/sftp implementation once available.

Specified by:

DownloadFile in interface IVdsInstallWrapper

Parameters:

remoteSource - source file on the remote machine. This should be a valid path and file name.

localDestination - destination file on the local machine. This should be a valid path and file name.

UploadFile

public final boolean UploadFile(String source,
                 String destination)

This implementation checks for file size, and uses the relevant implementation to upload the given file. Note: this implementation should be replaced by mina- SSHD's standard scp/sftp implementation once available.

Specified by:

UploadFile in interface IVdsInstallWrapper

Parameters:

source - Source file on the local machine. This should be a valid path and file name.

destination - Destination file on the remote machine. This should be a valid path and file name.

callbackAddError

protected void callbackAddError(String message)

callbackAddMessage

protected void callbackAddMessage(String message)

callbackConnected

protected void callbackConnected()

callbackEndTransfer

protected void callbackEndTransfer()

callbackFailed

protected void callbackFailed(String message)

haveCallback

protected boolean haveCallback()

waitWithTimeout

public boolean waitWithTimeout(org.apache.sshd.ClientChannel channel,
                      int timeoutInMilliSeconds)

A utility method to wait for channel to close.

Parameters:

channel - A reference to client channel.

timeoutInMilliSeconds - Timeout period in milliseconds to wait for.

Returns:

. * True- if got channel CLOSED within timeout period. . * False- Any other exit reason.

byteArrayToHexString

public static String byteArrayToHexString(byte[] b,
                          boolean fFormat)

A utility method to convert bytes into a printable string.

Parameters:

b - An array of bytes to be printed

fFormat - Should we use pretty format (add [] for each byte).

Returns:

A printable string.

readInput

protected String readInput(InputStream input)

Consume data from input stream and convert is into a String

Parameters:

input - An input stream.

Returns:

A string object representing the contents of the given stream.

readLineFromInput

protected String readLineFromInput(InputStream input)

Consume String lines from input stream

Parameters:

input - An input stream

Returns:

A string object representing the contents of the given stream split into lines.

fastFileCopy

public void fastFileCopy(String srcFile,
                String dstFile,
                boolean overwrite)
                  throws IOException,
                         IllegalArgumentException

Optimized copy source file to destination, based on file size. If destination is a path then source file name is appended. If destination file exists then: overwrite=true, destination file is replaced; overwrite=false, exception is thrown.

Parameters:

src - source file

dst - destination file or path

overwrite - overwrite destination file

Throws:

IOException - I/O problem

IllegalArgumentException - illegal argument

wrapperShutdown

public void wrapperShutdown()

Specified by:

wrapperShutdown in interface IVdsInstallWrapper

getPort

public int getPort()

setPort

public void setPort(int port)