nl.nn.adapterframework.core

Class PipeForward

java.lang.Object

nl.nn.adapterframework.core.PipeForward

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:

PipeLine, AbstractPipe.findForward(java.lang.String)

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXCEPTION_FORWARD_NAME
static String	SUCCESS_FORWARD_NAME

Constructor Summary

Constructors

Constructor and Description
PipeForward()
PipeForward(String name, String path)

Method Summary

Modifier and Type	Method and Description
void	setName(String name) the name is a symbolic reference to a path.
void	setPath(String path) The name of the next Pipe or Exit.
String	toString() uses reflection to return the value

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

SUCCESS_FORWARD_NAME

public static final String SUCCESS_FORWARD_NAME

See Also:

Constant Field Values

EXCEPTION_FORWARD_NAME

public static final String EXCEPTION_FORWARD_NAME

See Also:

Constant Field Values

Constructor Detail

PipeForward

public PipeForward(String name,
                   String path)

PipeForward

public PipeForward()

Method Detail

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