org.elasticsearch.repositories.s3.AwsSigner.java Source code

Introduction

Here is the source code for org.elasticsearch.repositories.s3.AwsSigner.java

Source

/*
 * Licensed to Elasticsearch under one or more contributor
 * license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright
 * ownership. Elasticsearch 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.elasticsearch.repositories.s3;

import com.amazonaws.ClientConfiguration;
import com.amazonaws.auth.SignerFactory;
import org.apache.logging.log4j.Logger;
import org.elasticsearch.common.logging.Loggers;

class AwsSigner {

    private static final Logger logger = Loggers.getLogger(AwsSigner.class);

    private AwsSigner() {

    }

    protected static void validateSignerType(String signer, String endpoint) {
        if (signer == null) {
            throw new IllegalArgumentException("[null] signer set");
        }

        // do not block user to any signerType
        switch (signer) {
        case "S3SignerType":
            if (endpoint.equals("s3.cn-north-1.amazonaws.com.cn")
                    || endpoint.equals("s3.eu-central-1.amazonaws.com")) {
                throw new IllegalArgumentException(
                        "[S3SignerType] may not be supported in aws Beijing and Frankfurt region");
            }
            break;
        case "AWSS3V4SignerType":
            break;
        default:
            try {
                SignerFactory.getSignerByTypeAndService(signer, null);
            } catch (IllegalArgumentException e) {
                throw new IllegalArgumentException("[" + signer + "] may not be supported");
            }
        }
    }

    /**
     * Add a AWS API Signer.
     * @param signer Signer to use
     * @param configuration AWS Client configuration
     */
    public static void configureSigner(String signer, ClientConfiguration configuration, String endpoint) {
        try {
            validateSignerType(signer, endpoint);
        } catch (IllegalArgumentException e) {
            logger.warn("{}", e.getMessage());
        }

        configuration.setSignerOverride(signer);
    }

}