Name

adams.flow.control.Flow

Synopsis

Container object for actors, used for executing a flow.

Additional information

Flow input/output:
-standalone-
Actor handler information:
- Actor execution: SEQUENTIAL
- Standalones allowed: true
- Source allowed: true
- Forwards input: false
Stop restriction: always

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	Flow

  
  
• 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

  
  
• finishBeforeStopping
  

  If enabled, actor first finishes processing all data before stopping.

  command-line	-finish-before-stopping <boolean>
  default	false

  
  
• stoppingTimeout
  

  The timeout in milliseconds when waiting for actors to finish (<= 0 for infinity; see 'finishBeforeStopping').

  command-line	-stopping-timeout <int>
  default	-1
  minimum	-1

  
  
• stoppingWarningInterval
  

  The interval in milliseconds to output logging warnings if the actors haven't stopped yet (and no stopping timeout set); no warning if <= 0.

  command-line	-stopping-warning-interval <int>
  default	10000
  minimum	-1

  
  
• actors
  

  All the actors that define this flow.

  command-line	-actor <adams.flow.core.Actor> [-actor ...]
  default

  
  
• readOnly
  

  If set to true, the flow is marked as read-only and the user gets prompted whether to proceed before allowing it to be edited.

  command-line	-read-only <boolean>
  default	false

  
  
• errorHandling
  

  Defines how errors are handled that occur during execution of the flow; ACTORS_DECIDE_TO_STOP_ON_ERROR stops the flow only if the actor has the 'stopFlowOnError' flag set.

  command-line	-error-handling <ACTORS_ALWAYS_STOP_ON_ERROR|ACTORS_DECIDE_TO_STOP_ON_ERROR>
  default	ACTORS_ALWAYS_STOP_ON_ERROR

  
  
• logErrors
  

  If set to true, errors are logged and can be retrieved after execution.

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

  
  
• executeOnError
  

  The external flow to execute in case the flow finishes with an error; allows the user to call a clean-up flow.

  command-line	-execute-on-error <adams.core.io.FlowFile>
  default	${CWD}
  min-user-mode	Expert

  
  
• executeOnFinish
  

  The external flow to execute in case the flow finishes normal, without any errors.

  command-line	-execute-on-finish <adams.core.io.FlowFile>
  default	${CWD}
  min-user-mode	Expert

  
  
• flowExecutionListeningEnabled
  

  Enables/disables the flow execution listener.

  command-line	-flow-execution-listening-enabled <boolean>
  default	false
  min-user-mode	Expert

  
  
• flowExecutionListener
  

  The listener for the flow execution; must be enabled explicitly.

  command-line	-flow-execution-listener <adams.flow.execution.FlowExecutionListener>
  default	adams.flow.execution.NullListener
  min-user-mode	Expert

  
  
• flowRestartManager
  

  The manager for restarting the flow.

  command-line	-flow-restart-manager <adams.flow.control.flowrestart.AbstractFlowRestartManager>
  default	adams.flow.control.flowrestart.NullManager
  min-user-mode	Expert