Package org.frankframework.core

Class PipeForward

java.lang.Object
org.frankframework.core.PipeForward
@FrankDocGroup(OTHER) public class PipeForward extends Object
Appears inside a pipe and defines what pipe or exit to execute next. When the execution of a pipe is done, the pipe looks up the next pipe or exit to execute. This pipe or exit is searched based on a key that describes what happened during pipe execution. For example a FixedResultPipe searches for key filenotfound if it tried to read a file that did not exist, preventing it from producing the desired output message. If there was no error, the FixedResultPipe searches for key success.

Each <Forward> tag is used to link a search key (name attribute) to a pipe or exit to execute next (path attribute). The forward's path attribute references the target pipe or exit by its name attribute, see AbstractPipe and PipeLineExit. For most pipes and most keys, the next pipe is executed if no forward is found. By default, the pipes in a pipeline are executed consecutively.
Author:
Johan Verrips
See Also:

  • Field Details

  • Constructor Details

    • PipeForward

      public PipeForward(String name, String path)

    • PipeForward

      public PipeForward()

  • Method Details

    • setName

      @Mandatory public void setName(String name)
      the name is a symbolic reference to a path.

    • setPath

      @Mandatory public void setPath(String path)
      The name of the next Pipe or Exit. When the Pipeline doesn't have an Exits element configured it will be initialized with one Exit having name READY and state SUCCESS

    • toString

      public String toString()
      uses reflection to return the value
      Overrides:
      toString in class Object

    • getName

      public String getName()

    • getPath

      public String getPath()