Package org.frankframework.core

Class PipeLineSession

java.lang.Object
java.util.AbstractMap<String,Object>
java.util.HashMap<String,Object>
org.frankframework.core.PipeLineSession
All Implemented Interfaces:
Serializable, AutoCloseable, Cloneable, Map<String,Object>
public class PipeLineSession extends HashMap<String,Object> implements AutoCloseable
Basic implementation of PipeLineSession.
Since:
version 3.2.2
Author:
Johan Verrips IOS
See Also:

  • Field Details

  • Constructor Details

    • PipeLineSession

      public PipeLineSession()

    • PipeLineSession

      public PipeLineSession(@Nonnull Map<String,Object> t)
      Create new PipeLineSession from existing map or session. This may not be null!
      Parameters:
      t - Map or PipeLineSession from which to copy session variables into the new session. Should not be null!

  • Method Details

    • setExitState

      public void setExitState(PipeLine.ExitState state, Integer code)

    • setExitState

      public void setExitState(PipeLineResult pipeLineResult)

    • mergeToParentSession

      public void mergeToParentSession(String keysToCopy, PipeLineSession parentSession)
      Copy specified keys from the from PipeLineSession to the parent PipeLineSession or Map to. Any keys present in both parent and child session will be unregistered from closing on the closing of the child session.

      The keys which will be copied are specified in parameter keysToCopy. Keys names are separated by , or ; symbols. If that parameter is null then all keys will be copied, if it is an empty string then no keys will be copied.

      Parameters:
      keysToCopy - Keys to be copied, separated by , or ;. If null then all keys will be copied. If an empty string then no keys will be copied.
      parentSession - Parent PipeLineSession.

    • put

      public Object put(String key, Object value)
      Specified by:
      put in interface Map<String,Object>
      Overrides:
      put in class HashMap<String,Object>

    • putAll

      public void putAll(Map<? extends String,?> m)
      Specified by:
      putAll in interface Map<String,Object>
      Overrides:
      putAll in class HashMap<String,Object>

    • getMessageId

      @Nullable public String getMessageId()

    • getCorrelationId

      @Nullable public String getCorrelationId()

    • getMessage

      @Nonnull public Message getMessage(String key)
      Retrieves the value associated with the specified key and returns it as a Message object. If the key does not exist or the value is null, it returns a null message.

      NB: If the underlying value was a stream, reading the message will read the underlying stream. The value can be preserved in the message, but the underlying stream can not be preserved and reading the same session key again will effectively return an empty value.

      Parameters:
      key - The key for which to retrieve the value.
      Returns:
      The value associated with the key encapsulated in a Message object. If the key does not exist or the value is null, a null message is returned.

    • getTsReceived

      public Instant getTsReceived()

    • getTsReceived

      public static Instant getTsReceived(Map<String,Object> context)

    • getTsSent

      public Instant getTsSent()

    • getTsSent

      public static Instant getTsSent(Map<String,Object> context)

    • updateListenerParameters

      public static void updateListenerParameters(@Nonnull Map<String,Object> map, @Nullable String messageId, @Nullable String correlationId)
      Convenience method to set required parameters from listeners. Will not update messageId and correlationId when NULL. Sets the current date-time as TS-Received.

    • updateListenerParameters

      public static void updateListenerParameters(@Nonnull Map<String,Object> map, @Nullable String messageId, @Nullable String correlationId, @Nullable Instant tsReceived, @Nullable Instant tsSent)
      Convenience method to set required parameters from listeners. Will not update messageId and correlationId when NULL. Will use current date-time for TS-Received if null.

    • setSecurityHandler

      public void setSecurityHandler(ISecurityHandler handler)

    • getSecurityHandler

      @Nonnull public ISecurityHandler getSecurityHandler() throws org.apache.commons.lang3.NotImplementedException
      Throws:
      org.apache.commons.lang3.NotImplementedException

    • getString

      @Nullable public String getString(@Nonnull String key)
      Get value of a PipeLineSession key as String.

      NB: If the value was a stream, the stream is read and closed. If the value was another kind of AutoCloseable, then a side effect of this method may also be the value was closed.

      Parameters:
      key - Session key to get.
      Returns:
      Value of the session key as String, or NULL of either the key was not present or had a NULL value.

    • get

      @Nullable public String get(@Nonnull String key, @Nullable String defaultValue)
      Retrieves a String value from the PipeLineSession
      Parameters:
      key - the referenced key
      defaultValue - the value to return when the key cannot be found
      Returns:
      String

    • get

      public boolean get(String key, boolean defaultValue)
      Retrieves a boolean value from the PipeLineSession
      Parameters:
      key - the referenced key
      defaultValue - the value to return when the key cannot be found
      Returns:
      boolean

    • getBoolean

      @Nullable public Boolean getBoolean(String key)
      Retrieves a Boolean value from the PipeLineSession
      Parameters:
      key - the referenced key
      Returns:
      Boolean

    • get

      public int get(String key, int defaultValue)
      Retrieves an int value from the PipeLineSession
      Parameters:
      key - the referenced key
      defaultValue - the value to return when the key cannot be found
      Returns:
      int

    • getInteger

      @Nullable public Integer getInteger(String key)
      Retrieves an Integer value from the PipeLineSession
      Parameters:
      key - the referenced key
      Returns:
      Integer

    • get

      public long get(String key, long defaultValue)
      Retrieves a long value from the PipeLineSession
      Parameters:
      key - the referenced key
      defaultValue - the value to return when the key cannot be found
      Returns:
      long

    • get

      public double get(String key, double defaultValue)
      Retrieves a double value from the PipeLineSession
      Parameters:
      key - the referenced key
      defaultValue - the value to return when the key cannot be found
      Returns:
      double

    • scheduleCloseOnSessionExit

      public void scheduleCloseOnSessionExit(AutoCloseable resource)

    • unscheduleCloseOnSessionExit

      public void unscheduleCloseOnSessionExit(AutoCloseable resource)

    • close

      public void close()
      Specified by:
      close in interface AutoCloseable