org.apache.solr.handler.admin.api.SplitShardAPI Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of solr-core Show documentation
Apache Solr (module: core)
There is a newer version: 9.7.0
/*
 * 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.handler.admin.api;

import static org.apache.solr.client.solrj.SolrRequest.METHOD.POST;
import static org.apache.solr.common.params.CollectionAdminParams.COLLECTION;
import static org.apache.solr.common.params.CollectionAdminParams.PROPERTY_PREFIX;
import static org.apache.solr.common.params.CommonParams.ACTION;
import static org.apache.solr.handler.ClusterAPI.wrapParams;
import static org.apache.solr.handler.api.V2ApiUtils.flattenMapWithPrefix;
import static org.apache.solr.security.PermissionNameProvider.Name.COLL_EDIT_PERM;

import java.util.HashMap;
import java.util.Map;
import org.apache.solr.api.Command;
import org.apache.solr.api.EndPoint;
import org.apache.solr.api.PayloadObj;
import org.apache.solr.client.solrj.request.beans.SplitShardPayload;
import org.apache.solr.common.params.CollectionParams;
import org.apache.solr.common.params.CommonAdminParams;
import org.apache.solr.common.util.StrUtils;
import org.apache.solr.handler.admin.CollectionsHandler;

/**
 * V2 API for splitting an existing shard up into multiple pieces.
 *
 * This API (POST /v2/collections/collectionName/shards {'split': {...}}) is analogous to the v1
 * /admin/collections?action=SPLITSHARD command.
 *
 * @see SplitShardPayload
 */
@EndPoint(
    path = {"/c/{collection}/shards", "/collections/{collection}/shards"},
    method = POST,
    permission = COLL_EDIT_PERM)
public class SplitShardAPI {
  private static final String V2_SPLIT_CMD = "split";

  private final CollectionsHandler collectionsHandler;

  public SplitShardAPI(CollectionsHandler collectionsHandler) {
    this.collectionsHandler = collectionsHandler;
  }

  @Command(name = V2_SPLIT_CMD)
  public void splitShard(PayloadObj obj) throws Exception {
    final SplitShardPayload v2Body = obj.get();
    final Map v1Params = v2Body.toMap(new HashMap<>());
    v1Params.put(ACTION, CollectionParams.CollectionAction.SPLITSHARD.toLower());
    v1Params.put(COLLECTION, obj.getRequest().getPathTemplateValues().get(COLLECTION));

    if (StrUtils.isNotNullOrEmpty(v2Body.splitKey)) {
      v1Params.put(CommonAdminParams.SPLIT_KEY, v2Body.splitKey);
    }
    flattenMapWithPrefix(v2Body.coreProperties, v1Params, PROPERTY_PREFIX);
    collectionsHandler.handleRequestBody(wrapParams(obj.getRequest(), v1Params), obj.getResponse());
  }
}