Package org.apache.bookkeeper.auth

Interface BookieAuthProvider

All Known Implementing Classes:
SASLBookieAuthProvider
public interface BookieAuthProvider
Bookie authentication provider interface.

This must be implemented by any party wishing to implement an authentication mechanism for bookkeeper connections.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    BookieAuthProvider.Factory
    A factory to create the bookie authentication provider.

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    close()
    Release resources.
    default void
    onProtocolUpgrade()
    Callback to let the provider know that the underlying protocol is changed.
    void
    process(AuthToken m, AuthCallbacks.GenericCallback<AuthToken> cb)
    Process a request from the client.

  • Method Details

    • onProtocolUpgrade

      default void onProtocolUpgrade()
      Callback to let the provider know that the underlying protocol is changed. For instance this will happen when a START_TLS operation succeeds

    • process

      void process(AuthToken m, AuthCallbacks.GenericCallback<AuthToken> cb)
      Process a request from the client. cb will receive the next message to be sent to the client. If there are no more messages to send to the client, cb should not be called, and completeCb must be called instead.

    • close

      default void close()
      Release resources.