Exec (stdlib 5.1.2 API)

java.lang.Object
- com.peterphi.std.system.exec.Exec

```
public class Exec
extends Object
```
An abstraction over ProcessBuilder to simplify the creation of processes

Field Summary

Fields
Modifier and Type Field and Description

protected List<String> cmd

Fields
Modifier and Type	Field and Description
`protected List<String>`	`cmd`

Constructor Summary

Constructors
Constructor and Description

Exec(Iterable<String> command)

Exec(String... command)

Constructors
Constructor and Description
`Exec(Iterable<String> command)`
`Exec(String... command)`

Method Summary

Methods
Modifier and Type	Method and Description
`static Execed`	`appAs(String as, Iterable<String> command)` Runs a command, optionally executing as a different user (eg root)
`static Execed`	`appAs(String as, String... command)` Runs a command, optionally executing as a different user (eg root)
`String`	`getEnv(String key)`
`ProcessBuilder`	`getProcessBuilder()` Returns a ProcessBuilder for use in a manual launching
`boolean`	`getRedirectError()`
`File`	`getWorkingDirectory()`
`protected static String`	`join(String with, List<String> strings)`
`protected static String`	`join(String with, String... strings)`
`static Execed`	`rootUtility(Iterable<String> command)` Runs a command in "utility" mode: redirecting stderr to stdout and running as root
`static Execed`	`rootUtility(String... command)` Runs a command in "utility" mode: redirecting stderr to stdout and running as root
`Exec`	`runAs(String username)`
`Exec`	`runAsSuperuser()`
`Exec`	`setEnv(String key, String value)`
`Exec`	`setRedirectError(boolean value)`
`Exec`	`setWorkingDirectory(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
`ProcessBuilder`	`startManually()` Deprecated.
`static Execed`	`utility(Iterable<String> command)` Runs a command in "utility" mode: redirecting stderr to stdout and optionally executing as a different user (eg root)
`static Execed`	`utility(String... command)` Runs a command in "utility" mode: redirecting stderr to stdout and optionally executing as a different user (eg root)
`static Execed`	`utilityAs(String as, Iterable<String> command)` Runs a command in "utility" mode: redirecting stderr to stdout and optionally executing as a different user (eg root)
`static Execed`	`utilityAs(String as, 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 List<String> cmd
```
- Constructor Detail
  - Exec
```
public Exec(String... command)
```
  - Exec
```
public Exec(Iterable<String> command)
```
- Method Detail
  - getWorkingDirectory
```
public File getWorkingDirectory()
```
  - setWorkingDirectory
```
public Exec setWorkingDirectory(File dir)
```
  - setEnv
```
public Exec setEnv(String key,
          String value)
```
  - getEnv
```
public String getEnv(String key)
```
  - runAsSuperuser
```
public Exec runAsSuperuser()
```
  - runAs
```
public Exec runAs(String username)
```
  - getRedirectError
```
public boolean getRedirectError()
```
  - setRedirectError
```
public Exec setRedirectError(boolean value)
```
  - startBasic
```
public BaseExeced startBasic()
                      throws 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:
    
    IOException
  - start
```
public Execed start()
             throws 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:
    
    IOException
  - startManually
```
@Deprecated
public ProcessBuilder startManually()
```
    Deprecated.
    
    Returns a ProcessBuilder for use in a manual launching
    
    Returns:
  - getProcessBuilder
```
public ProcessBuilder getProcessBuilder()
```
    Returns a ProcessBuilder for use in a manual launching
    
    Returns:
  - join
```
protected static String join(String with,
          String... strings)
```
  - join
```
protected static String join(String with,
          List<String> strings)
```
  - rootUtility
```
public static Execed rootUtility(String... command)
                          throws IOException
```
    Runs a command in "utility" mode: redirecting stderr to stdout and running as root
    
    Parameters:
    as -
    command -
    
    Returns:
    
    Throws:
    
    IOException
  - rootUtility
```
public static Execed rootUtility(Iterable<String> command)
                          throws IOException
```
    Runs a command in "utility" mode: redirecting stderr to stdout and running as root
    
    Parameters:
    as -
    command -
    
    Returns:
    
    Throws:
    
    IOException
  - utility
```
public static Execed utility(String... command)
                      throws 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:
    
    IOException
  - utility
```
public static Execed utility(Iterable<String> command)
                      throws 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:
    
    IOException
  - utilityAs
```
public static Execed utilityAs(String as,
               String... command)
                        throws 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:
    
    IOException
  - utilityAs
```
public static Execed utilityAs(String as,
               Iterable<String> command)
                        throws 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:
    
    IOException
  - appAs
```
public static Execed appAs(String as,
           String... command)
                    throws IOException
```
    Runs a command, optionally executing as a different user (eg root)
    
    Parameters:
    as -
    command -
    
    Returns:
    
    Throws:
    
    IOException
  - appAs
```
public static Execed appAs(String as,
           Iterable<String> command)
                    throws IOException
```
    Runs a command, optionally executing as a different user (eg root)
    
    Parameters:
    as -
    command -
    
    Returns:
    
    Throws:
    
    IOException

Class Exec

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

cmd

Constructor Detail

Exec

Exec

Method Detail

getWorkingDirectory

setWorkingDirectory

setEnv

getEnv

runAsSuperuser

runAs

getRedirectError

setRedirectError

startBasic

start

startManually

getProcessBuilder

join

join

rootUtility

rootUtility

utility

utility

utilityAs

utilityAs

appAs

appAs