io.vertx.cassandra.CassandraClientOptions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vertx-cassandra-client Show documentation
There is a newer version: 5.0.0.CR3
Show newest version
/*
 * Copyright 2018 The Vert.x Community.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.vertx.cassandra;

import com.datastax.oss.driver.api.core.CqlSession;
import com.datastax.oss.driver.api.core.CqlSessionBuilder;
import io.vertx.codegen.annotations.DataObject;
import io.vertx.codegen.json.annotations.JsonGen;
import io.vertx.core.json.JsonObject;
import io.vertx.core.tracing.TracingPolicy;

import java.net.InetSocketAddress;

/**
 * Eclipse Vert.x Cassandra client options.
 *
 * @author Pavel Drankou
 * @author Thomas Segismont
 */
@DataObject
@JsonGen(publicConverter = false)
public class CassandraClientOptions {

  /**
   * Default port for connecting with Cassandra service.
   */
  public static final int DEFAULT_PORT = 9042;

  /**
   * Default host for connecting with Cassandra service.
   */
  public static final String DEFAULT_HOST = "localhost";

  private final CqlSessionBuilder builder;

  private String keyspace;
  private String username;
  private String password;
  private TracingPolicy tracingPolicy;

  /**
   * Default constructor.
   */
  public CassandraClientOptions() {
    this(CqlSession.builder());
  }

  /**
   * Copy constructor.
   * @param other The other client to copy from.
   */
  public CassandraClientOptions(CassandraClientOptions other) {
    this(other.dataStaxClusterBuilder());
    this.setKeyspace(other.getKeyspace());
    tracingPolicy = other.tracingPolicy;
  }

  /**
   * Constructor using an existing {@link CqlSessionBuilder} instance.
   */
  public CassandraClientOptions(CqlSessionBuilder builder) {
    this.builder = builder;
    this.tracingPolicy = TracingPolicy.PROPAGATE;
  }

  /**
   * Constructor to create options from JSON.
   *
   * @param json the JSON
   */
  public CassandraClientOptions(JsonObject json) {
    this();
    CassandraClientOptionsConverter.fromJson(json, this);
  }

  /**
   * @return a JSON representation of these options
   */
  public JsonObject toJson() {
    JsonObject json = new JsonObject();
    CassandraClientOptionsConverter.toJson(this, json);
    return json;
  }

  /**
   * Adds a contact point to use for the initial connection to the cluster
   *
   * @param address the address
   * @return a reference to this, so the API can be used fluently
   */
  public CassandraClientOptions addContactPoint(InetSocketAddress address) {
    builder.addContactPoint(address);
    return this;
  }

  /**
   * Adds a contact point to use for the initial connection to the cluster
   *
   * @param host the address
   * @param port the port
   * @return a reference to this, so the API can be used fluently
   */
  public CassandraClientOptions addContactPoint(String host, int port) {
    builder.addContactPoint(InetSocketAddress.createUnresolved(host, port));
    return this;
  }

  /**
   * @return a cluster builder, which will be used by the client
   */
  public CqlSessionBuilder dataStaxClusterBuilder() {
    return builder;
  }

  /**
   * @return the keyspace to use when creating the Cassandra session
   */
  public String getKeyspace() {
    return keyspace;
  }

  /**
   * Set the keyspace to use when creating the Cassandra session. Defaults to {@code null}.
   *
   * @param keyspace the keyspace to use when creating the Cassandra session
   *
   * @return a reference to this, so the API can be used fluently
   */
  public CassandraClientOptions setKeyspace(String keyspace) {
    this.keyspace = keyspace;
    builder.withKeyspace(keyspace);
    return this;
  }

  /**
   * @return the username if plaintext authentication is used
   */
  public String getUsername() {
    return username;
  }

  /**
   * Set the username for plaintext authentication. Defaults to {@code null}.
   *
   * @param username the username for plaintext authentication
   * @return a reference to this, so the API can be used fluently
   */
  public CassandraClientOptions setUsername(String username) {
    this.username = username;
    setAuth();
    return this;
  }

  private void setAuth() {
    if (username == null || password == null) {
      builder.withAuthProvider(null);
    } else {
      builder.withAuthCredentials(username, password);
    }
  }

  /**
   * @return the password if plaintext authentication is used
   */
  public String getPassword() {
    return password;
  }

  /**
   * Set the password for plaintext authentication. Defaults to {@code null}.
   *
   * @param password the username for plaintext authentication
   * @return a reference to this, so the API can be used fluently
   */
  public CassandraClientOptions setPassword(String password) {
    this.password = password;
    setAuth();
    return this;
  }

  /**
   * @return the tracing policy
   */
  public TracingPolicy getTracingPolicy() {
    return tracingPolicy;
  }

  /**
   * Set the tracing policy for the client behavior when Vert.x has tracing enabled.
   *
   * @param tracingPolicy the tracing policy
   * @return a reference to this, so the API can be used fluently
   */
  public CassandraClientOptions setTracingPolicy(TracingPolicy tracingPolicy) {
    this.tracingPolicy = tracingPolicy;
    return this;
  }
}