com.amazonaws.auth.ClasspathPropertiesFileCredentialsProvider 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 2012-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.auth;

import com.amazonaws.AmazonClientException;

import java.io.IOException;
import java.io.InputStream;

/**
 * {@link AWSCredentialsProvider} implementation that loads AWS security
 * credentials from a properties file on the classpath. The default constructor
 * creates a credentials provider that loads the credentials from a file named
 * AwsCredentials.properties on the classpath, but which file to
 * use from the classpath can also be controled through the one-argument
 * constructor.
 * 
 * The AWS access key ID is expected to be in the accessKey
 * property and the AWS secret key is expected to be in the
 * secretKey property.
 *
 * @deprecated This is unsafe in mobile applications and should not be used. Use
 *             temporary credentials provided by services such as Cognito
 *             Identity
 *             (http://docs.aws.amazon.com/mobile/sdkforandroid/developerguide
 *             /cognito-auth.html)
 */
@Deprecated
public class ClasspathPropertiesFileCredentialsProvider implements AWSCredentialsProvider {

    /** The name of the properties file to check for credentials */
    private static String defaultPropertiesFile = "AwsCredentials.properties";

    private final String credentialsFilePath;

    /**
     * Creates a new ClasspathPropertiesFileCredentialsProvider that will
     * attempt to load the AwsCredentials.properties file from the
     * classpath to read AWS security credentials.
     */
    public ClasspathPropertiesFileCredentialsProvider() {
        this(defaultPropertiesFile);
    }

    /**
     * Creates a new ClasspathPropertiesFileCredentialsProvider that will
     * attempt to load a custom file from the classpath to read AWS security
     * credentials.
     *
     * @param credentialsFilePath The custom classpath resource path to a
     *            properties file from which the AWS security credentials should
     *            be loaded. For example,
     *            

     *            com/mycompany/credentials.properties
     *            beta-credentials.properties
     *            AwsCredentials.properties
     *            
     */
    public ClasspathPropertiesFileCredentialsProvider(String credentialsFilePath) {
        if (credentialsFilePath == null)
            throw new IllegalArgumentException("Credentials file path cannot be null");

        // Make sure the path is absolute
        if (!credentialsFilePath.startsWith("/")) {
            this.credentialsFilePath = "/" + credentialsFilePath;
        } else {
            this.credentialsFilePath = credentialsFilePath;
        }
    }

    @Override
    public AWSCredentials getCredentials() {
        InputStream inputStream = getClass().getResourceAsStream(credentialsFilePath);
        if (inputStream == null) {
            throw new AmazonClientException("Unable to load AWS credentials from the "
                    + credentialsFilePath + " file on the classpath");
        }

        try {
            return new PropertiesCredentials(inputStream);
        } catch (IOException e) {
            throw new AmazonClientException("Unable to load AWS credentials from the "
                    + credentialsFilePath + " file on the classpath", e);
        }
    }

    @Override
    public void refresh() {
    }

    @Override
    public String toString() {
        return getClass().getSimpleName() + "(" + credentialsFilePath + ")";
    }
}