io.stargate.sdk.StargateClientBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of stargate-sdk Show documentation
Show all versions of stargate-sdk Show documentation
Connect to Stargate Data Gateway
The newest version!
package io.stargate.sdk;
import com.datastax.oss.driver.api.core.ConsistencyLevel;
import com.datastax.oss.driver.api.core.CqlSession;
import com.datastax.oss.driver.api.core.config.*;
import com.datastax.oss.driver.api.core.tracker.RequestTracker;
import com.datastax.oss.driver.internal.core.auth.PlainTextAuthProvider;
import com.datastax.oss.driver.internal.core.config.typesafe.DefaultProgrammaticDriverConfigLoaderBuilder;
import io.stargate.sdk.api.TokenProvider;
import io.stargate.sdk.api.SimpleTokenProvider;
import io.stargate.sdk.audit.ServiceCallObserver;
import io.stargate.sdk.grpc.ServiceGrpc;
import io.stargate.sdk.http.ServiceHttp;
import io.stargate.sdk.http.auth.TokenProviderHttpAuth;
import io.stargate.sdk.utils.Utils;
import com.evanlennick.retry4j.config.RetryConfig;
import io.stargate.sdk.utils.Assert;
import org.apache.hc.client5.http.config.RequestConfig;
import java.io.File;
import java.io.Serializable;
import java.time.Duration;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* The Stargate SDK allows to connect to multiple APIS and provides a wide range of options. With the more advanced settings we
* need an abtraction for the configuration. It can then be loaded from multiple sources like .. a builder, an application.yaml, a
* service discovery with different configuration loader.
*
* @author Cedrick LUNVEN (@clunven)
*/
public class StargateClientBuilder implements Serializable {
/** Serial. */
private static final long serialVersionUID = -4662012136342903695L;
/** default datacenter id. */
public static final String DEFAULT_DATACENTER = "dc1";
// ------------------------------------------------
// ----- Authentication ---------
// ------------------------------------------------
/** user name. */
protected String username;
/** This the endPoint to invoke to work with different API(s). */
protected String password;
/** if provided the authentication URL is not use to get token. */
protected String appToken = null;
/** if an apiToken is provided it will be used for all nodes. */
protected Map stargateNodesDC = new HashMap<>();
/**
* Gets stargateNodesDC
*
* @return value of stargateNodesDC
*/
public Map getStargateNodesDC() {
return stargateNodesDC;
}
/**
* Fill username and password.
*
* @param username
* user identifier
* @param password
* password
* @return current reference
*/
public StargateClientBuilder withAuthCredentials(String username, String password) {
checkNoCqlSession();
Assert.hasLength(username, "username");
Assert.hasLength(password, "password");
this.username = username;
this.password = password;
withCqlOptionString(TypedDriverOption.AUTH_PROVIDER_USER_NAME, username);
withCqlOptionString(TypedDriverOption.AUTH_PROVIDER_PASSWORD, password);
withCqlOptionString(TypedDriverOption.AUTH_PROVIDER_CLASS, PlainTextAuthProvider.class.getName());
return this;
}
/**
* Retrieve an {@link TokenProvider} based on token.
*
* @param dc
* current DC
* @return the token provider
*/
public TokenProvider getApiTokenProvider(String dc) {
Assert.hasLength(dc, "dc");
TokenProvider dcTokenProvider = null;
// As a token is explicitly provided (e.g: ASTRA) no computation of token
if (Utils.hasLength(appToken)) {
dcTokenProvider = new SimpleTokenProvider(appToken);
} else if (stargateNodesDC.containsKey(dc)) {
// An ApiToken as been provided for the DC (can be different by DC, external config etc.)
dcTokenProvider = stargateNodesDC.get(dc).getTokenProvider();
} else {
// No solution to enable authentication has been found
throw new IllegalArgumentException("No token provider found for DC" + dc);
}
return dcTokenProvider;
}
/**
* Api token available for all the nodes.
*
* @param token
* current token
* @return self reference
*/
public StargateClientBuilder withApiToken(String token) {
Assert.hasLength(token, "token");
this.appToken = token;
return this;
}
/**
* You will get one token provider for a DC
*
* @param url
* list of URL for authentication
*
* @return slef reference
*/
public StargateClientBuilder withApiTokenProvider(String... url) {
Assert.notNull(url, "url list");
return withApiTokenProviderDC(localDatacenter, url);
}
/**
* Provide token provider for a DC.
*
* @param dc
* datacentername
* @param tokenProvider
* token provider
* @return self reference
*/
public StargateClientBuilder withApiTokenProviderDC(String dc, TokenProvider tokenProvider) {
Assert.hasLength(dc, "dc");
if (!stargateNodesDC.containsKey(dc)) {
stargateNodesDC.put(dc, new StargateDataCenter(dc, tokenProvider));
}
stargateNodesDC.get(dc).setTokenProvider(tokenProvider);
return this;
}
/**
* You will get one token provider for a DC
*
* @param dc
* datacenter name
* @param url
* list of URL for authentication
* @return slef reference
*/
public StargateClientBuilder withApiTokenProviderDC(String dc, String... url) {
Assert.hasLength(dc, "dc");
Assert.notNull(url, "url list");
if (!Utils.hasLength(username)) {
throw new IllegalStateException("Username is empty please .withAuthCredentials() before .withApiTokenProvider()");
}
return withApiTokenProviderDC(dc, new TokenProviderHttpAuth(username, password, url));
}
// ------------------------------------------------
// ------- Topology of Nodes per DC --------------
// ------------------------------------------------
/** Local datacenter. */
protected String localDatacenter;
/**
* Add a node to the cluster.
* @param rest
* rest node
* @return
* current builder
*/
public StargateClientBuilder addServiceRest(ServiceHttp rest) {
return addServiceRest(localDatacenter, rest);
}
/**
* Populate current datacenter. Will be used as localDc in cqlSession if provided
* or local DC at Http level.
*
* @param dc
* target datacenter
* @param rest
* target service
* @return
* current reference
*/
public StargateClientBuilder addServiceRest(String dc, ServiceHttp rest) {
if (!stargateNodesDC.containsKey(dc)) {
stargateNodesDC.put(dc, new StargateDataCenter(dc));
}
this.stargateNodesDC.get(dc).addRestService(rest);
return this;
}
/**
* Populate current datacenter. Will be used as localDc in cqlSession if provided
* or local DC at Http level.
*
* @param dc
* target datacenter
* @param json
* target json service
* @return
* current reference
*/
public StargateClientBuilder addServiceJson(String dc, ServiceHttp json) {
if (!stargateNodesDC.containsKey(dc)) {
stargateNodesDC.put(dc, new StargateDataCenter(dc));
}
this.stargateNodesDC.get(dc).addJsonService(json);
return this;
}
/**
* Populate current datacenter. Will be used as localDc in cqlSession if provided
* or local DC at Http level.
*
* @param dc
* target datacenter
* @param rest
* target service
* @return
* current reference
*/
public StargateClientBuilder addDocumentService(String dc, ServiceHttp rest) {
if (!stargateNodesDC.containsKey(dc)) {
stargateNodesDC.put(dc, new StargateDataCenter(dc));
}
this.stargateNodesDC.get(dc).addDocumenService(rest);
return this;
}
/**
* Add a new Document Service.
*
* @param doc
* document service
* @return
* current reference
*/
public StargateClientBuilder addDocumentService(ServiceHttp doc) {
return addDocumentService(localDatacenter, doc);
}
/**
* Populate current datacenter. Will be used as localDc in cqlSession if provided
* or local DC at Http level.
*
* @param dc
* target datacenter
* @param rest
* target service
* @return
* current reference
*/
public StargateClientBuilder addGraphQLService(String dc, ServiceHttp rest) {
if (!stargateNodesDC.containsKey(dc)) {
stargateNodesDC.put(dc, new StargateDataCenter(dc));
}
this.stargateNodesDC.get(dc).addGraphQLService(rest);
return this;
}
/**
* Add a GraphQL Service in the current DC
* @param rest
* current graphQL service
* @return
* current reference.
*/
public StargateClientBuilder addGraphQLService(ServiceHttp rest) {
return addGraphQLService(localDatacenter, rest);
}
/**
* Populate current datacenter. Will be used as localDc in cqlSession if provided
* or local DC at Http level.
*
* @param dc
* target datacenter
* @param grpc
* target service
* @return
* current reference
*/
public StargateClientBuilder addGrpcService(String dc, ServiceGrpc grpc) {
if (!stargateNodesDC.containsKey(dc)) {
stargateNodesDC.put(dc, new StargateDataCenter(dc));
}
this.stargateNodesDC.get(dc).addGrpcService(grpc);
return this;
}
/**
* Populate current datacenter. Will be used as localDc in cqlSession if provided
* or local DC at Http level.
*
* @param grpc
* target service
* @return
* current reference
*/
public StargateClientBuilder addGrpcService(ServiceGrpc grpc) {
return addGrpcService(localDatacenter, grpc);
}
/**
* Populate current datacenter. Will be used as localDc in cqlSession if provided
* or local DC at Http level.
*
* @param localDc
* localDataCernter Name
* @return current reference
*/
public StargateClientBuilder withLocalDatacenter(String localDc) {
Assert.hasLength(localDc, "localDc");
setLocalDatacenter(localDc);
// Only when you do not use SCB
driverConfig.withString(DefaultDriverOption.LOAD_BALANCING_LOCAL_DATACENTER, localDc);
driverConfig.withBoolean(DefaultDriverOption.LOAD_BALANCING_DC_FAILOVER_ALLOW_FOR_LOCAL_CONSISTENCY_LEVELS, true);
cqlOptions.put(TypedDriverOption.LOAD_BALANCING_LOCAL_DATACENTER, localDc);
cqlOptions.put(TypedDriverOption.LOAD_BALANCING_DC_FAILOVER_ALLOW_FOR_LOCAL_CONSISTENCY_LEVELS, true);
return this;
}
/**
* Getter accessor for attribute 'localDC'.
*
* @return
* current value of 'localDC'
*/
public String getLocalDatacenter() {
return this.localDatacenter;
}
/**
* Update local datacenter without the cqlOptions. To also update the options please use withLocalDatacenter.
*
* @param localDc
* current value of localDC
*/
public void setLocalDatacenter(String localDc) {
this.localDatacenter = localDc;
}
// ------------------------------------------------
// ----- CqlSession ---------
// ------------------------------------------------
/** If the flag is enabled the Cql Session will not be created even if parameters are ok. */
protected boolean enabledCql = false;
/** Providing Ad Hoc CqlSession. */
protected CqlSession cqlSession = null;
/** Dynamic configuration. */
protected ProgrammaticDriverConfigLoaderBuilder driverConfig = new DefaultProgrammaticDriverConfigLoaderBuilder();
/**
* Track options in the object to help retrive values. The configuration is loaded with a Programmatic Loader and not the options Map.
**/
protected OptionsMap cqlOptions = OptionsMap.driverDefaults();
/** Metrics Registry if provided. */
protected Object cqlMetricsRegistry;
/** Request tracker. */
protected RequestTracker cqlRequestTracker;
/**
* By default Cqlsession is not created, you can enable the flag or using any
* withCql* operations to enableit.
*
* @return
* reference of current object
*/
public StargateClientBuilder enableCql() {
this.enabledCql = true;
return this;
}
/**
* Provide your own CqlSession skipping settings in the builder.
*
* @param cql
* existing session
* @return
* self reference
*/
public StargateClientBuilder withCqlSession(CqlSession cql) {
Assert.notNull(cql, "cqlSession");
checkNoCqlSession();
enableCql();
this.cqlSession = cql;
return this;
}
/**
* You want to initialize CqlSession with a configuration file
*
* @param configFile
* a configuration file
* @return the current reference
*/
public StargateClientBuilder withCqlDriverConfigurationFile(File configFile) {
Assert.notNull(configFile, "configFile");
Assert.isTrue(configFile.exists(), "Config file should exists");
return withCqlSession(CqlSession.builder()
.withConfigLoader(DriverConfigLoader.fromFile(configFile)).build());
}
/**
* Provide the proper programmatic config loader builder. It will be orverriden when
* used with Spring.
*
* @param pdclb
* builder
* @return
* current reference
*/
public StargateClientBuilder withCqlDriverConfigLoaderBuilder(ProgrammaticDriverConfigLoaderBuilder pdclb) {
this.driverConfig = pdclb;
return this;
}
/**
* Add a property to the Cql Context.
*
* @param option
* current option
* @param du
* option value
* @return
* current reference
*/
public StargateClientBuilder withCqlOptionBoolean(TypedDriverOption option, Boolean du) {
driverConfig.withBoolean(option.getRawOption(), du);
cqlOptions.put(option, du);
return this;
}
/**
* Add a propery to the Cql Context.
*
* @param dc
* targate datacenter
* @param option
* current option
* @param du
* option value
* @return
* current reference
*/
public StargateClientBuilder withCqlOptionBooleanDC(String dc, TypedDriverOption option, Boolean du) {
driverConfig.startProfile(dc).withBoolean(option.getRawOption(), du).endProfile();
cqlOptions.put(dc, option, du);
return this;
}
/**
* Add a property to the Cql Context.
*
* @param option
* current option
* @param du
* option value
* @return
* current reference
*/
public StargateClientBuilder withCqlOptionBooleanList(TypedDriverOption> option, List du) {
driverConfig.withBooleanList(option.getRawOption(), du);
cqlOptions.put(option, du);
return this;
}
/**
* Add a propery to the Cql Context.
*
* @param dc
* targate datacenter
* @param option
* current option
* @param du
* option value
* @return
* current reference
*/
public StargateClientBuilder withCqlOptionBooleanListDC(String dc, TypedDriverOption> option, List du) {
driverConfig.startProfile(dc).withBooleanList(option.getRawOption(), du).endProfile();
cqlOptions.put(dc, option, du);
return this;
}
/**
* Add a property to the Cql Context.
*
* @param option
* current option
* @param du
* option value
* @return
* current reference
*/
public StargateClientBuilder withCqlOptionClass(TypedDriverOption> option, Class du) {
driverConfig.withClass(option.getRawOption(), du);
cqlOptions.put(option, du);
return this;
}
/**
* Add a propery to the Cql Context.
*
* @param dc
* targate datacenter
* @param option
* current option
* @param du
* option value
* @return
* current reference
*/
public StargateClientBuilder withCqlOptionClassDC(String dc, TypedDriverOption> option, Class du) {
driverConfig.startProfile(dc).withClass(option.getRawOption(), du).endProfile();
cqlOptions.put(dc, option, du);
return this;
}
/**
* Add a property to the Cql Context.
*
* @param option
* current option
* @param du
* option value
* @return
* current reference
*/
public StargateClientBuilder withCqlOptionClassList(TypedDriverOption>> option, List> du) {
driverConfig.withClassList(option.getRawOption(), du);
cqlOptions.put(option, du);
return this;
}
/**
* Add a propery to the Cql Context.
*
* @param dc
* targate datacenter
* @param option
* current option
* @param du
* option value
* @return
* current reference
*/
public StargateClientBuilder withCqlOptionClassListDC(String dc, TypedDriverOption>> option, List> du) {
driverConfig.startProfile(dc).withClassList(option.getRawOption(), du).endProfile();
cqlOptions.put(dc, option, du);
return this;
}
/**
* Add a property to the Cql Context.
*
* @param option
* current option
* @param du
* option value
* @return
* current reference
*/
public StargateClientBuilder withCqlOptionDouble(TypedDriverOption option, Double du) {
driverConfig.withDouble(option.getRawOption(), du);
cqlOptions.put(option, du);
return this;
}
/**
* Add a propery to the Cql Context.
*
* @param dc
* targate datacenter
* @param option
* current option
* @param du
* option value
* @return
* current reference
*/
public StargateClientBuilder withCqlOptionDoubleDC(String dc, TypedDriverOption option, Double du) {
driverConfig.startProfile(dc).withDouble(option.getRawOption(), du).endProfile();
cqlOptions.put(dc, option, du);
return this;
}
/**
* Add a property to the Cql Context.
*
* @param option
* current option
* @param du
* option value
* @return
* current reference
*/
public StargateClientBuilder withCqlOptionDoubleList(TypedDriverOption> option, List du) {
driverConfig.withDoubleList(option.getRawOption(), du);
cqlOptions.put(option, du);
return this;
}
/**
* Add a propery to the Cql Context.
*
* @param dc
* targate datacenter
* @param option
* current option
* @param du
* option value
* @return
* current reference
*/
public StargateClientBuilder withCqlOptionDoubleListDC(String dc, TypedDriverOption> option, List du) {
driverConfig.startProfile(dc).withDoubleList(option.getRawOption(), du).endProfile();
cqlOptions.put(dc, option, du);
return this;
}
/**
* Add a property to the Cql Context.
*
* @param option
* current option
* @param du
* option value
* @return
* current reference
*/
public StargateClientBuilder withCqlOptionDuration(TypedDriverOption option, Duration du) {
driverConfig.withDuration(option.getRawOption(), du);
cqlOptions.put(option, du);
return this;
}
/**
* Add a propery to the Cql Context.
*
* @param dc
* targate datacenter
* @param option
* current option
* @param du
* option value
* @return
* current reference
*/
public StargateClientBuilder withCqlOptionDurationDC(String dc, TypedDriverOption option, Duration du) {
driverConfig.startProfile(dc).withDuration(option.getRawOption(), du).endProfile();
cqlOptions.put(dc, option, du);
return this;
}
/**
* Add a property to the Cql Context.
*
* @param option
* current option
* @param du
* option value
* @return
* current reference
*/
public StargateClientBuilder withCqlOptionDurationList(TypedDriverOption> option, List du) {
driverConfig.withDurationList(option.getRawOption(), du);
cqlOptions.put(option, du);
return this;
}
/**
* Add a propery to the Cql Context.
*
* @param dc
* targate datacenter
* @param option
* current option
* @param du
* option value
* @return
* current reference
*/
public StargateClientBuilder withCqlOptionDurationListDC(String dc, TypedDriverOption> option, List du) {
driverConfig.startProfile(dc).withDurationList(option.getRawOption(), du).endProfile();
cqlOptions.put(dc, option, du);
return this;
}
/**
* Add a property to the Cql Context.
*
* @param option
* current option
* @param du
* option value
* @return
* current reference
*/
public StargateClientBuilder withCqlOptionInteger(TypedDriverOption option, Integer du) {
driverConfig.withInt(option.getRawOption(), du);
cqlOptions.put(option, du);
return this;
}
/**
* Add a propery to the Cql Context.
*
* @param dc
* targate datacenter
* @param option
* current option
* @param du
* option value
* @return
* current reference
*/
public StargateClientBuilder withCqlOptionIntegerDC(String dc, TypedDriverOption option, Integer du) {
driverConfig.startProfile(dc).withInt(option.getRawOption(), du).endProfile();
cqlOptions.put(dc, option, du);
return this;
}
/**
* Add a property to the Cql Context.
*
* @param option
* current option
* @param du
* option value
* @return
* current reference
*/
public StargateClientBuilder withCqlOptionIntegerList(TypedDriverOption> option, List du) {
driverConfig.withIntList(option.getRawOption(), du);
cqlOptions.put(option, du);
return this;
}
/**
* Add a propery to the Cql Context.
*
* @param dc
* targate datacenter
* @param option
* current option
* @param du
* option value
* @return
* current reference
*/
public StargateClientBuilder withCqlOptionIntegerListDC(String dc, TypedDriverOption> option, List du) {
driverConfig.startProfile(dc).withIntList(option.getRawOption(), du).endProfile();
cqlOptions.put(dc, option, du);
return this;
}
/**
* Add a property to the Cql Context.
*
* @param option
* current option
* @param du
* option value
* @return
* current reference
*/
public StargateClientBuilder withCqlOptionLong(TypedDriverOption option, Long du) {
driverConfig.withLong(option.getRawOption(), du);
cqlOptions.put(option, du);
return this;
}
/**
* Add a propery to the Cql Context.
*
* @param dc
* targate datacenter
* @param option
* current option
* @param du
* option value
* @return
* current reference
*/
public StargateClientBuilder withCqlOptionLongDC(String dc, TypedDriverOption option, Long du) {
driverConfig.startProfile(dc).withLong(option.getRawOption(), du).endProfile();
cqlOptions.put(dc, option, du);
return this;
}
/**
* Add a property to the Cql Context.
*
* @param option
* current option
* @param du
* option value
* @return
* current reference
*/
public StargateClientBuilder withCqlOptionLongList(TypedDriverOption> option, List du) {
driverConfig.withLongList(option.getRawOption(), du);
cqlOptions.put(option, du);
return this;
}
/**
* Add a propery to the Cql Context.
*
* @param dc
* targate datacenter
* @param option
* current option
* @param du
* option value
* @return
* current reference
*/
public StargateClientBuilder withCqlOptionLongListDC(String dc, TypedDriverOption> option, List du) {
driverConfig.startProfile(dc).withLongList(option.getRawOption(), du).endProfile();
cqlOptions.put(dc, option, du);
return this;
}
/**
* Add a property to the Cql Context.
*
* @param option
* current option
* @param du
* option value
* @return
* current reference
*/
public StargateClientBuilder withCqlOptionString(TypedDriverOption option, String du) {
driverConfig.withString(option.getRawOption(), du);
cqlOptions.put(option, du);
return this;
}
/**
* Add a propery to the Cql Context.
*
* @param dc
* targate datacenter
* @param option
* current option
* @param du
* option value
* @return
* current reference
*/
public StargateClientBuilder withCqlOptionStringDC(String dc, TypedDriverOption option, String du) {
driverConfig.startProfile(dc).withString(option.getRawOption(), du).endProfile();
cqlOptions.put(dc, option, du);
return this;
}
/**
* Add a property to the Cql Context.
*
* @param option
* current option
* @param du
* option value
* @return
* current reference
*/
public StargateClientBuilder withCqlOptionStringList(TypedDriverOption> option, List du) {
driverConfig.withStringList(option.getRawOption(), du);
cqlOptions.put(option, du);
return this;
}
/**
* Add a propery to the Cql Context.
*
* @param dc
* targate datacenter
* @param option
* current option
* @param du
* option value
* @return
* current reference
*/
public StargateClientBuilder withCqlOptionStringListDC(String dc, TypedDriverOption> option, List du) {
driverConfig.startProfile(dc).withStringList(option.getRawOption(), du).endProfile();
cqlOptions.put(dc, option, du);
return this;
}
/**
* Metrics registry.
*
* @param registry
* target metrics registry
* @return
* client config
*/
public StargateClientBuilder withCqlMetricsRegistry(Object registry) {
Assert.notNull(registry, "registry");
checkNoCqlSession();
cqlMetricsRegistry = registry;
return this;
}
/**
* CqlRequest Tracker registry.
*
* @param cqlReqTracker
* cql tracker
* @return
* client config
*/
public StargateClientBuilder withCqlRequestTracker(RequestTracker cqlReqTracker) {
Assert.notNull(cqlReqTracker, "RequestTracker");
checkNoCqlSession();
this.cqlRequestTracker = cqlReqTracker;
return this;
}
/**
* Set the consistency level
*
* @param cl
* current consitency level
* @return self reference
*/
public StargateClientBuilder withCqlConsistencyLevel(ConsistencyLevel cl) {
Assert.notNull(cl, "consistency level");
driverConfig.withString(DefaultDriverOption.REQUEST_CONSISTENCY, cl.name());
// To be reused when dc failover
cqlOptions.put(this.localDatacenter, TypedDriverOption.REQUEST_CONSISTENCY, cl.name());
return this;
}
/**
* Define consistency level for a DC.
*
* @param dc
* datacenter name
* @param cl
* consistency level
* @return self reference
*/
public StargateClientBuilder withCqlConsistencyLevelDC(String dc, ConsistencyLevel cl) {
Assert.hasLength(dc, "dc, datacenter name");
Assert.notNull(cl, "consistency level");
driverConfig.startProfile(dc).withString(DefaultDriverOption.REQUEST_CONSISTENCY, cl.name()).endProfile();
// To be reused when dc failover
cqlOptions.put(dc, TypedDriverOption.REQUEST_CONSISTENCY, cl.name());
return this;
}
/**
* Fill contact points.
*
* @param contactPoints
* contact points
* @return current reference
*/
public StargateClientBuilder withCqlContactPoints(String... contactPoints) {
Assert.notNull(contactPoints, "contactPoints");
Assert.isTrue(contactPoints.length>0, "contactPoints should not be null");
Assert.hasLength(contactPoints[0], "one contact point");
driverConfig.withStringList(DefaultDriverOption.CONTACT_POINTS, Arrays.asList(contactPoints));
// To be reused when dc failover
cqlOptions.put(this.localDatacenter, TypedDriverOption.CONTACT_POINTS, Arrays.asList(contactPoints));
return this;
}
/**
* Fill contact points.
*
* @param dc
* datacenter name
* @param contactPoints
* contact points
* @return current reference
*/
public StargateClientBuilder withCqlContactPointsDC(String dc, String... contactPoints) {
Assert.notNull(contactPoints, "contactPoints");
Assert.isTrue(contactPoints.length>0, "contactPoints should not be null");
Assert.hasLength(contactPoints[0], "one contact point");
Assert.hasLength(dc, "dc, datacenter name");
driverConfig.startProfile(dc).withStringList(DefaultDriverOption.CONTACT_POINTS, Arrays.asList(contactPoints)).endProfile();
// To be reused when dc failover
cqlOptions.put(dc, TypedDriverOption.CONTACT_POINTS, Arrays.asList(contactPoints));
return this;
}
/**
* Fill Keyspaces.
*
* @param keyspace
* keyspace name
* @return current reference
*/
public StargateClientBuilder withCqlKeyspace(String keyspace) {
Assert.hasLength(keyspace, "keyspace");
driverConfig.withString(DefaultDriverOption.SESSION_KEYSPACE, keyspace);
// To be reused when dc failover
cqlOptions.put(TypedDriverOption.SESSION_KEYSPACE, keyspace);
return this;
}
/**
* Providing SCB. (note it is one per Region).
*
* @param cloudConfigUrl
* configuration
* @return current reference
*/
public StargateClientBuilder withCqlCloudSecureConnectBundle(String cloudConfigUrl) {
Assert.hasLength(cloudConfigUrl, "cloudConfigUrl");
driverConfig.withString(DefaultDriverOption.CLOUD_SECURE_CONNECT_BUNDLE, cloudConfigUrl);
cqlOptions.put(this.localDatacenter, TypedDriverOption.CLOUD_SECURE_CONNECT_BUNDLE, cloudConfigUrl);
return this;
}
/**
* Providing SCB. (note it is one per Region).
*
* @param dc
* datacenter name
* @param cloudConfigUrl
* configuration
* @return current reference
*/
public StargateClientBuilder withCqlCloudSecureConnectBundleDC(String dc, String cloudConfigUrl) {
Assert.hasLength(cloudConfigUrl, "cloudConfigUrl");
driverConfig.withString(DefaultDriverOption.CLOUD_SECURE_CONNECT_BUNDLE, cloudConfigUrl);
cqlOptions.put(dc, TypedDriverOption.CLOUD_SECURE_CONNECT_BUNDLE, cloudConfigUrl);
return this;
}
/**
* Getter accessor for attribute 'disableCqlSession'.
*
* @return
* current value of 'disableCqlSession'
*/
public boolean isEnabledCql() {
return this.enabledCql;
}
/**
* Getter accessor for attribute 'cqlSession'.
*
* @return
* current value of 'cqlSession'
*/
public CqlSession getCqlSession() {
return this.cqlSession;
}
/**
* Getter accessor for attribute 'cqloptions'.
*
* @return
* value for cql option
*/
public OptionsMap getCqlOptions() {
return this.cqlOptions;
}
/**
* Getter accessor for attribute 'cqlRequestTracker'.
*
* @return
* current value of 'cqlRequestTracker'
*/
public RequestTracker getCqlRequestTracker() {
return this.cqlRequestTracker;
}
/**
* Accessor to driver config builder.
*
* @return
* driver config builder
*/
public ProgrammaticDriverConfigLoaderBuilder getCqlDriverConfigLoaderBuilder() {
return driverConfig;
}
/**
* Getter accessor for attribute 'metricsRegistry'.
*
* @return
* current value of 'metricsRegistry'
*/
public Object getCqlMetricsRegistry() {
return this.cqlMetricsRegistry;
}
/**
* When working with builder you do no want the Cqlsession provided ad hoc.
*/
private void checkNoCqlSession() {
if (cqlSession != null) {
throw new IllegalArgumentException("You cannot provide CqlOptions if a external CqlSession is used.");
}
}
// ------------------------------------------------
// ----- Grpc Session ---------
// ------------------------------------------------
/** If the flag is enabled the Grpc Session will not be created even if parameters are ok. */
protected boolean enabledGrpc = false;
/**
* By default Cqlsession is not created, you can enable the flag or using any
* withCql* operations to enableit.
*
* @return
* reference of current object
*/
public StargateClientBuilder enableGrpc() {
this.enabledGrpc = true;
return this;
}
/**
* Getter accessor for attribute 'disableCqlSession'.
*
* @return
* current value of 'disableCqlSession'
*/
public boolean isEnabledGrpc() {
return this.enabledGrpc;
}
// ------------------------------------------------
// ------------- HTTP Client ----------------------
// ------------------------------------------------
/** Override Retry configuration. */
protected RetryConfig httpRetryConfig;
/** Override Request configuration. */
protected RequestConfig httpRequestConfig;
/** Observers. */
protected Map httpObservers = new HashMap<>();
/**
* Enable fine Grained configuration of the HTTP Client.
*
* @param reqConfig
* request configuration
* @return self reference
*/
public StargateClientBuilder withHttpRequestConfig(RequestConfig reqConfig) {
Assert.notNull(reqConfig, "RequestConfig");
this.httpRequestConfig = reqConfig;
return this;
}
/**
* Enable fine Grained configuration of the HTTP Retries.
*
* @param retryConfig
* request configuration
* @return self reference
*/
public StargateClientBuilder withHttpRetryConfig(RetryConfig retryConfig) {
Assert.notNull(retryConfig, "retryConfig");
this.httpRetryConfig = retryConfig;
return this;
}
/**
* Api Invocations trigger some events processed in observer.
*
* @param name
* unique identiier
* @param observer
* instance of your Observer
* @return self reference
*/
public StargateClientBuilder addHttpObserver(String name, ServiceCallObserver observer) {
Assert.hasLength(name, "Observer name");
Assert.notNull(observer, "observer");
if (this.httpObservers.containsKey(name)) {
throw new IllegalArgumentException("An observer with the same name already exists (type=" +
this.httpObservers.get(name).getClass().getName() + ")");
}
this.httpObservers.put(name, observer);
return this;
}
/**
* Api Invocations trigger some events processed in observer.
*
* @param observers
* instance of your Observer
* @return self reference
*/
public StargateClientBuilder withHttpObservers(Map observers) {
Assert.notNull(observers, "observers");
Assert.isTrue(observers.size()>0, "observers should not be empty");
this.httpObservers = observers;
return this;
}
/**
* Getter accessor for attribute 'retryConfig'.
*
* @return
* current value of 'retryConfig'
*/
public RetryConfig getRetryConfig() {
return httpRetryConfig;
}
/**
* Getter accessor for attribute 'requestConfig'.
*
* @return
* current value of 'requestConfig'
*/
public RequestConfig getRequestConfig() {
return httpRequestConfig;
}
/**
* Getter accessor for attribute 'observers'.
*
* @return
* current value of 'observers'
*/
public Map getObservers() {
return httpObservers;
}
// ------------------------------------------------
// ------------------ MAIN -----------------------
// ------------------------------------------------
/**
* Load defaults from Emvironment variables
*/
public StargateClientBuilder() {
}
/**
* Building a StargateClient from the values in the BUILDER
*
* @return
* instance of the client
*/
public StargateClient build() {
return new StargateClient(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy