Class PutInSessionPipe

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 PutInSessionPipe extends FixedForwardPipe
Puts the input or the value in the PipeLineSession, under the key specified by sessionKey. Additionally, stores parameter values in the PipeLineSession.
Author:
Johan Verrips
Parameters
the result of each parameter defined will be we stored in the PipeLineSession, under the key specified by the parameter name
  • Constructor Details

    • PutInSessionPipe

      public PutInSessionPipe()
  • 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
    • setSessionKey

      public void setSessionKey(String newSessionKey)
      Key of the session variable to store the input in
    • setValue

      public void setValue(String value)
      Value to store in the pipeLineSession. If not set, the input of the pipe is stored