org.apache.hadoop.fs.s3a.S3GuardExistsRetryPolicy Maven / Gradle / Ivy

Go to download
/*
 * 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.hadoop.fs.s3a;

import java.io.FileNotFoundException;
import java.util.Map;
import java.util.concurrent.TimeUnit;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import org.apache.hadoop.conf.Configuration;
import org.apache.hadoop.io.retry.RetryPolicy;

import static org.apache.hadoop.fs.s3a.Constants.S3GUARD_CONSISTENCY_RETRY_INTERVAL;
import static org.apache.hadoop.fs.s3a.Constants.S3GUARD_CONSISTENCY_RETRY_INTERVAL_DEFAULT;
import static org.apache.hadoop.fs.s3a.Constants.S3GUARD_CONSISTENCY_RETRY_LIMIT;
import static org.apache.hadoop.fs.s3a.Constants.S3GUARD_CONSISTENCY_RETRY_LIMIT_DEFAULT;
import static org.apache.hadoop.io.retry.RetryPolicies.retryUpToMaximumCountWithProportionalSleep;

/**
 * Slightly-modified retry policy for cases when the file is present in the
 * MetadataStore, but may be still throwing FileNotFoundException from S3.
 */
public class S3GuardExistsRetryPolicy extends S3ARetryPolicy {

  private static final Logger LOG = LoggerFactory.getLogger(
      S3GuardExistsRetryPolicy.class);

  /**
   * Instantiate.
   * @param conf configuration to read.
   */
  public S3GuardExistsRetryPolicy(Configuration conf) {
    super(conf);
  }

  @Override
  protected Map, RetryPolicy> createExceptionMap() {
    Map, RetryPolicy> b = super.createExceptionMap();
    Configuration conf = getConfiguration();

    // base policy from configuration
    int limit = conf.getInt(S3GUARD_CONSISTENCY_RETRY_LIMIT,
        S3GUARD_CONSISTENCY_RETRY_LIMIT_DEFAULT);
    long interval = conf.getTimeDuration(S3GUARD_CONSISTENCY_RETRY_INTERVAL,
        S3GUARD_CONSISTENCY_RETRY_INTERVAL_DEFAULT,
        TimeUnit.MILLISECONDS);
    RetryPolicy retryPolicy = retryUpToMaximumCountWithProportionalSleep(
        limit,
        interval,
        TimeUnit.MILLISECONDS);
    LOG.debug("Retrying on recoverable S3Guard table/S3 inconsistencies {}"
        + " times with an initial interval of {}ms", limit, interval);

    b.put(FileNotFoundException.class, retryPolicy);
    b.put(RemoteFileChangedException.class, retryPolicy);
    return b;
  }
}