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

Interface SyncAuthenticator

All Superinterfaces:

Authenticator

All Known Implementing Classes:

BaseDseAuthenticator, DseGssApiAuthProviderBase.GssApiAuthenticator, PlainTextAuthProviderBase.PlainTextAuthenticator

public interface SyncAuthenticator
extends Authenticator

An authenticator that performs all of its operations synchronously, on the calling thread.

This is intended for simple implementations that are fast and lightweight enough, and do not perform any blocking operations.

Method Summary

Modifier and Type	Method and Description
default CompletionStage<ByteBuffer>	evaluateChallenge(ByteBuffer challenge) Evaluate a challenge received from the server.
ByteBuffer	evaluateChallengeSync(ByteBuffer challenge) Evaluate a challenge received from the server.
default CompletionStage<ByteBuffer>	initialResponse() Obtain an initial response token for initializing the SASL handshake.
ByteBuffer	initialResponseSync() Obtain an initial response token for initializing the SASL handshake.
default CompletionStage<Void>	onAuthenticationSuccess(ByteBuffer token) Called when authentication is successful with the last information optionally sent by the server.
void	onAuthenticationSuccessSync(ByteBuffer token) Called when authentication is successful with the last information optionally sent by the server.

Method Detail

initialResponseSync

@Nullable
ByteBuffer initialResponseSync()

Obtain an initial response token for initializing the SASL handshake.

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

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.

evaluateChallengeSync

@Nullable
ByteBuffer evaluateChallengeSync(@Nullable
                                           ByteBuffer challenge)

Evaluate a challenge received from the server.

evaluateChallenge(ByteBuffer) calls this and wraps the result in an immediately completed future.

Parameters:

challenge - the server's SASL challenge; may be null.

Returns:

The updated SASL token (which may be null to indicate the client requires no further action). 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

void onAuthenticationSuccessSync(@Nullable
                                 ByteBuffer token)

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

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

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.

initialResponse

@NonNull
default CompletionStage<ByteBuffer> initialResponse()

Description copied from interface: Authenticator

Obtain an initial response token for initializing the SASL handshake.

Specified by:

initialResponse in interface Authenticator

Returns:

a completion stage that will complete with 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.

evaluateChallenge

@NonNull
default CompletionStage<ByteBuffer> evaluateChallenge(@Nullable
                                                               ByteBuffer challenge)

Description copied from interface: Authenticator

Evaluate a challenge received from the server. Generally, this method should return null when authentication is complete from the client perspective.

Specified by:

evaluateChallenge in interface Authenticator

Parameters:

challenge - the server's SASL challenge.

Returns:

a completion stage that will complete with the updated SASL token (which may be null to indicate the client requires no further action). 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.

onAuthenticationSuccess

@NonNull
default CompletionStage<Void> onAuthenticationSuccess(@Nullable
                                                               ByteBuffer token)

Description copied from interface: Authenticator

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

Specified by:

onAuthenticationSuccess in interface Authenticator

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.

Returns:

a completion stage that completes when the authenticator is done processing this response.