org.apache.oodt.commons.exec

Class EnvUtilities

java.lang.Object

org.apache.oodt.commons.exec.EnvUtilities

public final class EnvUtilities
extends Object

Version:

$Revision$

Environment Utilities for reading variables and setting them and such.

.

Author:

mattmann, bfoster, mstarch

Method Summary

Methods

Modifier and Type	Method and Description
static Properties	getEnv() This method does exactly the same thing as getEnvUsingWaitFor(), except it uses System.getenv()
static String	getEnv(String envVarName) This method returns a particular named environment variable from the user's working environment using the getEnv() method to grab that environment.
static Properties	getEnvUsingWaitFor() Deprecated.
protected static InputStream	preProcessInputStream(InputStream is)
static String	slurp(InputStream in) This method turns an InputStream into a String.

Methods inherited from class java.lang.Object

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

Method Detail

getEnv

public static String getEnv(String envVarName)

This method returns a particular named environment variable from the user's working environment using the getEnv() method to grab that environment.

Parameters:

envVarName - The named environment variable to return.

Returns:

The environment variable value, as a String.

getEnv

public static Properties getEnv()

This method does exactly the same thing as getEnvUsingWaitFor(), except it uses System.getenv()

Returns:

The user's current environment, in a Properties object.

getEnvUsingWaitFor

public static Properties getEnvUsingWaitFor()

Deprecated.

This method grabs the current environment using the Linux shell program called env. Unfortunately, this method also uses Process.waitFor(), which seems to hang when folks have weird environment variables and such. A more appropriate method to call is getEnv() because it uses the ExecHelper class, which seems to handle process termination a bit more elegantly.

Returns:

A Properites object containing the user's current environment variables.

slurp

public static String slurp(InputStream in)
                    throws IOException

This method turns an InputStream into a String. Method taken from:
http://snippets.dzone.com/posts/show/555.

Parameters:

in - The InputStream to Stringify.

Returns:

A String constructed from the given InputStream.

Throws:

IOException - If any error occurs.

preProcessInputStream

protected static InputStream preProcessInputStream(InputStream is)
                                            throws Exception

Throws:

Exception