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

Class DseGssApiAuthProviderBase

java.lang.Object

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

All Implemented Interfaces:

AuthProvider, AutoCloseable

Direct Known Subclasses:

ProgrammaticDseGssApiAuthProvider

@ThreadSafe
public abstract class DseGssApiAuthProviderBase
extends Object
implements AuthProvider

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DseGssApiAuthProviderBase.GssApiAuthenticator
static class	DseGssApiAuthProviderBase.GssApiOptions The options to initialize a new authenticator.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SASL_SERVICE_NAME The default SASL service name used by this auth provider.
static String	SASL_SERVICE_NAME_PROPERTY The name of the system property to use to specify the SASL service name.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DseGssApiAuthProviderBase(String logPrefix)

Method Summary

Modifier and Type	Method and Description
void	close()
protected abstract DseGssApiAuthProviderBase.GssApiOptions	getOptions(EndPoint endPoint, String serverAuthenticator)
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

Field Detail

DEFAULT_SASL_SERVICE_NAME

public static final String DEFAULT_SASL_SERVICE_NAME

The default SASL service name used by this auth provider.

See Also:

Constant Field Values

SASL_SERVICE_NAME_PROPERTY

public static final String SASL_SERVICE_NAME_PROPERTY

The name of the system property to use to specify the SASL service name.

See Also:

Constant Field Values

Constructor Detail

DseGssApiAuthProviderBase

protected DseGssApiAuthProviderBase(@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

getOptions

@NonNull
protected abstract DseGssApiAuthProviderBase.GssApiOptions getOptions(@NonNull
                                                                               EndPoint endPoint,
                                                                               @NonNull
                                                                               String serverAuthenticator)

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