Package org.frankframework.pipes

Class ForPipe

java.lang.Object
org.frankframework.core.TransactionAttributes
org.frankframework.pipes.AbstractPipe
org.frankframework.pipes.ForPipe
All Implemented Interfaces:
FrankElement, HasApplicationContext, HasName, HasTransactionAttribute, IConfigurable, IForwardTarget, IPipe, IScopeProvider, IWithParameters, NameAware, EventThrowing, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle
@Forward(name="stop",description="exit for loop") @Forward(name="continue",description="continue in for loop") @EnterpriseIntegrationPattern(ITERATOR) public class ForPipe extends AbstractPipe
ForPipe is a wrapper to use another pipe a fixed number of times. This can be accomplished by something like: 

 		<ForPipe name="forPipe" startAt="0" stopAt="10">
 		 	<Forward name="stop" path="EXIT" />
 		 	<Forward name="continue" path="echoPipe"/>
 		</ForPipe>

 		<EchoPipe name="echoPipe" getInputFromSessionKey="forPipe.iteration">
 		 	<Forward name="success" path="forPipe"/>
 		</EchoPipe>

This should call the echoPipe for i=0 until i=10.

Author:
evandongen

  • Constructor Details

    • ForPipe

      public ForPipe()

  • Method Details

    • configure

      public void configure() throws ConfigurationException
      Description copied from class: AbstractPipe
      configure() is called after the Pipeline is registered at the Adapter. The purpose of this method is to reduce creating connections to databases, etc. in the doPipe() method. As much as possible, class instantiation should take place in the configure() method to improve performance.
      Specified by:
      configure in interface IConfigurable
      Overrides:
      configure in class AbstractPipe
      Throws:
      ConfigurationException - in case it was not able to configure the component.

    • doPipe

      public PipeRunResult doPipe(Message message, PipeLineSession session) throws PipeRunException
      Description copied from interface: IPipe
      This is where the action takes place. Pipes may only throw a PipeRunException, to be handled by the caller of this object. Implementations must either consume the message, or pass it on to the next Pipe in the PipeRunResult.
      Throws:
      PipeRunException

    • setStartAt

      public void setStartAt(int startAt)
      Starts counting at this value.
      Default value
      0

    • setStopAt

      public void setStopAt(Integer stopAt)
      Break from the loop when incrementSessionKey equals this value.