Package io.confluent.security.auth.store.external

Interface ExternalStore

All Superinterfaces:
org.apache.kafka.common.Configurable
All Known Implementing Classes:
LdapStore
public interface ExternalStore extends org.apache.kafka.common.Configurable
Interface for managing metadata from an external store, for example an LDAP server.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    failed()
    Returns true if the external store has failed and retries have timed out.
    void
    start(int generationId)
    Starts consuming metadata from the external store.
    void
    stop(Integer generationId)
    Stops consuming metadata from the external store if the provided generation id is null or equal to the current generation id of this store.

    Methods inherited from interface org.apache.kafka.common.Configurable

    configure

  • Method Details

    • start

      void start(int generationId)
      Starts consuming metadata from the external store.
      Parameters:
      generationId - The generation id of the writer

    • stop

      void stop(Integer generationId)
      Stops consuming metadata from the external store if the provided generation id is null or equal to the current generation id of this store.
      Parameters:
      generationId - The generation id to match or null to match any generation

    • failed

      boolean failed()
      Returns true if the external store has failed and retries have timed out.