com.ibm.cloud.objectstorage.auth

Class EnvironmentVariableCredentialsProvider

java.lang.Object

com.ibm.cloud.objectstorage.auth.EnvironmentVariableCredentialsProvider

All Implemented Interfaces:

AWSCredentialsProvider

public class EnvironmentVariableCredentialsProvider
extends Object
implements AWSCredentialsProvider

AWSCredentialsProvider implementation that provides credentials by looking at the: AWS_ACCESS_KEY_ID (or AWS_ACCESS_KEY) and AWS_SECRET_KEY (or AWS_SECRET_ACCESS_KEY) environment variables. If the AWS_SESSION_TOKEN environment variable is also set then temporary credentials will be used.

Constructor Summary

Constructors

Constructor and Description
EnvironmentVariableCredentialsProvider()

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

EnvironmentVariableCredentialsProvider

public EnvironmentVariableCredentialsProvider()

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