src/main/java/org/apache/cassandra/sidecar/utils/DigestVerifier.java

/*
 * 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.cassandra.sidecar.utils;

import io.vertx.core.Future;

/**
 * Interface to verify integrity of SSTables uploaded.
 * <p>
 * Note: If digest calculations of multiple files are happening at the same time, we would want to limit concurrent
 * digest calculations. Since {@link DigestVerifier} is currently used only by upload handler, we are not
 * introducing another limit here. Concurrent uploads limit should limit concurrent digest calculations as well.
 */
public interface DigestVerifier
{
    /**
     * @param filePath path to SSTable component
     * @return a future String with the component path if verification is a success, otherwise a failed future
     */
    Future<String> verify(String filePath);
}