ru.dmerkushov.oshelper

Class OSHelper

java.lang.Object

ru.dmerkushov.oshelper.OSHelper

public class OSHelper
extends Object

Author:

Dmitriy Merkushov

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OSHelper.ProcessReturn

Field Summary

Fields

Modifier and Type	Field and Description
static int	osh_PROCESS_EXITED_BY_ITSELF Deprecated. Use ProcessReturn.osh_PROCESS_EXITED_BY_ITSELF
static int	osh_PROCESS_KILLED_BY_TIMEOUT Deprecated. Use ProcessReturn.osh_PROCESS_KILLED_BY_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
OSHelper()

Method Summary

Methods

Modifier and Type	Method and Description
static List<String>	constructCommandAsList_Unix_sh(String command) Helper method to construct a UNIX-like-OS-compatible command that is using the SH shell syntax.
static List<String>	constructCommandAsList_Windows_cmd(String command) Helper method to construct a Windows-compatible command that is using the CMD shell syntax.
static void	copyFile(String sourceFileName, String targetFileName) Copy files
static int	procWait(Process process) Deprecated. Use ProcessReturn procWaitWithProcessReturn () instead
static int	procWait(Process process, long timeout) Deprecated. Use ProcessReturn procWaitWithProcessReturn () instead
static OSHelper.ProcessReturn	procWaitWithProcessReturn(Process process)
static OSHelper.ProcessReturn	procWaitWithProcessReturn(Process process, long timeout) Waits for a specified process to terminate for the specified amount of milliseconds.
static byte[]	readFile(String fileName) Read a file to a byte array
static Process	runCommand(List<String> toRun) Runs a new OS process
static OSHelper.ProcessReturn	sendEmail_Unix(String target, String topic, String text) Send a simple email
static void	writeFile(byte[] bytes, String targetFileName) Write a file

Methods inherited from class java.lang.Object

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

Field Detail

osh_PROCESS_EXITED_BY_ITSELF

public static final int osh_PROCESS_EXITED_BY_ITSELF

Deprecated. Use ProcessReturn.osh_PROCESS_EXITED_BY_ITSELF

See Also:

Constant Field Values

osh_PROCESS_KILLED_BY_TIMEOUT

public static final int osh_PROCESS_KILLED_BY_TIMEOUT

Deprecated. Use ProcessReturn.osh_PROCESS_KILLED_BY_TIMEOUT

See Also:

Constant Field Values

Constructor Detail

OSHelper

public OSHelper()

Method Detail

runCommand

public static Process runCommand(List<String> toRun)
                          throws OSHelperException

Runs a new OS process

Parameters:

toRun - OS console command to run

Returns:

the process object

Throws:

OSHelperException

procWaitWithProcessReturn

public static OSHelper.ProcessReturn procWaitWithProcessReturn(Process process)
                                                        throws OSHelperException

Throws:

OSHelperException

procWaitWithProcessReturn

public static OSHelper.ProcessReturn procWaitWithProcessReturn(Process process,
                                               long timeout)
                                                        throws OSHelperException

Waits for a specified process to terminate for the specified amount of milliseconds. If it is not terminated in the desired time, it is terminated explicitly. NOT TESTED!!!

Parameters:

process -

timeout -

Returns:

Throws:

OSHelperException

procWait

public static int procWait(Process process)
                    throws OSHelperException

Deprecated. Use ProcessReturn procWaitWithProcessReturn () instead

Waits for a specified process to terminate

Parameters:

process -

Throws:

OSHelperException

procWait

public static int procWait(Process process,
           long timeout)
                    throws OSHelperException

Deprecated. Use ProcessReturn procWaitWithProcessReturn () instead

Waits for a specified process to terminate for the specified amount of milliseconds. If it is not terminated in the desired time, it is terminated explicitly. NOT TESTED!!!

Parameters:

process -

timeout -

Returns:

either osh_PROCESS_EXITED_BY_ITSELF * * * or osh_PROCESS_KILLED_BY_TIMEOUT

Throws:

OSHelperException

readFile

public static byte[] readFile(String fileName)
                       throws OSHelperException

Read a file to a byte array

Parameters:

fileName -

Returns:

Throws:

OSHelperException

writeFile

public static void writeFile(byte[] bytes,
             String targetFileName)
                      throws OSHelperException

Write a file

Parameters:

bytes -

targetFileName -

Throws:

OSHelperException

copyFile

public static void copyFile(String sourceFileName,
            String targetFileName)
                     throws OSHelperException

Copy files

Parameters:

sourceFileName -

targetFileName -

Throws:

OSHelperException

sendEmail_Unix

public static OSHelper.ProcessReturn sendEmail_Unix(String target,
                                    String topic,
                                    String text)
                                             throws OSHelperException

Send a simple email

Parameters:

target -

topic -

text -

Returns:

The ProcessReturn structure of the mailing process. Normal are empty stdout and stderr, 0 * for exitCode and osh_PROCESS_EXITED_BY_ITSELF for exitStatus

Throws:

OSHelperException

See Also:

OSHelper.ProcessReturn

constructCommandAsList_Unix_sh

public static List<String> constructCommandAsList_Unix_sh(String command)

Helper method to construct a UNIX-like-OS-compatible command that is using the SH shell syntax.

Parameters:

command -

Returns:

constructCommandAsList_Windows_cmd

public static List<String> constructCommandAsList_Windows_cmd(String command)

Helper method to construct a Windows-compatible command that is using the CMD shell syntax.

Parameters:

command -

Returns: