Interface ExternalStoreListener<K,V>

Type Parameters:
K - Key type for entries in the external store
V - Value type for entries in the external store
public interface ExternalStoreListener<K,V>
Listener for entries from an external store, for example an LDAP server. This is implemented by the auth metadata writer. The master writer processes entries from the external store using this listener interface.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    delete(K key)
    Invoked when a refresh of the external store indicates that an entry was deleted.
    void
    fail(String errorMessage)
    Indicates that the connection to the external store has failed.
    void
    initialize(Map<K,V> initialValues)
    Invoked when existing entries from the external store are processed.
    void
    resetFailure()
    Indicates that external store is functioning after an earlier failure.
    void
    start()
     
    void
    stop()
     
    void
    update(K key, V value)
    Invoked when a refresh of the external store finds a new entry or an updated entry.

  • Method Details

    • initialize

      void initialize(Map<K,V> initialValues)
      Invoked when existing entries from the external store are processed.
      Parameters:
      initialValues - Initial values from the store

    • update

      void update(K key, V value)
      Invoked when a refresh of the external store finds a new entry or an updated entry.
      Parameters:
      key - Key to update
      value - New value

    • delete

      void delete(K key)
      Invoked when a refresh of the external store indicates that an entry was deleted.
      Parameters:
      key - Key of deleted entry

    • fail

      void fail(String errorMessage)
      Indicates that the connection to the external store has failed. This is invoked when the configured retry timeout for the store has been reached.
      Parameters:
      errorMessage - Error message that will be added to the auth topic

    • resetFailure

      void resetFailure()
      Indicates that external store is functioning after an earlier failure.

    • start

      void start()

    • stop

      void stop()