org.apache.solr.handler.admin.api.ListCollectionBackups 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.common.params.CoreAdminParams.BACKUP_ID;
import static org.apache.solr.common.params.CoreAdminParams.BACKUP_LOCATION;
import static org.apache.solr.common.params.CoreAdminParams.BACKUP_REPOSITORY;
import static org.apache.solr.common.params.CoreAdminParams.NAME;
import static org.apache.solr.security.PermissionNameProvider.Name.COLL_EDIT_PERM;

import com.fasterxml.jackson.databind.ObjectMapper;
import jakarta.inject.Inject;
import java.io.IOException;
import java.net.URI;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import org.apache.solr.client.api.endpoint.ListCollectionBackupsApi;
import org.apache.solr.client.api.model.CollectionBackupDetails;
import org.apache.solr.client.api.model.ListCollectionBackupsResponse;
import org.apache.solr.common.params.CommonParams;
import org.apache.solr.common.params.SolrParams;
import org.apache.solr.core.CoreContainer;
import org.apache.solr.core.backup.BackupFilePaths;
import org.apache.solr.core.backup.BackupId;
import org.apache.solr.core.backup.BackupProperties;
import org.apache.solr.handler.api.V2ApiUtils;
import org.apache.solr.jersey.PermissionName;
import org.apache.solr.jersey.SolrJacksonMapper;
import org.apache.solr.request.SolrQueryRequest;
import org.apache.solr.response.SolrQueryResponse;

/**
 * V2 API implementations for collection-backup "listing".
 *
 * These APIs are equivalent to the v1 '/admin/collections?action=LISTBACKUP' command.
 */
public class ListCollectionBackups extends BackupAPIBase implements ListCollectionBackupsApi {

  private final ObjectMapper objectMapper;

  @Inject
  public ListCollectionBackups(
      CoreContainer coreContainer,
      SolrQueryRequest solrQueryRequest,
      SolrQueryResponse solrQueryResponse) {
    super(coreContainer, solrQueryRequest, solrQueryResponse);

    this.objectMapper = SolrJacksonMapper.getObjectMapper();
  }

  public static void invokeFromV1Params(
      CoreContainer coreContainer, SolrQueryRequest req, SolrQueryResponse rsp) throws Exception {
    final SolrParams v1Params = req.getParams();
    v1Params.required().check(CommonParams.NAME);

    final var listApi = new ListCollectionBackups(coreContainer, req, rsp);
    V2ApiUtils.squashIntoSolrResponseWithoutHeader(
        rsp,
        listApi.listBackupsAtLocation(
            v1Params.get(NAME), v1Params.get(BACKUP_LOCATION), v1Params.get(BACKUP_REPOSITORY)));
  }

  @Override
  @PermissionName(COLL_EDIT_PERM)
  public ListCollectionBackupsResponse listBackupsAtLocation(
      String backupName, String location, String repositoryName) throws IOException {
    final var response = instantiateJerseyResponse(ListCollectionBackupsResponse.class);
    recordCollectionForLogAndTracing(null, solrQueryRequest);

    ensureRequiredParameterProvided(NAME, backupName);
    location = getAndValidateIncrementalBackupLocation(repositoryName, location, backupName);

    try (final var repository = createBackupRepository(repositoryName)) {
      final URI locationURI = repository.createDirectoryURI(location);
      final var backupLocation =
          BackupFilePaths.buildExistingBackupLocationURI(repository, locationURI, backupName);

      String[] subFiles = repository.listAllOrEmpty(backupLocation);
      List propsFiles = BackupFilePaths.findAllBackupIdsFromFileListing(subFiles);

      response.backups = new ArrayList<>();
      for (BackupId backupId : propsFiles) {
        BackupProperties properties =
            BackupProperties.readFrom(
                repository, backupLocation, BackupFilePaths.getBackupPropsName(backupId));
        if (response.collection == null) {
          response.collection = properties.getCollection();
        }

        // TODO Make BackupProperties itself Jackson-aware to avoid the additional conversion here?
        Map details = properties.getDetails();
        details.put(BACKUP_ID, backupId.id);
        response.backups.add(objectMapper.convertValue(details, CollectionBackupDetails.class));
      }
    }
    return response;
  }
}