Interface Authenticator

  • All Known Implementing Classes:
    AllowAllAuthenticator, Krb5Authenticator, SimpleAuthenticator

    public interface Authenticator
    Provides methods related to authentication of a request. Implementations should provide a SASL based authentication method, but a handler can choose to use the authenticate(Map) method directly if required for protocols that don't easily support SASL.
    Stephen Mallette (
    • Method Detail

      • requireAuthentication

        boolean requireAuthentication()
        Whether or not the authenticator requires explicit login. If false will instantiate user with AuthenticatedUser.ANONYMOUS_USER.
      • setup

        void setup​(Map<String,​Object> config)
        Setup is called once upon system startup to initialize the Authenticator.
      • newSaslNegotiator

        Authenticator.SaslNegotiator newSaslNegotiator​(InetAddress remoteAddress)
        Provide a SASL handler to perform authentication for an single connection. SASL is a stateful protocol, so a new instance must be used for each authentication attempt.
        remoteAddress - the IP address of the client to authenticate to authenticate or null if an internal client (one not connected over the remote transport).