Class PutInSession

All Implemented Interfaces:
HasTransactionAttribute, IConfigurable, IConfigurationAware, IForwardTarget, INamedObject, IPipe, IScopeProvider, IWithParameters, EventThrowing, HasStatistics, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

@ElementType(SESSION) public class PutInSession extends FixedForwardPipe
Puts the input or the value in the PipeLineSession, under the key specified by sessionKey. Additionally, stores parameter values in the PipeLineSession.
Johan Verrips
the result of each parameter defined will be we stored in the PipeLineSession, under the key specified by the parameter name
  • Constructor Details

    • PutInSession

      public PutInSession()
  • 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
      Specified by:
      configure in interface IPipe
      configure in class FixedForwardPipe
    • 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. If the result of the Pipe does not depend on the input, like for the FixedResultPipe, the Pipe can schedule the input to be closed at session exit, by calling Message.closeOnCloseOf(PipeLineSession, String) This allows the previous Pipe to release any resources (e.g. connections) that it might have kept open until the message was consumed. Doing so avoids connections leaking from pools, while it enables efficient streaming processing of data while it is being read from a stream.
    • 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
    • getSessionKey

      public String getSessionKey()
    • getValue

      public String getValue()