Interface SolrBackend

solr/test-framework/src/java/org/apache/solr/SolrBackend.java:42–168

Abstraction over a running Solr deployment for use in tests and benchmarks. The abstraction normalizes how to shut down and perform other common operations as the methods indicate.

 * normalizes how to shut down and perform other common operations as the methods indicate.
 */
public interface SolrBackend extends AutoCloseable {

  /**
   * Creates a new {@link SolrClient} defaulted to the given collection. The <em>caller</em> owns
   * this client and is responsible for closing it. Callers that want a long-lived client should
   * cache it themselves.
   */
  SolrClient newSolrClient(String collection);

  /**
   * Returns the node / admin (collection-less) {@link SolrClient} owned by this backend. The caller
   * must NOT close it; it is released when this backend is {@link #close()}d. A {@link
   * CloudSolrClient} should be returned if appropriate. While it *can* be used to target specific
   * collections, please use {@link #newSolrClient(String)} for that instead.
   */
  SolrClient getSolrClient();

  /**
   * Upload a configSet, possibly overwriting (creating files, updating files, NOT deleting files).
   *
   * @param configDir a path to the config set to upload
   * @param name the name to give the configSet
   */
  default void uploadConfigSet(Path configDir, String name)
      throws SolrServerException, IOException {
    getCoreContainer().getConfigSetService().uploadConfig(name, configDir);
  }

  /**
   * Checks if a configSet with the given name exists.
   *
   * @param name configSet name to check
   * @return true if the configSet exists, false otherwise
   */
  default boolean hasConfigSet(String name) throws SolrServerException, IOException {
    return getCoreContainer().getConfigSetService().checkConfigExists(name);
  }

  /**
   * Creates a collection (or core for single-node backends). Cloud backends honour {@code
   * numShards} and {@code replicationFactor}; single-node backends ({@link JettySolrRunner}, {@link
   * EmbeddedSolrBackend}) ignore those fields. Callers should use {@link #hasCollection(String)}
   * first if they want to avoid errors when the collection already exists. Tests/benchmarks that
   * want to test how this works should not use this to do so.
   */
  void createCollection(CollectionAdminRequest.Create create)
      throws SolrServerException, IOException;

  /**
   * Checks if a collection or core with the given name exists.
   *
   * @param name collection or core name to check
   * @return true if the collection/core exists, false otherwise
   */
  boolean hasCollection(String name) throws SolrServerException, IOException;

  /** Reloads a collection or core by this name. The purpose is typically to clear caches. */
  default void reloadCollection(String name) throws SolrServerException, IOException {