Package adams.flow.source

Class Exec

  • All Implemented Interfaces:
    AdditionalInformationHandler, ClassCrossReference, CleanUpHandler, CrossReference, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, EnvironmentVariablesHandler, WorkingDirectoryHandler, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, OutputProducer, Serializable, Comparable
    public class Exec
extends AbstractSource
implements ClassCrossReference, EnvironmentVariablesHandler, WorkingDirectoryHandler
    Runs an external system command and broadcasts the generated output (stdout or stderr).

    See also:
    adams.flow.source.Exec

    Input/output:
    - generates:
       java.lang.String


    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: Exec
 
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
    The annotations to attach to this actor.
    default: 
 
    -skip <boolean> (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded 
    as it is.
    default: false
 
    -stop-flow-on-error <boolean> (property: 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.
    default: false
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console; Note: the enclosing 
    actor handler must have this enabled as well.
    default: false
 
    -cmd <adams.core.base.BaseText> (property: command)
    The external command to run.
    default: ls -l .
 
    -working-directory <java.lang.String> (property: workingDirectory)
    The current working directory for the command.
    default: 
 
    -env-var <adams.core.base.BaseKeyValuePair> [-env-var ...] (property: envVars)
    The environment variables to overlay on top of the current ones.
    default:
 
    -placeholder <boolean> (property: commandContainsPlaceholder)
    Set this to true to enable automatic placeholder expansion for the command 
    string.
    default: false
 
    -variable <boolean> (property: commandContainsVariable)
    Set this to true to enable automatic variable expansion for the command 
    string.
    default: false
 
    -output-type <STDOUT|STDERR|BOTH> (property: outputType)
    Determines the output type; if BOTH is selected then an array is output 
    with stdout as first element and stderr as second
    default: STDOUT
 
    -split-output <boolean> (property: splitOutput)
    If set to true, then the output gets split on newline; does not apply when 
    outputting stdout and stderr together.
    default: false
 
    -conversion <adams.data.conversion.ConversionFromString> (property: conversion)
    The conversion scheme to apply to the output; does not apply when outputting 
    stdout and stderr together.
    default: adams.data.conversion.StringToString
 
    -fail-on-process-error <boolean> (property: failOnProcessError)
    If enabled, the actor will fail as well if the process failed.
    default: true
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Command

        protected BaseText m_Command
        the command to run.

      • m_WorkingDirectory

        protected String m_WorkingDirectory
        the current working directory.

      • m_CommandContainsPlaceholder

        protected boolean m_CommandContainsPlaceholder
        whether the replace string contains a placeholder, which needs to be expanded first.

      • m_CommandContainsVariable

        protected boolean m_CommandContainsVariable
        whether the replace string contains a variable, which needs to be expanded first.

      • m_OutputType

        protected Exec.OutputType m_OutputType
        whether to output stderr instead of stdout.

      • m_SplitOutput

        protected boolean m_SplitOutput
        whether to split the string output on the new line before converting.

      • m_Conversion

        protected ConversionFromString m_Conversion
        the conversion scheme to process the output with.

      • m_Output

        protected List m_Output
        the tokens to forward.

      • m_FailOnProcessError

        protected boolean m_FailOnProcessError
        whether to fail on process error.

      • m_ProcessOutput

        protected transient com.github.fracpete.processoutput4j.output.CollectingProcessOutput m_ProcessOutput
        for executing the command and collecting stdout/err output.

    • Constructor Detail

      • Exec

        public Exec()

    • Method Detail

      • reset

        protected void reset()
        Resets the scheme.
        Overrides:
        reset in class AbstractActor

      • setCommand

        public void setCommand​(BaseText value)
        Sets the command to run.
        Parameters:
        value - the command

      • getCommand

        public BaseText getCommand()
        Returns the command to run.
        Returns:
        the command

      • commandTipText

        public String commandTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setWorkingDirectory

        public void setWorkingDirectory​(String value)
        Sets the current working directory for the command.
        Specified by:
        setWorkingDirectory in interface WorkingDirectoryHandler
        Parameters:
        value - the directory, ignored if empty

      • workingDirectoryTipText

        public String workingDirectoryTipText()
        Returns the tip text for this property.
        Specified by:
        workingDirectoryTipText in interface WorkingDirectoryHandler
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • envVarsTipText

        public String envVarsTipText()
        Returns the tip text for this property.
        Specified by:
        envVarsTipText in interface EnvironmentVariablesHandler
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setCommandContainsPlaceholder

        public void setCommandContainsPlaceholder​(boolean value)
        Sets whether the command string contains a placeholder which needs to be expanded first.
        Parameters:
        value - true if command string contains a placeholder

      • getCommandContainsPlaceholder

        public boolean getCommandContainsPlaceholder()
        Returns whether the command string contains a placeholder which needs to be expanded first.
        Returns:
        true if command string contains a placeholder

      • commandContainsPlaceholderTipText

        public String commandContainsPlaceholderTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setCommandContainsVariable

        public void setCommandContainsVariable​(boolean value)
        Sets whether the command string contains a variable which needs to be expanded first.
        Parameters:
        value - true if command string contains a variable

      • getCommandContainsVariable

        public boolean getCommandContainsVariable()
        Returns whether the command string contains a variable which needs to be expanded first.
        Returns:
        true if command string contains a variable

      • commandContainsVariableTipText

        public String commandContainsVariableTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setOutputType

        public void setOutputType​(Exec.OutputType value)
        Sets what output from the process to forward.
        Parameters:
        value - the output type

      • getOutputType

        public Exec.OutputType getOutputType()
        Returns what output from the process to forward.
        Returns:
        the output type

      • outputTypeTipText

        public String outputTypeTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setSplitOutput

        public void setSplitOutput​(boolean value)
        Sets whether to split the output on the newline or crlf.
        Parameters:
        value - if true then output is split

      • getSplitOutput

        public boolean getSplitOutput()
        Returns whether to split the output on newline or crlf.
        Returns:
        true if output is split

      • splitOutputTipText

        public String splitOutputTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setConversion

        public void setConversion​(ConversionFromString value)
        Sets the conversion to apply to the output.
        Parameters:
        value - the conversion

      • getConversion

        public ConversionFromString getConversion()
        Returns the conversion to apply to the output.
        Returns:
        the conversion

      • conversionTipText

        public String conversionTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setFailOnProcessError

        public void setFailOnProcessError​(boolean value)
        Sets whether to fail as well if the process failed.
        Parameters:
        value - true if to fail as well

      • getFailOnProcessError

        public boolean getFailOnProcessError()
        Returns whether to fail as well if the process failed.
        Returns:
        true if to fail as well

      • failOnProcessErrorTipText

        public String failOnProcessErrorTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Specified by:
        generates in interface OutputProducer
        Returns:
        java.lang.String.class

      • doExecute

        protected String doExecute()
        Executes the flow item.
        Specified by:
        doExecute in class AbstractActor
        Returns:
        null if everything is fine, otherwise error message

      • output

        public Token output()
        Returns the generated token.
        Specified by:
        output in interface OutputProducer
        Returns:
        the generated token

      • hasPendingOutput

        public boolean hasPendingOutput()
        Checks whether there is pending output to be collected after executing the flow item.
        Specified by:
        hasPendingOutput in interface OutputProducer
        Returns:
        true if there is pending output