org.apache.solr.core.backup.ShardBackupMetadata 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.core.backup;

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.URI;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import org.apache.lucene.store.IOContext;
import org.apache.lucene.store.IndexInput;
import org.apache.solr.common.util.Utils;
import org.apache.solr.core.backup.repository.BackupRepository;
import org.apache.solr.util.PropertiesInputStream;

/**
 * Represents the shard-backup metadata file.
 *
 * The shard-backup metadata file is responsible for holding information about a specific
 * backup-point for a specific shard. This includes the full list of index files required to restore
 * this shard to the backup-point, with pointers to where each lives in the repository.
 *
 * 
Shard backup metadata files have names derived from an associated {@link ShardBackupId}, to
 * avoid conflicts between shards and backupIds.
 *
 * Not used by the (now deprecated) traditional 'full-snapshot' backup format.
 */
public class ShardBackupMetadata {
  private Map allFiles = new HashMap<>();
  private List uniqueFileNames = new ArrayList<>();

  public void addBackedFile(String uniqueFileName, String originalFileName, Checksum fileChecksum) {
    addBackedFile(new BackedFile(uniqueFileName, originalFileName, fileChecksum));
  }

  public int numFiles() {
    return uniqueFileNames.size();
  }

  public long totalSize() {
    return allFiles.values().stream().map(bf -> bf.fileChecksum.size).reduce(0L, Long::sum);
  }

  public void addBackedFile(BackedFile backedFile) {
    allFiles.put(backedFile.originalFileName, backedFile);
    uniqueFileNames.add(backedFile.uniqueFileName);
  }

  public Optional getFile(String originalFileName) {
    return Optional.ofNullable(allFiles.get(originalFileName));
  }

  public List listUniqueFileNames() {
    return Collections.unmodifiableList(uniqueFileNames);
  }

  public static ShardBackupMetadata empty() {
    return new ShardBackupMetadata();
  }

  /**
   * Reads a shard metadata file from a {@link BackupRepository} and parses the result into a {@link
   * ShardBackupMetadata}
   *
   * @param repository the storage repository to read shard-metadata from
   * @param dir URI for the 'shard_backup_metadata' directory of the backup to read from
   * @param shardBackupId the ID of the shard metadata file to read
   * @return a ShardBackupMetadata object representing the provided 'shardBackupId' if it could be
   *     found in 'dir', null otherwise
   */
  public static ShardBackupMetadata from(
      BackupRepository repository, URI dir, ShardBackupId shardBackupId) throws IOException {
    final String shardBackupMetadataFilename = shardBackupId.getBackupMetadataFilename();
    if (!repository.exists(repository.resolve(dir, shardBackupMetadataFilename))) {
      return null;
    }

    try (IndexInput is =
        repository.openInput(dir, shardBackupMetadataFilename, IOContext.DEFAULT)) {
      return from(new PropertiesInputStream(is));
    }
  }

  /**
   * Storing ShardBackupMetadata at {@code folderURI} with name {@code filename}. If a file already
   * existed there, overwrite it.
   */
  public void store(BackupRepository repository, URI folderURI, ShardBackupId shardBackupId)
      throws IOException {
    final String filename = shardBackupId.getBackupMetadataFilename();
    URI fileURI = repository.resolve(folderURI, filename);
    if (repository.exists(fileURI)) {
      repository.delete(folderURI, Collections.singleton(filename));
    }

    try (OutputStream os = repository.createOutput(repository.resolve(folderURI, filename))) {
      store(os);
    }
  }

  public Collection listOriginalFileNames() {
    return Collections.unmodifiableSet(allFiles.keySet());
  }

  private void store(OutputStream os) throws IOException {
    Map> map = new HashMap<>();

    for (BackedFile backedFile : allFiles.values()) {
      Map fileMap = new HashMap<>();
      fileMap.put("fileName", backedFile.originalFileName);
      fileMap.put("checksum", backedFile.fileChecksum.checksum);
      fileMap.put("size", backedFile.fileChecksum.size);
      map.put(backedFile.uniqueFileName, fileMap);
    }

    Utils.writeJson(map, os, false);
  }

  private static ShardBackupMetadata from(InputStream is) {
    @SuppressWarnings({"unchecked"})
    Map map = (Map) Utils.fromJSON(is);
    ShardBackupMetadata shardBackupMetadata = new ShardBackupMetadata();
    for (String uniqueFileName : map.keySet()) {
      @SuppressWarnings({"unchecked"})
      Map fileMap = (Map) map.get(uniqueFileName);

      String fileName = (String) fileMap.get("fileName");
      long checksum = (long) fileMap.get("checksum");
      long size = (long) fileMap.get("size");
      shardBackupMetadata.addBackedFile(
          new BackedFile(uniqueFileName, fileName, new Checksum(checksum, size)));
    }

    return shardBackupMetadata;
  }

  public static class BackedFile {
    public final String uniqueFileName;
    public final String originalFileName;
    public final Checksum fileChecksum;

    BackedFile(String uniqueFileName, String originalFileName, Checksum fileChecksum) {
      this.uniqueFileName = uniqueFileName;
      this.originalFileName = originalFileName;
      this.fileChecksum = fileChecksum;
    }
  }
}