com.ibm.cloud.objectstorage.auth

Class PropertiesFileCredentialsProvider

java.lang.Object

com.ibm.cloud.objectstorage.auth.PropertiesFileCredentialsProvider

All Implemented Interfaces:

AWSCredentialsProvider

public class PropertiesFileCredentialsProvider
extends Object
implements AWSCredentialsProvider

AWSCredentialsProvider implementation that loads AWS security credentials from a properties file provided on initialization.

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.

Constructor Summary

Constructors

Constructor and Description
PropertiesFileCredentialsProvider(String credentialsFilePath) Creates a new PropertiesFileCredentialsProvider that will attempt to load a custom file from the path specified to read AWS security credentials.

Method Summary

Modifier and Type	Method and Description
AWSCredentials	getCredentials() Returns AWSCredentials which the caller can use to authorize an AWS request.
void	refresh() Forces this credentials provider to refresh its credentials.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertiesFileCredentialsProvider

public PropertiesFileCredentialsProvider(String credentialsFilePath)

Creates a new PropertiesFileCredentialsProvider that will attempt to load a custom file from the path specified to read AWS security credentials.

Parameters:

credentialsFilePath - The custom classpath resource path to a properties file from which the AWS security credentials should be loaded. For example,

• /etc/somewhere/credentials.properties

Method Detail

getCredentials

public AWSCredentials getCredentials()

Description copied from interface: 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.

Specified by:

getCredentials in interface AWSCredentialsProvider

Returns:

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

refresh

public void refresh()

Description copied from interface: 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.

Specified by:

refresh in interface AWSCredentialsProvider

toString

public String toString()

Overrides:

toString in class Object