arlut.csd.Util

Class FileOps

java.lang.Object

arlut.csd.Util.FileOps

public class FileOps
extends java.lang.Object

This utility class provides a number of static methods for doing file operations.

Field Summary

Fields

Modifier and Type	Field and Description
private static int	MAXSIZE

Constructor Summary

Constructors

Constructor and Description
FileOps()

Method Summary

Methods

Modifier and Type	Method and Description
static void	cleanupProcess(java.lang.Process p) This method shuts down / cleans up all resources related to Process p.
static boolean	copyFile(java.lang.String inputFileName, java.lang.String outputFileName) Copies a file named inputFileName to the location outputFileName in an operating system independent fashion.
static boolean	deleteDirectory(java.lang.String directoryName)
static boolean	deleteFile(java.lang.String filename)
static void	main(java.lang.String[] args) Test rig
private static java.util.List	runCaptureOutputProcess(java.lang.Process p) This method is used to run an external process line for the Ganymede server.
static java.util.List	runCaptureOutputProcess(java.lang.String commandLine) This method is used to run an external process line for the Ganymede server.
static java.util.List	runCaptureOutputProcess(java.lang.String[] cmdArgs) This method is used to run an external process line for the Ganymede server.
private static int	runProcess(java.lang.Process p) This method is used to run an external process line for the Ganymede server.
static int	runProcess(java.lang.String commandLine) This method is used to run an external process line for the Ganymede server.
static int	runProcess(java.lang.String[] cmdArgs) This method is used to run an external process line for the Ganymede server.
private static void	slurpStreams(java.io.InputStream outStream, java.io.InputStream errStream, java.lang.StringBuffer outBuffer, java.lang.StringBuffer errBuffer) Read everything we can from the passed stdout and stderr streams, copy the data into outBuffer and errBuffer.

Methods inherited from class java.lang.Object

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

Field Detail

MAXSIZE

private static int MAXSIZE

Constructor Detail

FileOps

public FileOps()

Method Detail

copyFile

public static boolean copyFile(java.lang.String inputFileName,
               java.lang.String outputFileName)
                        throws java.io.IOException

Copies a file named inputFileName to the location outputFileName in an operating system independent fashion.

Throws:

java.io.IOException

deleteFile

public static boolean deleteFile(java.lang.String filename)
                          throws java.io.IOException

Throws:

java.io.IOException

deleteDirectory

public static boolean deleteDirectory(java.lang.String directoryName)
                               throws java.io.IOException

Throws:

java.io.IOException

runProcess

public static int runProcess(java.lang.String[] cmdArgs)
                      throws java.io.IOException,
                             java.lang.InterruptedException

This method is used to run an external process line for the Ganymede server. This method waits until the external command completes before returning, and all file handles opened to communicate with the process will be closed before returning.

While this method is waiting for the process to exit, it will spin on the stdout and stderr from the process, consuming and discarding anything written by the subprocess so as to prevent the subprocess from blocking due to its output piling up.

Throws:

java.io.IOException

java.lang.InterruptedException

runProcess

public static int runProcess(java.lang.String commandLine)
                      throws java.io.IOException,
                             java.lang.InterruptedException

This method is used to run an external process line for the Ganymede server. This method waits until the external command completes before returning, and all file handles opened to communicate with the process will be closed before returning.

While this method is waiting for the process to exit, it will spin on the stdout and stderr from the process, consuming and discarding anything written by the subprocess so as to prevent the subprocess from blocking due to its output piling up.

Throws:

java.io.IOException

java.lang.InterruptedException

runProcess

private static int runProcess(java.lang.Process p)
                       throws java.io.IOException,
                              java.lang.InterruptedException

This method is used to run an external process line for the Ganymede server. This method waits until the external command completes before returning, and all file handles opened to communicate with the process will be closed before returning.

While this method is waiting for the process to exit, it will spin on the stdout and stderr from the process, consuming and discarding anything written by the subprocess so as to prevent the subprocess from blocking due to its output piling up.

Throws:

java.io.IOException

java.lang.InterruptedException

runCaptureOutputProcess

public static java.util.List runCaptureOutputProcess(java.lang.String[] cmdArgs)
                                              throws java.io.IOException,
                                                     java.lang.InterruptedException

This method is used to run an external process line for the Ganymede server. This method waits until the external command completes before returning, and all file handles opened to communicate with the process will be closed before returning.

Returns:

a List comprising the Integer result code, the String stdout text, and the String Stderr text.

Throws:

java.io.IOException

java.lang.InterruptedException

runCaptureOutputProcess

public static java.util.List runCaptureOutputProcess(java.lang.String commandLine)
                                              throws java.io.IOException,
                                                     java.lang.InterruptedException

This method is used to run an external process line for the Ganymede server. This method waits until the external command completes before returning, and all file handles opened to communicate with the process will be closed before returning.

Returns:

a List comprising the Integer result code, the String stdout text, and the String Stderr text.

Throws:

java.io.IOException

java.lang.InterruptedException

runCaptureOutputProcess

private static java.util.List runCaptureOutputProcess(java.lang.Process p)
                                               throws java.io.IOException,
                                                      java.lang.InterruptedException

This method is used to run an external process line for the Ganymede server. This method waits until the external command completes before returning, and all file handles opened to communicate with the process will be closed before returning.

Returns:

a List comprising the Integer result code, the String stdout text, and the String Stderr text.

Throws:

java.io.IOException

java.lang.InterruptedException

slurpStreams

private static void slurpStreams(java.io.InputStream outStream,
                java.io.InputStream errStream,
                java.lang.StringBuffer outBuffer,
                java.lang.StringBuffer errBuffer)

Read everything we can from the passed stdout and stderr streams, copy the data into outBuffer and errBuffer.

cleanupProcess

public static void cleanupProcess(java.lang.Process p)

This method shuts down / cleans up all resources related to Process p. The following is mentioned as a work-around for the fact that Process keeps its file descriptors open by default until Garbage Collection.

main

public static void main(java.lang.String[] args)

Test rig