com.ibm.cloud.objectstorage.auth.profile.internal

Class ProfileStaticCredentialsProvider

java.lang.Object

com.ibm.cloud.objectstorage.auth.profile.internal.ProfileStaticCredentialsProvider

All Implemented Interfaces:

AWSCredentialsProvider

@Immutable
public class ProfileStaticCredentialsProvider
extends Object
implements AWSCredentialsProvider

Serves credentials defined in a BasicProfile. Does validation that both access key and secret key exists and are non empty.

Constructor Summary

Constructors

Constructor and Description
ProfileStaticCredentialsProvider(BasicProfile profile)

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProfileStaticCredentialsProvider

public ProfileStaticCredentialsProvider(BasicProfile profile)

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