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

Class BaseDseAuthenticator

java.lang.Object

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

All Implemented Interfaces:

Authenticator, SyncAuthenticator

Direct Known Subclasses:

DseGssApiAuthProviderBase.GssApiAuthenticator, PlainTextAuthProviderBase.PlainTextAuthenticator

@ThreadSafe
public abstract class BaseDseAuthenticator
extends Object
implements SyncAuthenticator

Base class for SyncAuthenticator implementations that want to make use of the authentication scheme negotiation in DseAuthenticator.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseDseAuthenticator(String serverAuthenticator)

Method Summary

Modifier and Type	Method and Description
protected abstract ByteBuffer	getInitialServerChallenge() Return a byte buffer containing the expected successful server challenge.
protected abstract ByteBuffer	getMechanism() Return a byte buffer containing the required SASL mechanism.
ByteBuffer	initialResponseSync() Obtain an initial response token for initializing the SASL handshake.
void	onAuthenticationSuccessSync(ByteBuffer token) Called when authentication is successful with the last information optionally sent by the server.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.datastax.oss.driver.api.core.auth.SyncAuthenticator

evaluateChallenge, evaluateChallengeSync, initialResponse, onAuthenticationSuccess

Constructor Detail

BaseDseAuthenticator

protected BaseDseAuthenticator(@NonNull
                               String serverAuthenticator)

Method Detail

getMechanism

@NonNull
protected abstract ByteBuffer getMechanism()

Return a byte buffer containing the required SASL mechanism.

This should be one of:

• PLAIN
• GSSAPI

This must be either a read-only buffer, or a new instance every time.

getInitialServerChallenge

@NonNull
protected abstract ByteBuffer getInitialServerChallenge()

Return a byte buffer containing the expected successful server challenge.

This should be one of:

• PLAIN-START
• GSSAPI-START

This must be either a read-only buffer, or a new instance every time.

initialResponseSync

@Nullable
public ByteBuffer initialResponseSync()

Description copied from interface: SyncAuthenticator

Obtain an initial response token for initializing the SASL handshake.

SyncAuthenticator.initialResponse() calls this and wraps the result in an immediately completed future.

Specified by:

initialResponseSync in interface SyncAuthenticator

Returns:

The initial response to send to the server (which may be null). Note that, if the returned byte buffer is writable, the driver will clear its contents immediately after use (to avoid keeping sensitive information in memory); do not reuse the same buffer across multiple invocations. Alternatively, if the contents are not sensitive, you can make the buffer read-only and safely reuse it.

onAuthenticationSuccessSync

public void onAuthenticationSuccessSync(@Nullable
                                        ByteBuffer token)

Description copied from interface: SyncAuthenticator

Called when authentication is successful with the last information optionally sent by the server.

SyncAuthenticator.onAuthenticationSuccess(ByteBuffer) calls this, and then returns an immediately completed future.

Specified by:

onAuthenticationSuccessSync in interface SyncAuthenticator

Parameters:

token - the information sent by the server with the authentication successful message. This will be null if the server sends no particular information on authentication success.