kafka-common-network-Authenticator.adoc

Authenticator

Authenticator is the abstraction of authenticators that can authenticate a KafkaPrincipal.

Authenticator is a java.io.Closeable.

Authenticator is used by KafkaChannel.

Table 1. Authenticator Contract

Method	Description
authenticate	void authenticate() Used when KafkaChannel is requested to prepare (and the transportLayer is ready)
clientSessionReauthenticationTimeNanos	Long clientSessionReauthenticationTimeNanos() Default: null Used when KafkaChannel is requested to maybeBeginClientReauthentication
complete	boolean complete() Used when KafkaChannel is requested to prepare and ready
connectedClientSupportsReauthentication	boolean connectedClientSupportsReauthentication() Used when…​FIXME
getAndClearResponsesReceivedDuringReauthentication	List<NetworkReceive> getAndClearResponsesReceivedDuringReauthentication() Used when…​FIXME
handleAuthenticationFailure	void handleAuthenticationFailure() Used when…​FIXME
principal	KafkaPrincipal principal() Used when KafkaChannel is requested for a principal.
reauthenticate	void reauthenticate( ReauthenticationContext reauthenticationContext) Used when…​FIXME
reauthenticationLatencyMs	Long reauthenticationLatencyMs() Used when…​FIXME
serverSessionExpirationTimeNanos	Long serverSessionExpirationTimeNanos() Used when…​FIXME

Table 2. Authenticators

Authenticator	Description
PlaintextAuthenticator
SaslClientAuthenticator
SaslServerAuthenticator
SslAuthenticator