Interface TimeoutMap<K,V>

Type Parameters:
K - the key type
V - the value type
All Superinterfaces:
AutoCloseable, Service
public interface TimeoutMap<K,V> extends Service
A map whose entries expire automatically after a configurable period of inactivity.

Entries are added via put(Object, Object, long) with an individual timeout in milliseconds. A background Service thread periodically scans the map and evicts entries whose timeout has elapsed, notifying any registered TimeoutMap.Listener. This is used internally by components that need session or correlation state with automatic cleanup, such as the aggregator's in-memory repository and the idempotent consumer.

See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    TimeoutMap.Listener<K,V>
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addListener(TimeoutMap.Listener<K,V> listener)
    Assign the (singular) TimeoutMap.Listener
    @Nullable V
    get(K key)
    Looks up the value in the map by the given key.
    @Nullable V
    put(K key, V value, long timeoutMillis)
    Adds the key value pair into the map such that some time after the given timeout the entry will be evicted
    @Nullable V
    putIfAbsent(K key, V value, long timeoutMillis)
    Adds the key value pair into the map if the specified key is not already associated with a value such that some time after the given timeout the entry will be evicted.
    @Nullable V
    remove(K key)
    Removes the object with the given key
    int
    size()
    Returns the size of the map

    Methods inherited from interface Service

    build, close, init, start, stop

  • Method Details

    • get

      @Nullable V get(K key)
      Looks up the value in the map by the given key.
      Parameters:
      key - the key of the value to search for
      Returns:
      the value for the given key or null if it is not present (or has timed out)

    • size

      int size()
      Returns the size of the map
      Returns:
      the size

    • put

      @Nullable V put(K key, V value, long timeoutMillis)
      Adds the key value pair into the map such that some time after the given timeout the entry will be evicted
      Parameters:
      key - the key
      value - the value
      timeoutMillis - timeout in millis
      Returns:
      the previous value associated with key, or null if there was no mapping for key.

    • putIfAbsent

      @Nullable V putIfAbsent(K key, V value, long timeoutMillis)
      Adds the key value pair into the map if the specified key is not already associated with a value such that some time after the given timeout the entry will be evicted. Expiry time of an existing mapping is left unchanged.
      Parameters:
      key - the key
      value - the value
      timeoutMillis - timeout in millis
      Returns:
      the value associated with key, or null if there was no mapping for key.

    • remove

      @Nullable V remove(K key)
      Removes the object with the given key
      Parameters:
      key - key for the object to remove
      Returns:
      the value for the given key or null if it is not present (or has timed out)

    • addListener

      void addListener(TimeoutMap.Listener<K,V> listener)
      Assign the (singular) TimeoutMap.Listener
      Parameters:
      listener - the new listener