com.amazonaws.auth

クラス ClasspathPropertiesFileCredentialsProvider

java.lang.Object

com.amazonaws.auth.ClasspathPropertiesFileCredentialsProvider

すべての実装されたインタフェース:

AWSCredentialsProvider

public class ClasspathPropertiesFileCredentialsProvider
extends java.lang.Object
implements AWSCredentialsProvider

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.

コンストラクタの概要

コンストラクタ

コンストラクタと説明
ClasspathPropertiesFileCredentialsProvider() Creates a new ClasspathPropertiesFileCredentialsProvider that will attempt to load the AwsCredentials.properties file from the classpath to read AWS security credentials.
ClasspathPropertiesFileCredentialsProvider(java.lang.String credentialsFilePath) Creates a new ClasspathPropertiesFileCredentialsProvider that will attempt to load a custom file from the classpath to read AWS security credentials.

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
AWSCredentials	getCredentials() Returns AWSCredentials which the caller can use to authorize an AWS request.
void	refresh() Forces this credentials provider to refresh its credentials.
java.lang.String	toString()

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

コンストラクタの詳細

ClasspathPropertiesFileCredentialsProvider

public ClasspathPropertiesFileCredentialsProvider()

Creates a new ClasspathPropertiesFileCredentialsProvider that will attempt to load the AwsCredentials.properties file from the classpath to read AWS security credentials.

ClasspathPropertiesFileCredentialsProvider

public ClasspathPropertiesFileCredentialsProvider(java.lang.String credentialsFilePath)

Creates a new ClasspathPropertiesFileCredentialsProvider that will attempt to load a custom file from the classpath to read AWS security credentials.

パラメータ:

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

メソッドの詳細

getCredentials

public AWSCredentials getCredentials()

インタフェースからコピーされた説明: AWSCredentialsProvider

Returns AWSCredentials which the caller can use to authorize an AWS request. Each implementation of AWSCredentialsProvider can chose its own strategy for loading credentials. For example, an implementation might load credentials from an existing key management system, or load new credentials when credentials are rotated.

定義:

getCredentials インタフェース内 AWSCredentialsProvider

戻り値:

AWSCredentials which the caller can use to authorize an AWS request.

refresh

public void refresh()

インタフェースからコピーされた説明: AWSCredentialsProvider

Forces this credentials provider to refresh its credentials. For many implementations of credentials provider, this method may simply be a no-op, such as any credentials provider implementation that vends static/non-changing credentials. For other implementations that vend different credentials through out their lifetime, this method should force the credentials provider to refresh its credentials.

定義:

refresh インタフェース内 AWSCredentialsProvider

toString

public java.lang.String toString()

オーバーライド:

toString クラス内 java.lang.Object