com.datastax.dse.driver.api.core

Class DseSessionBuilderBase<SelfT extends com.datastax.oss.driver.api.core.session.SessionBuilder,SessionT>

java.lang.Object

com.datastax.oss.driver.api.core.session.SessionBuilder<SelfT,SessionT>

com.datastax.dse.driver.api.core.DseSessionBuilderBase<SelfT,SessionT>

Direct Known Subclasses:

DseSessionBuilder

@NotThreadSafe
public abstract class DseSessionBuilderBase<SelfT extends com.datastax.oss.driver.api.core.session.SessionBuilder,SessionT>
extends com.datastax.oss.driver.api.core.session.SessionBuilder<SelfT,SessionT>

Field Summary

Fields

Modifier and Type	Field and Description
protected DseProgrammaticArguments.Builder	dseProgrammaticArgumentsBuilder

Fields inherited from class com.datastax.oss.driver.api.core.session.SessionBuilder

configLoader, keyspace, programmaticArgumentsBuilder, programmaticContactPoints, self

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DseSessionBuilderBase()

Method Summary

Modifier and Type	Method and Description
protected com.datastax.oss.driver.api.core.context.DriverContext	buildContext(com.datastax.oss.driver.api.core.config.DriverConfigLoader configLoader, List<com.datastax.oss.driver.api.core.type.codec.TypeCodec<?>> typeCodecs, com.datastax.oss.driver.api.core.metadata.NodeStateListener nodeStateListener, com.datastax.oss.driver.api.core.metadata.schema.SchemaChangeListener schemaChangeListener, com.datastax.oss.driver.api.core.tracker.RequestTracker requestTracker, Map<String,String> localDatacenters, Map<String,Predicate<com.datastax.oss.driver.api.core.metadata.Node>> nodeFilters, ClassLoader classLoader) Deprecated.
protected com.datastax.oss.driver.api.core.context.DriverContext	buildContext(com.datastax.oss.driver.api.core.config.DriverConfigLoader configLoader, com.datastax.oss.driver.api.core.session.ProgrammaticArguments programmaticArguments)
protected com.datastax.oss.driver.api.core.config.DriverConfigLoader	defaultConfigLoader()
SelfT	withApplicationName(String applicationName) The name of the application using the created session.
SelfT	withApplicationVersion(String applicationVersion) The version of the application using the created session.
SelfT	withAuthCredentials(String username, String password) Configures the session to use DSE plaintext authentication with the given username and password.
SelfT	withAuthCredentials(String username, String password, String authorizationId) Configures the session to use DSE plaintext authentication with the given username and password, and perform proxy authentication with the given authorization id.
SelfT	withClientId(UUID clientId) A unique identifier for the created session.
SelfT	withConfigLoader(com.datastax.oss.driver.api.core.config.DriverConfigLoader configLoader) Sets the configuration loader to use.

Methods inherited from class com.datastax.oss.driver.api.core.session.SessionBuilder

addContactEndPoint, addContactEndPoints, addContactPoint, addContactPoints, addTypeCodecs, build, buildAsync, buildDefaultSessionAsync, withAuthProvider, withClassLoader, withKeyspace, withKeyspace, withLocalDatacenter, withLocalDatacenter, withNodeFilter, withNodeFilter, withNodeStateListener, withRequestTracker, withSchemaChangeListener, withSslContext, withSslEngineFactory, wrap

Methods inherited from class java.lang.Object

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

Field Detail

dseProgrammaticArgumentsBuilder

protected DseProgrammaticArguments.Builder dseProgrammaticArgumentsBuilder

Constructor Detail

DseSessionBuilderBase

protected DseSessionBuilderBase()

Method Detail

withClientId

@NonNull
public SelfT withClientId(@Nullable
                                   UUID clientId)

A unique identifier for the created session.

It will be sent in the STARTUP protocol message for each new connection established by the driver, and may be used by future DSE versions for monitoring purposes.

If you don't call this method, the driver will generate an identifier with Uuids.random().

withApplicationName

@NonNull
public SelfT withApplicationName(@Nullable
                                          String applicationName)

The name of the application using the created session.

It will be sent in the STARTUP protocol message for each new connection established by the driver, and may be used by future DSE versions for monitoring purposes.

This can also be defined in the driver configuration with the option basic.application.name; if you specify both, this method takes precedence and the configuration option will be ignored.

withApplicationVersion

@NonNull
public SelfT withApplicationVersion(@Nullable
                                             String applicationVersion)

The version of the application using the created session.

It will be sent in the STARTUP protocol message for each new connection established by the driver, and may be used by future DSE versions for monitoring purposes.

This can also be defined in the driver configuration with the option basic.application.version; if you specify both, this method takes precedence and the configuration option will be ignored.

withConfigLoader

@NonNull
public SelfT withConfigLoader(@Nullable
                                       com.datastax.oss.driver.api.core.config.DriverConfigLoader configLoader)

