com.datastax.dse.driver.api.core

Class DseSessionBuilder

java.lang.Object

com.datastax.oss.driver.api.core.session.SessionBuilder<DseSessionBuilder,DseSession>

com.datastax.dse.driver.api.core.DseSessionBuilder

@NotThreadSafe
public class DseSessionBuilder
extends SessionBuilder<DseSessionBuilder,DseSession>

Field Summary

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

configLoader, keyspace, programmaticContactPoints, requestTracker, self, typeCodecs

Constructor Summary

Constructors

Constructor and Description
DseSessionBuilder()

Method Summary

Modifier and Type	Method and Description
protected DriverContext	buildContext(DriverConfigLoader configLoader, List<TypeCodec<?>> typeCodecs, NodeStateListener nodeStateListener, SchemaChangeListener schemaChangeListener, RequestTracker requestTracker, Map<String,String> localDatacenters, Map<String,Predicate<Node>> nodeFilters, ClassLoader classLoader)
protected DriverConfigLoader	defaultConfigLoader()
DseSessionBuilder	withApplicationName(String applicationName) The name of the application using the created session.
DseSessionBuilder	withApplicationVersion(String applicationVersion) The version of the application using the created session.
DseSessionBuilder	withClientId(UUID clientId) A unique identifier for the created session.
DseSessionBuilder	withConfigLoader(DriverConfigLoader configLoader) Sets the configuration loader to use.
protected DseSession	wrap(CqlSession defaultSession)

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

DseSessionBuilder

public DseSessionBuilder()

Method Detail

withClientId

@NonNull
public DseSessionBuilder 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 DseSessionBuilder 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 DseSessionBuilder 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 DseSessionBuilder withConfigLoader(@Nullable
                                                   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 SessionBuilder<DseSessionBuilder,DseSession>

See Also:

Typesafe config's standard loading behavior

buildContext

protected DriverContext buildContext(DriverConfigLoader configLoader,
                                     List<TypeCodec<?>> typeCodecs,
                                     NodeStateListener nodeStateListener,
                                     SchemaChangeListener schemaChangeListener,
                                     RequestTracker requestTracker,
                                     Map<String,String> localDatacenters,
                                     Map<String,Predicate<Node>> nodeFilters,
                                     ClassLoader classLoader)

Overrides:

buildContext in class SessionBuilder<DseSessionBuilder,DseSession>

defaultConfigLoader

@NonNull
protected DriverConfigLoader defaultConfigLoader()

Overrides:

defaultConfigLoader in class SessionBuilder<DseSessionBuilder,DseSession>

wrap

@NonNull
protected DseSession wrap(@NonNull
                                   CqlSession defaultSession)

Specified by:

wrap in class SessionBuilder<DseSessionBuilder,DseSession>