• Home
• com.google.cloud
• google-cloud-storage
• 2.31.0
• source code
• HttpRetryAlgorithmManager.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.google.cloud.storage.HttpRetryAlgorithmManager Maven / Gradle / Ivy

/*
 * Copyright 2021 Google LLC
 *
 * Licensed 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 com.google.cloud.storage;

import com.google.api.gax.retrying.ResultRetryAlgorithm;
import com.google.api.services.storage.model.Bucket;
import com.google.api.services.storage.model.BucketAccessControl;
import com.google.api.services.storage.model.HmacKeyMetadata;
import com.google.api.services.storage.model.Notification;
import com.google.api.services.storage.model.ObjectAccessControl;
import com.google.api.services.storage.model.Policy;
import com.google.api.services.storage.model.StorageObject;
import com.google.cloud.storage.spi.v1.StorageRpc;
import com.google.cloud.storage.spi.v1.StorageRpc.RewriteRequest;
import com.google.common.base.MoreObjects;
import java.io.Serializable;
import java.util.List;
import java.util.Map;
import java.util.Objects;

final class HttpRetryAlgorithmManager implements Serializable {

  private static final long serialVersionUID = -3301856948991518651L;
  private final StorageRetryStrategy retryStrategy;

  HttpRetryAlgorithmManager(StorageRetryStrategy retryStrategy) {
    this.retryStrategy = retryStrategy;
  }

  /**
   * Some operations are inherently idempotent after they're started (Resumable uploads, rewrites)
   * provide access to the idempotent {@link ResultRetryAlgorithm} for those uses.
   */
  ResultRetryAlgorithm idempotent() {
    return retryStrategy.getIdempotentHandler();
  }

  public ResultRetryAlgorithm getForBucketAclCreate(
      BucketAccessControl pb, Map optionsMap) {
    return retryStrategy.getNonidempotentHandler();
  }

  public ResultRetryAlgorithm getForBucketAclDelete(
      String pb, Map optionsMap) {
    return retryStrategy.getNonidempotentHandler();
  }

  public ResultRetryAlgorithm getForBucketAclGet(
      String pb, Map optionsMap) {
    return retryStrategy.getIdempotentHandler();
  }

  public ResultRetryAlgorithm getForBucketAclUpdate(
      BucketAccessControl pb, Map optionsMap) {
    return retryStrategy.getNonidempotentHandler();
  }

  public ResultRetryAlgorithm getForBucketAclList(
      String pb, Map optionsMap) {
    return retryStrategy.getIdempotentHandler();
  }

  public ResultRetryAlgorithm getForBucketsCreate(
      Bucket pb, Map optionsMap) {
    return retryStrategy.getIdempotentHandler();
  }

  public ResultRetryAlgorithm getForBucketsDelete(
      Bucket pb, Map optionsMap) {
    return retryStrategy.getIdempotentHandler();
  }

  public ResultRetryAlgorithm getForBucketsGet(Bucket pb, Map optionsMap) {
    return retryStrategy.getIdempotentHandler();
  }

  public ResultRetryAlgorithm getForBucketsUpdate(
      Bucket pb, Map optionsMap) {
    // TODO: Include etag when it is supported by the library
    return optionsMap.containsKey(StorageRpc.Option.IF_METAGENERATION_MATCH)
        ? retryStrategy.getIdempotentHandler()
        : retryStrategy.getNonidempotentHandler();
  }

  public ResultRetryAlgorithm getForBucketsList(Map optionsMap) {
    return retryStrategy.getIdempotentHandler();
  }

  public ResultRetryAlgorithm getForBucketsLockRetentionPolicy(
      Bucket pb, Map optionsMap) {
    // Always idempotent because IfMetagenerationMatch is required
    return retryStrategy.getIdempotentHandler();
  }

  public ResultRetryAlgorithm getForBucketsGetIamPolicy(
      String bucket, Map optionsMap) {
    return retryStrategy.getIdempotentHandler();
  }

  public ResultRetryAlgorithm getForBucketsSetIamPolicy(
      String bucket, Policy pb, Map optionsMap) {
    return pb.getEtag() != null
        ? retryStrategy.getIdempotentHandler()
        : retryStrategy.getNonidempotentHandler();
  }

  public ResultRetryAlgorithm getForBucketsTestIamPermissions(
      String bucket, List permissions, Map optionsMap) {
    return retryStrategy.getIdempotentHandler();
  }

  public ResultRetryAlgorithm getForDefaultObjectAclCreate(ObjectAccessControl pb) {
    return retryStrategy.getNonidempotentHandler();
  }

  public ResultRetryAlgorithm getForDefaultObjectAclDelete(String pb) {
    return retryStrategy.getNonidempotentHandler();
  }

  public ResultRetryAlgorithm getForDefaultObjectAclGet(String pb) {
    return retryStrategy.getIdempotentHandler();
  }

  public ResultRetryAlgorithm getForDefaultObjectAclUpdate(ObjectAccessControl pb) {
    return retryStrategy.getNonidempotentHandler();
  }

  public ResultRetryAlgorithm getForDefaultObjectAclList(String pb) {
    return retryStrategy.getIdempotentHandler();
  }

  public ResultRetryAlgorithm getForHmacKeyCreate(
      String pb, Map optionsMap) {
    return retryStrategy.getNonidempotentHandler();
  }

  public ResultRetryAlgorithm getForHmacKeyDelete(
      HmacKeyMetadata pb, Map optionsMap) {
    return retryStrategy.getIdempotentHandler();
  }

  public ResultRetryAlgorithm getForHmacKeyGet(
      String accessId, Map optionsMap) {
    return retryStrategy.getIdempotentHandler();
  }

  public ResultRetryAlgorithm getForHmacKeyUpdate(
      HmacKeyMetadata pb, Map optionsMap) {
    // TODO: Include etag when it is supported by the library
    return retryStrategy.getNonidempotentHandler();
  }

  public ResultRetryAlgorithm getForHmacKeyList(Map optionsMap) {
    return retryStrategy.getIdempotentHandler();
  }

  public ResultRetryAlgorithm getForObjectAclCreate(ObjectAccessControl aclPb) {
    return retryStrategy.getNonidempotentHandler();
  }

  public ResultRetryAlgorithm getForObjectAclDelete(
      String bucket, String name, Long generation, String pb) {
    return retryStrategy.getNonidempotentHandler();
  }

  public ResultRetryAlgorithm getForObjectAclList(String bucket, String name, Long generation) {
    return retryStrategy.getIdempotentHandler();
  }

  public ResultRetryAlgorithm getForObjectAclGet(
      String bucket, String name, Long generation, String pb) {
    return retryStrategy.getIdempotentHandler();
  }

  public ResultRetryAlgorithm getForObjectAclUpdate(ObjectAccessControl aclPb) {
    return retryStrategy.getNonidempotentHandler();
  }

  public ResultRetryAlgorithm getForObjectsCreate(
      StorageObject pb, Map optionsMap) {
    if (pb.getGeneration() != null && pb.getGeneration() == 0) {
      return retryStrategy.getIdempotentHandler();
    }
    return optionsMap.containsKey(StorageRpc.Option.IF_GENERATION_MATCH)
        ? retryStrategy.getIdempotentHandler()
        : retryStrategy.getNonidempotentHandler();
  }

  public ResultRetryAlgorithm getForObjectsDelete(
      StorageObject pb, Map optionsMap) {
    return optionsMap.containsKey(StorageRpc.Option.IF_GENERATION_MATCH)
            || (pb.getGeneration() != null && pb.getGeneration() > 0)
        ? retryStrategy.getIdempotentHandler()
        : retryStrategy.getNonidempotentHandler();
  }

  public ResultRetryAlgorithm getForObjectsGet(
      StorageObject pb, Map optionsMap) {
    return retryStrategy.getIdempotentHandler();
  }

  public ResultRetryAlgorithm getForObjectsUpdate(
      StorageObject pb, Map optionsMap) {
    return optionsMap.containsKey(StorageRpc.Option.IF_METAGENERATION_MATCH)
        ? retryStrategy.getIdempotentHandler()
        : retryStrategy.getNonidempotentHandler();
  }

  public ResultRetryAlgorithm getForObjectsList(
      String bucket, Map optionsMap) {
    return retryStrategy.getIdempotentHandler();
  }

  public ResultRetryAlgorithm getForObjectsRewrite(RewriteRequest pb) {
    return pb.targetOptions.containsKey(StorageRpc.Option.IF_GENERATION_MATCH)
        ? retryStrategy.getIdempotentHandler()
        : retryStrategy.getNonidempotentHandler();
  }

  public ResultRetryAlgorithm getForObjectsCompose(
      List sources, StorageObject target, Map optionsMap) {
    return optionsMap.containsKey(StorageRpc.Option.IF_GENERATION_MATCH)
        ? retryStrategy.getIdempotentHandler()
        : retryStrategy.getNonidempotentHandler();
  }

  public ResultRetryAlgorithm getForResumableUploadSessionCreate(
      Map optionsMap) {
    return optionsMap.containsKey(StorageRpc.Option.IF_GENERATION_MATCH)
        ? retryStrategy.getIdempotentHandler()
        : retryStrategy.getNonidempotentHandler();
  }

  public ResultRetryAlgorithm getForResumableUploadSessionWrite(
      Map optionsMap) {
    // writing to a resumable upload session is always idempotent once it's active
    // even if the start of the session wasn't idempotent our incremental writes can be.
    return retryStrategy.getIdempotentHandler();
  }

  public ResultRetryAlgorithm getForServiceAccountGet(String pb) {
    return retryStrategy.getIdempotentHandler();
  }

  public ResultRetryAlgorithm getForNotificationCreate(String bucket, Notification pb) {
    return retryStrategy.getNonidempotentHandler();
  }

  public ResultRetryAlgorithm getForNotificationGet(String bucket, String notificationId) {
    return retryStrategy.getIdempotentHandler();
  }

  public ResultRetryAlgorithm getForNotificationList(String bucket) {
    return retryStrategy.getIdempotentHandler();
  }

  public ResultRetryAlgorithm getForNotificationDelete(String bucket, String notificationId) {
    return retryStrategy.getIdempotentHandler();
  }

  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (!(o instanceof HttpRetryAlgorithmManager)) {
      return false;
    }
    HttpRetryAlgorithmManager that = (HttpRetryAlgorithmManager) o;
    return Objects.equals(retryStrategy, that.retryStrategy);
  }

  @Override
  public int hashCode() {
    return Objects.hash(retryStrategy);
  }

  @Override
  public String toString() {
    return MoreObjects.toStringHelper(this).add("retryStrategy", retryStrategy).toString();
  }
}