Field Detail

• PROP_LOGIN_SHELL

  public static final ConfigKey<java.lang.Boolean> PROP_LOGIN_SHELL

• PROP_DIRECTORY

  public static final ConfigKey<java.lang.String> PROP_DIRECTORY

Constructor Detail

• ProcessTool

  public ProcessTool()

• ProcessTool

  public ProcessTool(java.util.Map<java.lang.String,?> flags)

Method Detail

• execScript

  public int execScript(java.util.Map<java.lang.String,?> props,
               java.util.List<java.lang.String> commands,
               java.util.Map<java.lang.String,?> env)

  Description copied from interface: ShellTool
  Executes the set of commands in a shell script. Blocks until completion.

  Optional properties are the same common ones as for ShellTool.execCommands(Map, List, Map) with the addition of:

  • ShellTool.PROP_RUN_AS_ROOT
  • ShellTool.PROP_SCRIPT_DIR

  Specified by:

  execScript in interface ShellTool

  Returns:

  exit status of script

• execCommands

  public int execCommands(java.util.Map<java.lang.String,?> props,
                 java.util.List<java.lang.String> commands,
                 java.util.Map<java.lang.String,?> env)

  Description copied from interface: ShellTool
  Executes the set of commands using ssh exec. This is generally more efficient than ssh shell mode (cf ShellTool.execScript(Map, List, Map)), but is not suitable if you need env values which are only set on a fully-fledged shell, or if you want the entire block executed with root permission. Common optional properties (which also apply to ShellTool.execScript(Map, List, Map)) are:

  • ShellTool.PROP_OUT_STREAM
  • ShellTool.PROP_ERR_STREAM
  • ShellTool.PROP_SEPARATOR (for some modes)
  • ShellTool.PROP_NO_EXTRA_OUTPUT (often there is no extra output here)

  Note that ShellTool.PROP_RUN_AS_ROOT is not typically supported here. Prefer ShellTool.execScript(Map, List, Map)).

  Specified by:

  execCommands in interface ShellTool

  Returns:

  exit status of commands

• execProcesses

  @Deprecated
  public static int execProcesses(java.util.List<java.lang.String> cmds,
                             java.util.Map<java.lang.String,?> env,
                             java.io.OutputStream out,
                             java.io.OutputStream err,
                             java.lang.String separator,
                             java.lang.Object contextForLogging)

  Deprecated. since 0.7; use execProcesses(List, Map, File, OutputStream, OutputStream, String, boolean, Object)
  as execProcesses(List, Map, OutputStream, OutputStream, String, boolean, Object) but not using a login shell

• execProcesses

  @Deprecated
  public static int execProcesses(java.util.List<java.lang.String> cmds,
                             java.util.Map<java.lang.String,?> env,
                             java.io.OutputStream out,
                             java.io.OutputStream err,
                             java.lang.String separator,
                             boolean asLoginShell,
                             java.lang.Object contextForLogging)

  Deprecated. since 0.7; use execProcesses(List, Map, File, OutputStream, OutputStream, String, boolean, Object)

• execProcesses

  public static int execProcesses(java.util.List<java.lang.String> cmds,
                  java.util.Map<java.lang.String,?> env,
                  java.io.File directory,
                  java.io.OutputStream out,
                  java.io.OutputStream err,
                  java.lang.String separator,
                  boolean asLoginShell,
                  java.lang.Object contextForLogging)

  executes a set of commands by sending them as a single process to `bash -c` (single command argument of all the commands, joined with separator)

  consequence of this is that you should not normally need to escape things oddly in your commands, type them just as you would into a bash shell (if you find exceptions please note them here!)

• execSingleProcess

  @Deprecated
  public static int execSingleProcess(java.util.List<java.lang.String> cmdWords,
                                 java.util.Map<java.lang.String,?> env,
                                 java.io.OutputStream out,
                                 java.io.OutputStream err,
                                 java.lang.Object contextForLogging)

  Deprecated. since 0.7; use execSingleProcess(List, Map, File, OutputStream, OutputStream, Object)

• execSingleProcess

  public static int execSingleProcess(java.util.List<java.lang.String> cmdWords,
                      java.util.Map<java.lang.String,?> env,
                      java.io.File directory,
                      java.io.OutputStream out,
                      java.io.OutputStream err,
                      java.lang.Object contextForLogging)

  executes a single process made up of the given command words (*not* bash escaped); should be portable across OS's