Package adams.flow.control

Class RemoteExecutionTrigger

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, Pausable, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, FlowPauseStateListener, VariableChangeListener, AtomicExecution, Actor, ActorHandler, ControlActor, ErrorHandler, Flushable, InputConsumer, MutableActorHandler, OutputProducer, RemoteExecutionHandler, SubFlowWrapUp, RemoteCommandProcessorHandler, Serializable, Comparable
    public class RemoteExecutionTrigger
extends AbstractTee
implements RemoteExecutionHandler, RemoteCommandProcessorHandler
    Transfers the actors below itself, the specified storage items and variables using the specified connection for remote execution.
    Uses the adams.scripting.command.flow.RemoteFlowExecution remote command behind the scenes.

    Input/output:
    - accepts:
       adams.flow.core.Unknown
    - generates:
       adams.flow.core.Unknown


    -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: TriggerRemoteExecution
 
    -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 gets stopped in case this actor encounters an error;
     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
 
    -finish-before-stopping <boolean> (property: finishBeforeStopping)
    If enabled, actor first finishes processing all data before stopping.
    default: false
 
    -asynchronous <boolean> (property: asynchronous)
    If enabled, the sub-actors get executed asynchronously rather than the flow 
    waiting for them to finish before proceeding with execution.
    default: false
 
    -tee <adams.flow.core.Actor> [-tee ...] (property: actors)
    The actors to siphon-off the tokens to.
    default: 
 
    -storage-name <adams.flow.control.StorageName> [-storage-name ...] (property: storageNames)
    The (optional) storage items to transfer.
    default: 
 
    -variable-name <adams.core.VariableName> [-variable-name ...] (property: variableNames)
    The (optional) variables to transfer.
    default: 
 
    -connection <adams.scripting.connection.Connection> (property: connection)
    Defines how to send the flow for remote execution.
    default: adams.scripting.connection.DefaultConnection
    Version:
    $Revision$
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_StorageNames

        protected StorageName[] m_StorageNames
        the storage items to transmit.

      • m_VariableNames

        protected VariableName[] m_VariableNames
        the variables to transmit.

      • m_Connection

        protected Connection m_Connection
        where to send the flow to.

    • Constructor Detail

      • RemoteExecutionTrigger

        public RemoteExecutionTrigger()

    • Method Detail

      • initialize

        protected void initialize()
        Initializes the members.
        Overrides:
        initialize in class AbstractTee

      • storageNamesTipText

        public String storageNamesTipText()
        Returns the tip text for this property.
        Specified by:
        storageNamesTipText in interface RemoteExecutionHandler
        Returns:
        tip text for this property suitable for displaying in the gui

      • variableNamesTipText

        public String variableNamesTipText()
        Returns the tip text for this property.
        Specified by:
        variableNamesTipText in interface RemoteExecutionHandler
        Returns:
        tip text for this property suitable for displaying in the gui

      • connectionTipText

        public String connectionTipText()
        Returns the tip text for this property.
        Specified by:
        connectionTipText in interface RemoteExecutionHandler
        Returns:
        tip text for this property suitable for displaying in the gui

      • commandProcessorTipText

        public String commandProcessorTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the gui

      • setUpTeeActors

        protected String setUpTeeActors()
        Gets called in the setUp() method. Returns null if tee-actors are fine, otherwise error message.
        Specified by:
        setUpTeeActors in class AbstractTee
        Returns:
        always null

      • canContainStandalones

        public boolean canContainStandalones()
        Returns whether singletons are allowed in this group or not.
        Returns:
        true if singletons are allowed

      • checkTeeActor

        protected String checkTeeActor​(int index,
                               Actor actor)
        Checks the tee actor before it is set. Returns an error message if the actor is not acceptable, null otherwise.
        Specified by:
        checkTeeActor in class AbstractTee
        Parameters:
        index - the index the actor gets set
        actor - the actor to check
        Returns:
        always null

      • checkTeeActors

        protected String checkTeeActors​(Actor[] actors)
        Checks the tee actors before they are set via the setTeeActors method. Returns an error message if the actors are not acceptable, null otherwise.
        Specified by:
        checkTeeActors in class AbstractTee
        Parameters:
        actors - the actors to check
        Returns:
        null if checks passed or null in case of an error

      • processInput

        protected String processInput​(Token token)
        Processes the token.
        Overrides:
        processInput in class AbstractTee
        Parameters:
        token - ignored
        Returns:
        an optional error message, null if everything OK