com.datastax.oss.driver.api.core.auth

Interface AuthProvider

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

DseGssApiAuthProviderBase, DsePlainTextAuthProviderBase, PlainTextAuthProviderBase, ProgrammaticDseGssApiAuthProvider, ProgrammaticPlainTextAuthProvider

public interface AuthProvider
extends AutoCloseable

Provides Authenticator instances to use when connecting to Cassandra nodes.

See PlainTextAuthProvider for an implementation which uses SASL PLAIN mechanism to authenticate using username/password strings.

Method Summary

Modifier and Type	Method and Description
Authenticator	newAuthenticator(EndPoint endPoint, String serverAuthenticator) The authenticator to use when connecting to host.
void	onMissingChallenge(EndPoint endPoint) What to do if the server does not send back an authentication challenge (in other words, lets the client connect without any form of authentication).

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

newAuthenticator

@NonNull
Authenticator newAuthenticator(@NonNull
                                        EndPoint endPoint,
                                        @NonNull
                                        String serverAuthenticator)
                                 throws AuthenticationException

The authenticator to use when connecting to host.

Parameters:

endPoint - the Cassandra host to connect to.

serverAuthenticator - the configured authenticator on the host.

Returns:

the authentication implementation to use.

Throws:

AuthenticationException

onMissingChallenge

void onMissingChallenge(@NonNull
                        EndPoint endPoint)
                 throws AuthenticationException

What to do if the server does not send back an authentication challenge (in other words, lets the client connect without any form of authentication).

This is suspicious because having authentication enabled on the client but not on the server is probably a configuration mistake.

Provider implementations are free to handle this however they want; typical approaches are:

• ignoring;
• logging a warning;
• throwing an AuthenticationException to abort the connection (but note that it will be retried according to the ReconnectionPolicy).

Throws:

AuthenticationException