gerlowskija commented on code in PR #1471: URL: https://github.com/apache/solr/pull/1471#discussion_r1169097982
########## solr/core/src/java/org/apache/solr/handler/admin/api/CreateCollectionSnapshotAPI.java: ########## @@ -0,0 +1,162 @@ +/* + * 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.impl.BinaryResponseParser.BINARY_CONTENT_TYPE_V2; +import static org.apache.solr.cloud.Overseer.QUEUE_OPERATION; +import static org.apache.solr.common.cloud.ZkStateReader.COLLECTION_PROP; +import static org.apache.solr.common.params.CollectionAdminParams.FOLLOW_ALIASES; +import static org.apache.solr.common.params.CommonAdminParams.ASYNC; +import static org.apache.solr.handler.admin.CollectionsHandler.DEFAULT_COLLECTION_OP_TIMEOUT; +import static org.apache.solr.security.PermissionNameProvider.Name.COLL_EDIT_PERM; + +import com.fasterxml.jackson.annotation.JsonProperty; +import io.swagger.v3.oas.annotations.Parameter; +import io.swagger.v3.oas.annotations.media.Schema; +import io.swagger.v3.oas.annotations.parameters.RequestBody; +import java.util.HashMap; +import java.util.Map; +import javax.inject.Inject; +import javax.ws.rs.POST; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.Produces; +import org.apache.solr.client.solrj.SolrResponse; +import org.apache.solr.common.SolrException; +import org.apache.solr.common.cloud.SolrZkClient; +import org.apache.solr.common.cloud.ZkNodeProps; +import org.apache.solr.common.params.CollectionParams; +import org.apache.solr.common.params.CoreAdminParams; +import org.apache.solr.core.CoreContainer; +import org.apache.solr.core.snapshots.SolrSnapshotManager; +import org.apache.solr.handler.admin.CollectionsHandler; +import org.apache.solr.jersey.AsyncJerseyResponse; +import org.apache.solr.jersey.JacksonReflectMapWriter; +import org.apache.solr.jersey.PermissionName; +import org.apache.solr.request.SolrQueryRequest; +import org.apache.solr.response.SolrQueryResponse; + +/** V2 API for Creating Collection Snapshots. */ +@Path("/collections/{collName}/snapshots") +public class CreateCollectionSnapshotAPI extends AdminAPIBase { + + @Inject + public CreateCollectionSnapshotAPI( + CoreContainer coreContainer, + SolrQueryRequest solrQueryRequest, + SolrQueryResponse solrQueryResponse) { + super(coreContainer, solrQueryRequest, solrQueryResponse); + } + + /** This API is analogous to V1's (POST /solr/admin/collections?action=CREATESNAPSHOT) */ + @POST + @Path("/{snapshotName}") + @Produces({"application/json", "application/xml", BINARY_CONTENT_TYPE_V2}) + @PermissionName(COLL_EDIT_PERM) + public CreateSnapshotResponse createSnapshot( + @Parameter(description = "The name of the collection.", required = true) + @PathParam("collName") + String collName, + @Parameter(description = "The name of the snapshot to be created.", required = true) + @PathParam("snapshotName") + String snapshotName, + @RequestBody(description = "Contains user provided parameters", required = true) + CreateSnapshotRequestBody requestBody) + throws Exception { + + final CreateSnapshotResponse response = instantiateJerseyResponse(CreateSnapshotResponse.class); + final CoreContainer coreContainer = fetchAndValidateZooKeeperAwareCoreContainer(); + recordCollectionForLogAndTracing(collName, solrQueryRequest); + + final String collectionName = resolveCollectionName(collName, requestBody.followAliases); + + final SolrZkClient client = coreContainer.getZkController().getZkClient(); + if (SolrSnapshotManager.snapshotExists(client, collectionName, snapshotName)) { + throw new SolrException( + SolrException.ErrorCode.BAD_REQUEST, + "Snapshot with name '" + + snapshotName + + "' already exists for collection '" + + collectionName + + "', no action taken."); + } + + final ZkNodeProps remoteMessage = + createRemoteMessage(collName, requestBody.followAliases, snapshotName, requestBody.asyncId); + final SolrResponse remoteResponse = + CollectionsHandler.submitCollectionApiCommand( + coreContainer, + coreContainer.getDistributedCollectionCommandRunner(), + remoteMessage, + CollectionParams.CollectionAction.CREATESNAPSHOT, + DEFAULT_COLLECTION_OP_TIMEOUT); + + if (remoteResponse.getException() != null) { + throw remoteResponse.getException(); + } + + response.collection = collName; Review Comment: [0] Just noticed the values being added to the response here. In general, I've been trying to change the response format as little as possible in these JAX-RS conversion PRs, and this is a bit of a departure from the existing v1 format. That said, I think it's a change for the better and it's purely additive so it's not a backcompat concern. So let's go with it in this case. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@solr.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@solr.apache.org For additional commands, e-mail: issues-h...@solr.apache.org