Sets the configuration loader to use.

Note that this loader must produce a configuration that includes the DSE-specific options: if you're using one of the built-in implementations provided by the driver, use the static factory methods from DseDriverConfigLoader (not the ones from DriverConfigLoader).

If you don't call this method, the builder will use the default implementation, based on the Typesafe config library. More precisely, configuration properties are loaded and merged from the following (first-listed are higher priority):

• system properties
• application.conf (all resources on classpath with this name)
• application.json (all resources on classpath with this name)
• application.properties (all resources on classpath with this name)
• dse-reference.conf (all resources on classpath with this name). In particular, this will load the dse-reference.conf included in the core DSE driver JAR, that defines default options for all DSE-specific mandatory options.
• reference.conf (all resources on classpath with this name). In particular, this will load the reference.conf included in the core driver JAR, that defines default options for all mandatory options.

The resulting configuration is expected to contain a datastax-java-driver section.

This default loader will honor the reload interval defined by the option basic.config-reload-interval.

Overrides:

withConfigLoader in class com.datastax.oss.driver.api.core.session.SessionBuilder<SelfT extends com.datastax.oss.driver.api.core.session.SessionBuilder,SessionT>

See Also:

Typesafe config's standard loading behavior

withAuthCredentials

@NonNull
public SelfT withAuthCredentials(@NonNull
                                          String username,
                                          @NonNull
                                          String password)

Configures the session to use DSE plaintext authentication with the given username and password.

This methods calls SessionBuilder.withAuthProvider(AuthProvider) to register a special provider implementation. Therefore calling it overrides the configuration (that is, the advanced.auth-provider.class option will be ignored).

Note that this approach holds the credentials in clear text in memory, which makes them vulnerable to an attacker who is able to perform memory dumps. If this is not acceptable for you, consider writing your own AuthProvider implementation (the internal class PlainTextAuthProviderBase is a good starting point), and providing it either with SessionBuilder.withAuthProvider(AuthProvider) or via the configuration (advanced.auth-provider.class).

Overrides:

withAuthCredentials in class com.datastax.oss.driver.api.core.session.SessionBuilder<SelfT extends com.datastax.oss.driver.api.core.session.SessionBuilder,SessionT>

withAuthCredentials

@NonNull
public SelfT withAuthCredentials(@NonNull
                                          String username,
                                          @NonNull
                                          String password,
                                          @NonNull
                                          String authorizationId)

Configures the session to use DSE plaintext authentication with the given username and password, and perform proxy authentication with the given authorization id.

This methods calls SessionBuilder.withAuthProvider(AuthProvider) to register a special provider implementation. Therefore calling it overrides the configuration (that is, the advanced.auth-provider.class option will be ignored).

Note that this approach holds the credentials in clear text in memory, which makes them vulnerable to an attacker who is able to perform memory dumps. If this is not acceptable for you, consider writing your own AuthProvider implementation (the internal class PlainTextAuthProviderBase is a good starting point), and providing it either with SessionBuilder.withAuthProvider(AuthProvider) or via the configuration (advanced.auth-provider.class).

buildContext

protected com.datastax.oss.driver.api.core.context.DriverContext buildContext(com.datastax.oss.driver.api.core.config.DriverConfigLoader configLoader,
                                                                              com.datastax.oss.driver.api.core.session.ProgrammaticArguments programmaticArguments)

Overrides:

buildContext in class com.datastax.oss.driver.api.core.session.SessionBuilder<SelfT extends com.datastax.oss.driver.api.core.session.SessionBuilder,SessionT>

buildContext

@Deprecated
protected com.datastax.oss.driver.api.core.context.DriverContext buildContext(com.datastax.oss.driver.api.core.config.DriverConfigLoader configLoader,
                                                                                          List<com.datastax.oss.driver.api.core.type.codec.TypeCodec<?>> typeCodecs,
                                                                                          com.datastax.oss.driver.api.core.metadata.NodeStateListener nodeStateListener,
                                                                                          com.datastax.oss.driver.api.core.metadata.schema.SchemaChangeListener schemaChangeListener,
                                                                                          com.datastax.oss.driver.api.core.tracker.RequestTracker requestTracker,
                                                                                          Map<String,String> localDatacenters,
                                                                                          Map<String,Predicate<com.datastax.oss.driver.api.core.metadata.Node>> nodeFilters,
                                                                                          ClassLoader classLoader)

Deprecated.

Overrides:

buildContext in class com.datastax.oss.driver.api.core.session.SessionBuilder<SelfT extends com.datastax.oss.driver.api.core.session.SessionBuilder,SessionT>

defaultConfigLoader

@NonNull
protected com.datastax.oss.driver.api.core.config.DriverConfigLoader defaultConfigLoader()

Overrides:

defaultConfigLoader in class com.datastax.oss.driver.api.core.session.SessionBuilder<SelfT extends com.datastax.oss.driver.api.core.session.SessionBuilder,SessionT>