Class IncreaseIntegerPipe

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

@EnterpriseIntegrationPattern(SESSION) public class IncreaseIntegerPipe extends FixedForwardPipe
Pipe that increases the integer value of a session variable. It can be used in combination with CompareIntegerPipe to construct loops.
Author:
Richard Punt / Gerrit van Brakel
Specific parameters
increment Integer value to be added to the session variable.
  • Constructor Details

    • IncreaseIntegerPipe

      public IncreaseIntegerPipe()
  • Method Details

    • configure

      public void configure() throws ConfigurationException
      Description copied from class: FixedForwardPipe
      Checks for correct configuration of forward.
      Specified by:
      configure in interface IConfigurable
      Overrides:
      configure in class FixedForwardPipe
      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
    • consumesSessionVariable

      public boolean consumesSessionVariable(String sessionKey)
      Description copied from interface: IPipe
      returns true if the pipe or one of its children use the named session variable. Callers can use this to determine if a message needs to be preserved.
      Specified by:
      consumesSessionVariable in interface IPipe
      Overrides:
      consumesSessionVariable in class AbstractPipe
    • setSessionKey

      public void setSessionKey(String string)
      Reference to the session variable whose value is to be increased.
    • setIncrement

      public void setIncrement(int i)
      Amount to increment the value. This can be set from the attribute or the parameter 'increment'.
      Default value
      1