org.apache.solr.client.solrj.request.ClusterApi Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of solr-solrj Show documentation
Apache Solr Solrj
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.solr.client.solrj.request;

import java.util.Set;
import org.apache.solr.client.api.model.BalanceReplicasRequestBody;
import org.apache.solr.client.api.model.MigrateReplicasRequestBody;
import org.apache.solr.client.solrj.JacksonContentWriter;
import org.apache.solr.client.solrj.JacksonParsingResponse;
import org.apache.solr.client.solrj.ResponseParser;
import org.apache.solr.client.solrj.SolrClient;
import org.apache.solr.client.solrj.SolrRequest;
import org.apache.solr.client.solrj.impl.InputStreamResponseParser;
import org.apache.solr.common.params.ModifiableSolrParams;
import org.apache.solr.common.params.SolrParams;

// WARNING: This class is generated from a Mustache template; any intended
// changes should be made to the underlying template and not this file directly.

/**
 * Experimental SolrRequest's and SolrResponse's for cluster, generated from an OAS.
 *
 * See individual request and response classes for more detailed and relevant information.
 *
 * All SolrRequest implementations rely on v2 APIs which may require a SolrClient configured to
 * use the '/api' path prefix, instead of '/solr'.
 *
 * @lucene.experimental
 */
public class ClusterApi {

  public static class BalanceReplicasResponse
      extends JacksonParsingResponse {
    public BalanceReplicasResponse() {
      super(org.apache.solr.client.api.model.SolrJerseyResponse.class);
    }
  }

  public static class BalanceReplicas extends SolrRequest {
    private final BalanceReplicasRequestBody requestBody;

    /** Create a BalanceReplicas request object. */
    public BalanceReplicas() {
      super(SolrRequest.METHOD.valueOf("POST"), "/cluster/replicas/balance");

      this.requestBody = new BalanceReplicasRequestBody();
      addHeader("Content-type", "application/json");
    }

    // TODO find a way to add required parameters in the request body to the class constructor
    /**
     * @param nodes The set of nodes across which replicas will be balanced. Defaults to all live
     *     data nodes.
     */
    public void setNodes(Set nodes) {
      this.requestBody.nodes = nodes;
    }

    // TODO find a way to add required parameters in the request body to the class constructor
    /**
     * @param waitForFinalState If true, the request will complete only when all affected replicas
     *     become active. If false, the API will return the status of the single action, which may
     *     be before the new replica is online and active.
     */
    public void setWaitForFinalState(Boolean waitForFinalState) {
      this.requestBody.waitForFinalState = waitForFinalState;
    }

    // TODO find a way to add required parameters in the request body to the class constructor
    /**
     * @param async Request ID to track this action which will be processed asynchronously.
     */
    public void setAsync(String async) {
      this.requestBody.async = async;
    }

    @Override
    @SuppressWarnings("unchecked")
    public RequestWriter.ContentWriter getContentWriter(String expectedType) {
      return new JacksonContentWriter(expectedType, requestBody);
    }

    // TODO Hardcode this for now, but in reality we'll want to parse this out of the Operation data
    // somehow
    @Override
    public String getRequestType() {
      return SolrRequestType.ADMIN.toString();
    }

    @Override
    public SolrParams getParams() {
      final ModifiableSolrParams params = new ModifiableSolrParams();
      return params;
    }

    @Override
    protected BalanceReplicasResponse createResponse(SolrClient client) {
      return new BalanceReplicasResponse();
    }

    @Override
    public ResponseParser getResponseParser() {
      return new InputStreamResponseParser("json");
    }
  }

  public static class MigrateReplicasResponse
      extends JacksonParsingResponse {
    public MigrateReplicasResponse() {
      super(org.apache.solr.client.api.model.SolrJerseyResponse.class);
    }
  }

  public static class MigrateReplicas extends SolrRequest {
    private final MigrateReplicasRequestBody requestBody;

    /** Create a MigrateReplicas request object. */
    public MigrateReplicas() {
      super(SolrRequest.METHOD.valueOf("POST"), "/cluster/replicas/migrate");

      this.requestBody = new MigrateReplicasRequestBody();
      addHeader("Content-type", "application/json");
    }

    // TODO find a way to add required parameters in the request body to the class constructor
    /**
     * @param sourceNodes The set of nodes which all replicas will be migrated off of.
     */
    public void setSourceNodes(Set sourceNodes) {
      this.requestBody.sourceNodes = sourceNodes;
    }

    // TODO find a way to add required parameters in the request body to the class constructor
    /**
     * @param targetNodes A set of nodes to migrate the replicas to. If this is not provided, then
     *     the API will use the live data nodes not in 'sourceNodes'.
     */
    public void setTargetNodes(Set targetNodes) {
      this.requestBody.targetNodes = targetNodes;
    }

    // TODO find a way to add required parameters in the request body to the class constructor
    /**
     * @param waitForFinalState If true, the request will complete only when all affected replicas
     *     become active. If false, the API will return the status of the single action, which may
     *     be before the new replicas are online and active.
     */
    public void setWaitForFinalState(Boolean waitForFinalState) {
      this.requestBody.waitForFinalState = waitForFinalState;
    }

    // TODO find a way to add required parameters in the request body to the class constructor
    /**
     * @param async Request ID to track this action which will be processed asynchronously.
     */
    public void setAsync(String async) {
      this.requestBody.async = async;
    }

    @Override
    @SuppressWarnings("unchecked")
    public RequestWriter.ContentWriter getContentWriter(String expectedType) {
      return new JacksonContentWriter(expectedType, requestBody);
    }

    // TODO Hardcode this for now, but in reality we'll want to parse this out of the Operation data
    // somehow
    @Override
    public String getRequestType() {
      return SolrRequestType.ADMIN.toString();
    }

    @Override
    public SolrParams getParams() {
      final ModifiableSolrParams params = new ModifiableSolrParams();
      return params;
    }

    @Override
    protected MigrateReplicasResponse createResponse(SolrClient client) {
      return new MigrateReplicasResponse();
    }

    @Override
    public ResponseParser getResponseParser() {
      return new InputStreamResponseParser("json");
    }
  }
}