com.amazonaws.retry.RetryUtils Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-core Show documentation

The AWS SDK for Java Mobile - Core module holds the classes that is used by the individual service clients to interact with Amazon Web Services. Users need to depend on aws-java-sdk artifact for accessing individual client classes.

The newest version!

/*
 * Copyright 2010-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *  http://aws.amazon.com/apache2.0
 *
 * or in the "license" file accompanying this file. This file 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.amazonaws.retry;

import com.amazonaws.AbortedException;
import com.amazonaws.AmazonServiceException;

import java.io.InterruptedIOException;
import java.net.SocketTimeoutException;

/** RetryUtils class. */
public class RetryUtils {

    /**
     * Returns true if the specified exception is a throttling error.
     *
     * @param ase The exception to test.
     * @return True if the exception resulted from a throttling error message
     *         from a service, otherwise false.
     */
    public static boolean isThrottlingException(AmazonServiceException ase) {
        if (ase == null)
            return false;

        String errorCode = ase.getErrorCode();
        return "Throttling".equals(errorCode)
                || "ThrottlingException".equals(errorCode)
                || "ProvisionedThroughputExceededException".equals(errorCode);
    }

    /**
     * Returns true if the specified exception is a request entity too large
     * error.
     *
     * @param ase The exception to test.
     * @return True if the exception resulted from a request entity too large
     *         error message from a service, otherwise false.
     */
    public static boolean isRequestEntityTooLargeException(AmazonServiceException ase) {
        if (ase == null)
            return false;
        return "Request entity too large".equals(ase.getErrorCode());
    }

    /**
     * Returns true if the specified exception is a clock skew error.
     *
     * @param ase The exception to test.
     * @return True if the exception resulted from a clock skews error message
     *         from a service, otherwise false.
     */
    public static boolean isClockSkewError(AmazonServiceException ase) {
        if (ase == null)
            return false;

        String errorCode = ase.getErrorCode();
        return "RequestTimeTooSkewed".equals(errorCode)
                || "RequestExpired".equals(errorCode)
                || "InvalidSignatureException".equals(errorCode)
                || "SignatureDoesNotMatch".equals(errorCode);
    }

    /**
     * Return true if the error is caused by interruption.
     *
     * @param error throwable
     * @return true if the exception is caused by interruption.
     */
    public static boolean isInterrupted(Throwable error) {
        if (error instanceof AbortedException) {
            return true;
        }
        if (error.getCause() != null) {
            Throwable cause = error.getCause();
            /*
             * InterruptedIOException is thrown by OkHttp when connection is
             * interrupted. SocketTimeoutException is a subclass of
             * InterruptedIOException. It's caused by timeout and should be
             * excluded.
             */
            if (cause instanceof InterruptedException
                    || cause instanceof InterruptedIOException
                    && !(cause instanceof SocketTimeoutException)) {
                return true;
            }
        }
        return false;
    }
}