Name

adams.flow.source.Command

Synopsis

Runs an external system command and broadcasts the generated output (stdout and/or stderr) continuously, opposed to adams.flow.source.Exec which waits for the command to finish.

Additional information

Flow input/output:
- output: java.lang.String

See also

• adams.flow.source.Exec

Options

• loggingLevel
  

  The logging level for outputting errors and debugging output.

  command-line	-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST>
  default	WARNING
  min-user-mode	Expert

  
  
• name
  

  The name of the actor.

  command-line	-name <java.lang.String>
  default	Command

  
  
• annotations
  

  The annotations to attach to this actor.

  command-line	-annotation <adams.core.base.BaseAnnotation>
  default

  
  
• skip
  

  If set to true, transformation is skipped and the input token is just forwarded as it is.

  command-line	-skip <boolean>
  default	false

  
  
• stopFlowOnError
  

  If set to true, the flow execution at this level gets stopped in case this actor encounters an error; the error gets propagated; useful for critical actors.

  command-line	-stop-flow-on-error <boolean>
  default	false
  min-user-mode	Expert

  
  
• silent
  

  If enabled, then no errors are output in the console; Note: the enclosing actor handler must have this enabled as well.

  command-line	-silent <boolean>
  default	false
  min-user-mode	Expert

  
  
• command
  

  The external command to run.

  command-line	-cmd <adams.core.base.BaseText>
  default	ls -l .

  
  
• workingDirectory
  

  The current working directory for the command.

  command-line	-working-directory <java.lang.String>
  default

  
  
• envVars
  

  The environment variables to overlay on top of the current ones.

  command-line	-env-var <adams.core.base.BaseKeyValuePair> [-env-var ...]
  default

  
  
• commandContainsPlaceholder
  

  Set this to true to enable automatic placeholder expansion for the command string.

  command-line	-placeholder <boolean>
  default	false

  
  
• commandContainsVariable
  

  Set this to true to enable automatic variable expansion for the command string.

  command-line	-variable <boolean>
  default	false

  
  
• outputType
  

  Determines the output type; if BOTH is selected then an array is output with stdout as first element and stderr as second

  command-line	-output-type <STDOUT|STDERR|BOTH>
  default	STDOUT

  
  
• prefixStdOut
  

  The (optional) prefix to use for output from stdout.

  command-line	-prefix-stdout <java.lang.String>
  default

  
  
• prefixStdErr
  

  The (optional) prefix to use for output from stderr.

  command-line	-prefix-stderr <java.lang.String>
  default

  
  
• timeOut
  

  The maximum time in seconds for the process to run before getting killed, ignored if less than 1.

  command-line	-time-out <int>
  default	-1
  minimum	-1