Interface IExternalFlowStore

public interface IExternalFlowStore
Abstraction for the external flow store.
Since:
12.1
Author:
Voicu Moldovan

  • Method Details

    • delete

      void delete(String key)
      Removes the specified key.

      If the given key does not exist in the store, no exception is thrown.

      Parameters:
      key - The key to delete, cannot be null or empty
      Throws:
      ExternalFlowStoreException - when there is an error communicating with the external flow store
      IllegalArgumentException - if key is null or empty

    • get

      ObjectModelRetrieval get(String key)
      Returns the value specified fot the given key.
      Parameters:
      key - The key from where to retrieve the data, cannot be null or empty
      Returns:
      the saved value or null if nothing was found
      Throws:
      ExternalFlowStoreException - when there is an error communicating with the external flow store
      IllegalArgumentException - if key is null or empty

    • hasKey

      boolean hasKey(String key)
      Checks if the given key exists in the external flow store.
      Parameters:
      key - The key to check for existence, cannot be null or empty
      Returns:
      true if the key exists, false otherwise
      Throws:
      ExternalFlowStoreException - when there is an error communicating with the external flow store
      IllegalArgumentException - if parameter key is null or empty

    • set

      void set(String key, ObjectModelStorage value)
      Saves a ObjectModelStorage object in the external flow store.

      If a value already exists for the given key, it will be overwritten.

      Parameters:
      key - The key where the value will be saved under, cannot be null or empty
      value - ObjectModelStorage object to persist in the external flow store, cannot be null
      Throws:
      ExternalFlowStoreException - when there is an error communicating with the external flow store
      IllegalArgumentException - if parameter key is null or empty