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

Class PlainTextAuthProviderBase

java.lang.Object

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

All Implemented Interfaces:

AuthProvider, AutoCloseable

Direct Known Subclasses:

DsePlainTextAuthProviderBase, ProgrammaticPlainTextAuthProvider

@ThreadSafe
public abstract class PlainTextAuthProviderBase
extends Object
implements AuthProvider

Common infrastructure for plain text auth providers.

This can be reused to write an implementation that retrieves the credentials from another source than the configuration. The driver offers one built-in implementation: ProgrammaticPlainTextAuthProvider.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PlainTextAuthProviderBase.Credentials
protected static class	PlainTextAuthProviderBase.PlainTextAuthenticator

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PlainTextAuthProviderBase(String logPrefix)

Method Summary

Modifier and Type	Method and Description
void	close()
protected abstract PlainTextAuthProviderBase.Credentials	getCredentials(EndPoint endPoint, String serverAuthenticator) Retrieves the credentials from the underlying source.
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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PlainTextAuthProviderBase

protected PlainTextAuthProviderBase(@NonNull
                                    String logPrefix)

Parameters:

logPrefix - a string that will get prepended to the logs (this is used for discrimination when you have multiple driver instances executing in the same JVM). Built-in implementations fill this with Session.getName().

Method Detail

getCredentials

@NonNull
protected abstract PlainTextAuthProviderBase.Credentials getCredentials(@NonNull
                                                                                 EndPoint endPoint,
                                                                                 @NonNull
                                                                                 String serverAuthenticator)

Retrieves the credentials from the underlying source.

This is invoked every time the driver opens a new connection.

Parameters:

endPoint - The endpoint being contacted.

serverAuthenticator - The authenticator class sent by the endpoint.

newAuthenticator

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

Description copied from interface: AuthProvider

The authenticator to use when connecting to host.

Specified by:

newAuthenticator in interface AuthProvider

Parameters:

endPoint - the Cassandra host to connect to.

serverAuthenticator - the configured authenticator on the host.

Returns:

the authentication implementation to use.

Throws:

AuthenticationException

onMissingChallenge

public void onMissingChallenge(@NonNull
                               EndPoint endPoint)

Description copied from interface: AuthProvider

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).

Specified by:

onMissingChallenge in interface AuthProvider

close

public void close()

Specified by:

close in interface AutoCloseable