Class RemoveFromSession

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 RemoveFromSession extends FixedForwardPipe
Removes a key specified by sessionKey from the pipeLineSession.
Peter Leeuwenburgh
See Also:
  • Constructor Details

    • RemoveFromSession

      public RemoveFromSession()
  • Method Details

    • configure

      public void configure() throws ConfigurationException
      Checks whether the proper forward is defined.
      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)
      name of the key of the entry in the pipelinesession to remove. if this key is empty the input message is interpretted as key. for multiple keys use ',' as delimiter
    • getSessionKey

      public String getSessionKey()