001/*
002 * (C) Copyright 2018 Nuxeo (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Remi Cattiau
018 *     Florent Guillaume
019 */
020package org.nuxeo.runtime.aws;
021
022import com.amazonaws.auth.AWSCredentials;
023
024/**
025 * The service providing AWS configuration.
026 *
027 * @since 10.3
028 */
029public interface AWSConfigurationService {
030
031    /**
032     * Gets the AWS Credentials for the default configuration.
033     *
034     * @return the AWS credentials, or {@code null} if not defined
035     */
036    default AWSCredentials getAWSCredentials() {
037        return getAWSCredentials(null);
038    }
039
040    /**
041     * Gets the AWS Credentials for the given configuration.
042     *
043     * @param id the configuration id, or {@code null} for the default
044     * @return the AWS credentials, or {@code null} if not defined
045     * @since 11.1
046     */
047    AWSCredentials getAWSCredentials(String id);
048
049    /**
050     * Gets the AWS Region for the default configuration.
051     *
052     * @return the AWS Region, or {@code null} if not defined
053     */
054    default String getAWSRegion() {
055        return getAWSRegion(null);
056    }
057
058    /**
059     * Gets the AWS Region for the given configuration.
060     *
061     * @param id the configuration id, or {@code null} for the default
062     * @return the AWS Region, or {@code null} if not defined
063     * @since 11.1
064     */
065    String getAWSRegion(String id);
066
067}