com.datastax.driver.core.SSLOptions Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dse-java-driver-core Show documentation

A driver for DataStax Enterprise (DSE) and Apache Cassandra 1.2+ clusters that works exclusively with the Cassandra Query Language version 3 (CQL3) and Cassandra's binary protocol, supporting DSE-specific features such as geospatial types, DSE Graph and DSE authentication.

There is a newer version: 2.4.0

Show newest version

/*
 * Copyright DataStax, Inc.
 *
 * This software can be used solely with DataStax Enterprise. Please consult the license at
 * http://www.datastax.com/terms/datastax-dse-driver-license-terms
 */
package com.datastax.driver.core;

import io.netty.channel.socket.SocketChannel;
import io.netty.handler.ssl.SslHandler;
import java.net.InetSocketAddress;

/**
 * Defines how the driver configures SSL connections.
 *
 * Note: since version 3.2.0, users are encouraged to implement {@link
 * RemoteEndpointAwareSSLOptions} instead.
 *
 * @see RemoteEndpointAwareSSLOptions
 * @see JdkSSLOptions
 * @see NettySSLOptions
 */
@SuppressWarnings("deprecation")
public interface SSLOptions {

  /**
   * Creates a new SSL handler for the given Netty channel.
   *
   * 
This gets called each time the driver opens a new connection to a Cassandra host. The newly
   * created handler will be added to the channel's pipeline to provide SSL support for the
   * connection.
   *
   * You don't necessarily need to implement this method directly; see the provided
   * implementations: {@link JdkSSLOptions} and {@link NettySSLOptions}.
   *
   * @param channel the channel.
   * @return the handler.
   * @deprecated use {@link RemoteEndpointAwareSSLOptions#newSSLHandler(SocketChannel,
   *     InetSocketAddress)} instead.
   */
  @SuppressWarnings("DeprecatedIsStillUsed")
  @Deprecated
  SslHandler newSSLHandler(SocketChannel channel);
}