Uploaded image for project: 'Solr'
  1. Solr
  2. SOLR-10850

HttpSolrClient Javadoc examples reference nonexistent constructors

    XMLWordPrintableJSON

    Details

    • Type: Bug
    • Status: Resolved
    • Priority: Minor
    • Resolution: Duplicate
    • Affects Version/s: 7.0
    • Fix Version/s: 7.0
    • Component/s: SolrJ
    • Labels:
      None

      Description

      A recent JIRA removed a number of deprecated constructors from the SolrClient implementations.

      In the case of HttpSolrClient, the top-level Javadocs contain instantiation instructions that still reference the old constructors:

      e.g.

      /**
       * A SolrClient implementation that talks directly to a Solr server via HTTP
       *
       * There are two ways to use an HttpSolrClient:
       *
       * 1) Pass a URL to the constructor that points directly at a particular core
       * <pre>
       *   SolrClient client = new HttpSolrClient("http://my-solr-server:8983/solr/core1");
       *   QueryResponse resp = client.query(new SolrQuery("*:*"));
       * </pre>
       * In this case, you can query the given core directly, but you cannot query any other
       * cores or issue CoreAdmin requests with this client.
       *
       * 2) Pass the base URL of the node to the constructor
       * <pre>
       *   SolrClient client = new HttpSolrClient("http://my-solr-server:8983/solr");
       *   QueryResponse resp = client.query("core1", new SolrQuery("*:*"));
       * </pre>
       * In this case, you must pass the name of the required core for all queries and updates,
       * but you may use the same client for all cores, and for CoreAdmin requests.
       */
      

      These Javadocs should be updated with examples that use the client Builder types.

        Attachments

        1. SOLR-10850.patch
          2 kB
          Jason Gerlowski

          Issue Links

            Activity

              People

              • Assignee:
                Unassigned
                Reporter:
                gerlowskija Jason Gerlowski
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: