com.peterphi.std.system.exec

Class Exec

java.lang.Object

com.peterphi.std.system.exec.Exec

public class Exec
extends java.lang.Object

An abstraction over ProcessBuilder to simplify the creation of processes

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<java.lang.String>	cmd

Constructor Summary

Constructors

Constructor and Description
Exec(java.lang.Iterable<java.lang.String> command)
Exec(java.lang.String... command)

Method Summary

Methods

Modifier and Type	Method and Description
static Execed	appAs(java.lang.String as, java.lang.Iterable<java.lang.String> command) Runs a command, optionally executing as a different user (eg root)
static Execed	appAs(java.lang.String as, java.lang.String... command) Runs a command, optionally executing as a different user (eg root)
java.lang.String	getEnv(java.lang.String key)
java.lang.ProcessBuilder	getProcessBuilder() Returns a ProcessBuilder for use in a manual launching
boolean	getRedirectError()
java.io.File	getWorkingDirectory()
protected static java.lang.String	join(java.lang.String with, java.util.List<java.lang.String> strings)
protected static java.lang.String	join(java.lang.String with, java.lang.String... strings)
static Execed	rootUtility(java.lang.Iterable<java.lang.String> command) Runs a command in "utility" mode: redirecting stderr to stdout and running as root
static Execed	rootUtility(java.lang.String... command) Runs a command in "utility" mode: redirecting stderr to stdout and running as root
Exec	runAs(java.lang.String username)
Exec	runAsSuperuser()
Exec	setEnv(java.lang.String key, java.lang.String value)
Exec	setRedirectError(boolean value)
Exec	setWorkingDirectory(java.io.File dir)
Execed	start() Launches the process, returning a handle to it for IO ops, etc. The finish condition for the OutputProcess is that all processes outputting to standard out must be complete before proceeding
BaseExeced	startBasic() Launches the process, returning a handle to it for IO ops, etc the caller must read the output streams: otherwise the buffers may fill up and the remote program will be suspended indefinitely
java.lang.ProcessBuilder	startManually() Deprecated.
static Execed	utility(java.lang.Iterable<java.lang.String> command) Runs a command in "utility" mode: redirecting stderr to stdout and optionally executing as a different user (eg root)
static Execed	utility(java.lang.String... command) Runs a command in "utility" mode: redirecting stderr to stdout and optionally executing as a different user (eg root)
static Execed	utilityAs(java.lang.String as, java.lang.Iterable<java.lang.String> command) Runs a command in "utility" mode: redirecting stderr to stdout and optionally executing as a different user (eg root)
static Execed	utilityAs(java.lang.String as, java.lang.String... command) Runs a command in "utility" mode: redirecting stderr to stdout and optionally executing as a different user (eg root)

Methods inherited from class java.lang.Object

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

Field Detail

cmd

protected final java.util.List<java.lang.String> cmd

Constructor Detail

Exec

public Exec(java.lang.String... command)

Exec

public Exec(java.lang.Iterable<java.lang.String> command)

Method Detail

getWorkingDirectory

public java.io.File getWorkingDirectory()

setWorkingDirectory

public Exec setWorkingDirectory(java.io.File dir)

setEnv

public Exec setEnv(java.lang.String key,
          java.lang.String value)

getEnv

public java.lang.String getEnv(java.lang.String key)

runAsSuperuser

public Exec runAsSuperuser()

runAs

public Exec runAs(java.lang.String username)

getRedirectError

public boolean getRedirectError()

setRedirectError

public Exec setRedirectError(boolean value)

startBasic

public BaseExeced startBasic()
                      throws java.io.IOException

Launches the process, returning a handle to it for IO ops, etc
the caller must read the output streams: otherwise the buffers may fill up and the remote program will be suspended indefinitely

Returns:

Throws:

java.io.IOException

start

public Execed start()
             throws java.io.IOException

Launches the process, returning a handle to it for IO ops, etc.
The finish condition for the OutputProcess is that all processes outputting to standard out must be complete before proceeding

Returns:

Throws:

java.io.IOException

startManually

@Deprecated
public java.lang.ProcessBuilder startManually()

Deprecated.

Returns a ProcessBuilder for use in a manual launching

Returns:

getProcessBuilder

public java.lang.ProcessBuilder getProcessBuilder()

Returns a ProcessBuilder for use in a manual launching

Returns:

join

protected static java.lang.String join(java.lang.String with,
                    java.lang.String... strings)

join

protected static java.lang.String join(java.lang.String with,
                    java.util.List<java.lang.String> strings)

rootUtility

public static Execed rootUtility(java.lang.String... command)
                          throws java.io.IOException

Runs a command in "utility" mode: redirecting stderr to stdout and running as root

Parameters:

as -

command -

Returns:

Throws:

java.io.IOException

rootUtility

public static Execed rootUtility(java.lang.Iterable<java.lang.String> command)
                          throws java.io.IOException

Runs a command in "utility" mode: redirecting stderr to stdout and running as root

Parameters:

as -

command -

Returns:

Throws:

java.io.IOException

utility

public static Execed utility(java.lang.String... command)
                      throws java.io.IOException

Runs a command in "utility" mode: redirecting stderr to stdout and optionally executing as a different user (eg root)

Parameters:

as -

command -

Returns:

Throws:

java.io.IOException

utility

public static Execed utility(java.lang.Iterable<java.lang.String> command)
                      throws java.io.IOException

Runs a command in "utility" mode: redirecting stderr to stdout and optionally executing as a different user (eg root)

Parameters:

as -

command -

Returns:

Throws:

java.io.IOException

utilityAs

public static Execed utilityAs(java.lang.String as,
               java.lang.String... command)
                        throws java.io.IOException

Runs a command in "utility" mode: redirecting stderr to stdout and optionally executing as a different user (eg root)

Parameters:

as -

command -

Returns:

Throws:

java.io.IOException

utilityAs

public static Execed utilityAs(java.lang.String as,
               java.lang.Iterable<java.lang.String> command)
                        throws java.io.IOException

Runs a command in "utility" mode: redirecting stderr to stdout and optionally executing as a different user (eg root)

Parameters:

as -

command -

Returns:

Throws:

java.io.IOException

appAs

public static Execed appAs(java.lang.String as,
           java.lang.String... command)
                    throws java.io.IOException

Runs a command, optionally executing as a different user (eg root)

Parameters:

as -

command -

Returns:

Throws:

java.io.IOException

appAs

public static Execed appAs(java.lang.String as,
           java.lang.Iterable<java.lang.String> command)
                    throws java.io.IOException

Runs a command, optionally executing as a different user (eg root)

Parameters:

as -

command -

Returns:

Throws:

java.io.IOException