Package com.blueriq.component.api.store.keyvalue

Interface IKeyspaceMonitor

public interface IKeyspaceMonitor
A keyspace monitor is capable of "monitoring" the keys in a key-value store and notify listeners when a key is set, deleted or when a key expires.
Since:
11.0
Author:
Petru Galanton

  • Method Details

    • addListener

      void addListener(String key, IKeyspaceEventListener listener)
      Registers the given listener for the given key.
      Parameters:
      key - the key to monitor
      listener - the listener to notify when events occur for the given key

    • addListener

      void addListener(IKeyPattern keyPattern, IKeyspaceEventListener listener)
      Registers the given listener for the given key pattern. The listener will be notified of events for any keys in the key-value store which match the given pattern.
      Parameters:
      keyPattern - the key pattern to monitor
      listener - the listener to be notified

    • removeListener

      void removeListener(String key, IKeyspaceEventListener listener)
      Unregisters the given listener from the given key.
      Parameters:
      key - the key
      listener - the listener to unregister

    • removeListener

      void removeListener(IKeyPattern keyPattern, IKeyspaceEventListener listener)
      Unregisters the given listener from the given key pattern.
      Parameters:
      keyPattern - the key pattern
      listener - the listener to unregister

    • getKeyPatternBuilder

      IKeyPatternBuilder getKeyPatternBuilder()
      Returns a builder for creating key patterns.
      Returns:
      a key pattern builder.