Class GetFromSession

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 GetFromSession extends FixedForwardPipe
Gets the contents of the pipeLineSession by a key specified by sessionKey.
Johan Verrips
See Also:
  • Constructor Details

    • GetFromSession

      public GetFromSession()
  • Method Details

    • 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.
    • getSessionKey

      public String getSessionKey()
      Returns the name of the key in the pipeLineSession to retrieve the input from
    • setSessionKey

      public void setSessionKey(String sessionKey)
      Key of the session variable to retrieve the output message from. When left unspecified, the input message is used as the key of the session variable
    • setType

      public void setType(ParameterType type)
      • string: renders the contents
      • map: converts a Map<String, String> object to a xml-string (<items><item name='...'>...</item><item name='...'>...</item></items>)
      Default value
    • getType

      public ParameterType getType()