/*
 * 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.hudi.client.timeline;

import org.apache.hudi.common.engine.HoodieEngineContext;
import org.apache.hudi.common.model.HoodieAvroPayload;

import java.io.IOException;
import java.util.Collections;
import java.util.Map;

/**
 * Archiver to bound the growth of files under .hoodie meta path.
 */
public interface HoodieTimelineArchiver<T extends HoodieAvroPayload, I, K, O> {

  default int archiveIfRequired(HoodieEngineContext context) throws IOException {
    return archiveIfRequired(context, false);
  }

  /**
   * Check if commits need to be archived. If yes, archive commits.
   */
  int archiveIfRequired(HoodieEngineContext context, boolean acquireLock) throws IOException;

  /**
   * Returns metrics collected during archival.
   * Keys are metric names, values are metric values.
   */
  default Map<String, Long> getMetrics() {
    return Collections.emptyMap();
  }
}
