Field Detail

• PROP_LOCAL_TEMP_DIR

  static final ConfigKey<java.lang.String> PROP_LOCAL_TEMP_DIR

• PROP_RUN_AS_ROOT

  static final ConfigKey<java.lang.Boolean> PROP_RUN_AS_ROOT

• PROP_OUT_STREAM

  static final ConfigKey<java.io.OutputStream> PROP_OUT_STREAM

• PROP_ERR_STREAM

  static final ConfigKey<java.io.OutputStream> PROP_ERR_STREAM

• PROP_NO_EXTRA_OUTPUT

  static final ConfigKey<java.lang.Boolean> PROP_NO_EXTRA_OUTPUT

• PROP_SEPARATOR

  static final ConfigKey<java.lang.String> PROP_SEPARATOR

• PROP_SCRIPT_DIR

  static final ConfigKey<java.lang.String> PROP_SCRIPT_DIR

• PROP_SCRIPT_HEADER

  static final ConfigKey<java.lang.String> PROP_SCRIPT_HEADER

• PROP_DIRECT_HEADER

  static final ConfigKey<java.lang.String> PROP_DIRECT_HEADER

• PROP_NO_DELETE_SCRIPT

  static final ConfigKey<java.lang.Boolean> PROP_NO_DELETE_SCRIPT

• PROP_SUMMARY

  static final ConfigKey<java.lang.String> PROP_SUMMARY

• PROP_EXEC_TIMEOUT

  static final ConfigKey<Duration> PROP_EXEC_TIMEOUT

• PROP_EXEC_ASYNC

  static final ConfigKey<java.lang.Boolean> PROP_EXEC_ASYNC

• PROP_EXEC_ASYNC_POLLING_TIMEOUT

  static final ConfigKey<Duration> PROP_EXEC_ASYNC_POLLING_TIMEOUT

Method Detail

• execScript

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

  Executes the set of commands in a shell script. Blocks until completion.

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

  • PROP_RUN_AS_ROOT
  • PROP_SCRIPT_DIR

  Returns:

  exit status of script

• execScript

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

  See Also:

  execScript(Map, List, Map)

• execCommands

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

  Executes the set of commands using ssh exec. This is generally more efficient than ssh shell mode (cf 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 execScript(Map, List, Map)) are:

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

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

  Returns:

  exit status of commands

• execCommands

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

  See Also:

  execCommands(Map, List, Map)