com.datastax.dse.driver.api.core.auth

Class DsePlainTextAuthProviderBase

java.lang.Object

com.datastax.dse.driver.api.core.auth.DsePlainTextAuthProviderBase

All Implemented Interfaces:

com.datastax.oss.driver.api.core.auth.AuthProvider, AutoCloseable

@ThreadSafe
public abstract class DsePlainTextAuthProviderBase
extends Object
implements com.datastax.oss.driver.api.core.auth.AuthProvider

Common infrastructure for DSE plain text auth providers.

This can be reused to write an implementation that retrieves the credentials from another source than the configuration.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DsePlainTextAuthProviderBase(String logPrefix)

Method Summary

Modifier and Type	Method and Description
void	close()
protected abstract DsePlainTextAuthProviderBase.Credentials	getCredentials(com.datastax.oss.driver.api.core.metadata.EndPoint endPoint, String serverAuthenticator) Retrieves the credentials from the underlying source.
com.datastax.oss.driver.api.core.auth.Authenticator	newAuthenticator(com.datastax.oss.driver.api.core.metadata.EndPoint endPoint, String serverAuthenticator)
void	onMissingChallenge(com.datastax.oss.driver.api.core.metadata.EndPoint endPoint)

Methods inherited from class java.lang.Object

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

Constructor Detail

DsePlainTextAuthProviderBase

protected DsePlainTextAuthProviderBase(@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). Config-based implementations fill this with Session.getName().

Method Detail

getCredentials

@NonNull
protected abstract DsePlainTextAuthProviderBase.Credentials getCredentials(@NonNull
                                                                                    com.datastax.oss.driver.api.core.metadata.EndPoint endPoint,
                                                                                    @NonNull
                                                                                    String serverAuthenticator)

Retrieves the credentials from the underlying source.

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

newAuthenticator

@NonNull
public com.datastax.oss.driver.api.core.auth.Authenticator newAuthenticator(@NonNull
                                                                                     com.datastax.oss.driver.api.core.metadata.EndPoint endPoint,
                                                                                     @NonNull
                                                                                     String serverAuthenticator)
                                                                              throws com.datastax.oss.driver.api.core.auth.AuthenticationException

Specified by:

newAuthenticator in interface com.datastax.oss.driver.api.core.auth.AuthProvider

Throws:

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

onMissingChallenge

public void onMissingChallenge(@NonNull
                               com.datastax.oss.driver.api.core.metadata.EndPoint endPoint)

Specified by:

onMissingChallenge in interface com.datastax.oss.driver.api.core.auth.AuthProvider

close

public void close()

Specified by:

close in interface AutoCloseable