Package org.frankframework.cache

Interface ICache<K,V>

All Known Implementing Classes:
AbstractCacheAdapter, EhCache
public interface ICache<K,V>
Interface to be implemented by cache-providers.
Since:
4.11
Author:
Gerrit van Brakel
Default element
org.frankframework.cache.EhCache

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    close()
     
    void
    configure(String ownerName)
     
    V
    get(K key)
    Obtain a potentially cached value, set by put().
    void
    open()
     
    void
    put(K key, V value)
    store a value in the cache, that can be retrieved later using get().
    K
    transformKey(String input, PipeLineSession session)
    Transform the the current request message to a key in the cache-map.
    V
    transformValue(Message input, PipeLineSession session)
    Transform the the current response message to a value in the cache-map.

  • Method Details

    • configure

      void configure(String ownerName) throws ConfigurationException
      Throws:
      ConfigurationException

    • open

      void open()

    • close

      void close()

    • transformKey

      K transformKey(String input, PipeLineSession session)
      Transform the the current request message to a key in the cache-map. Allows for instance XPath translations.

    • transformValue

      V transformValue(Message input, PipeLineSession session)
      Transform the the current response message to a value in the cache-map. Allows for instance XPath translations.

    • get

      V get(K key)
      Obtain a potentially cached value, set by put().

    • put

      void put(K key, V value)
      store a value in the cache, that can be retrieved later using get().