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

Go to download
/*
 * 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;

/**
 * Produces {@link EndPoint} instances representing the connection information to every node.
 *
 * This component is reserved for advanced use cases where the driver needs more than an IP
 * address to connect.
 *
 * Note that if endpoints do not translate to addresses 1-to-1, the auth provider and SSL options
 * should be instances of {@link ExtendedAuthProvider} and {@link
 * ExtendedRemoteEndpointAwareSslOptions} respectively.
 */
public interface EndPointFactory {

  void init(Cluster cluster);

  /**
   * Creates an instance from a row in {@code system.peers}, or returns {@code null} if there is no
   * sufficient information.
   */
  EndPoint create(Row peersRow);
}