com.ibm.cos.v2.auth.credentials

Interface AwsCredentialsProvider

All Superinterfaces:

IdentityProvider<AwsCredentialsIdentity>

All Known Subinterfaces:

HttpCredentialsProvider

All Known Implementing Classes:

AnonymousCredentialsProvider, AwsCredentialsProviderChain, DefaultCredentialsProvider, EnvironmentVariableCredentialsProvider, LazyAwsCredentialsProvider, ProcessCredentialsProvider, ProfileCredentialsProvider, StaticCredentialsProvider, SystemPropertyCredentialsProvider, SystemSettingsCredentialsProvider, WebIdentityTokenFileCredentialsProvider

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface AwsCredentialsProvider
extends IdentityProvider<AwsCredentialsIdentity>

Interface for loading AwsCredentials that are used for authentication.

Commonly-used implementations include StaticCredentialsProvider for a fixed set of credentials and the DefaultCredentialsProvider for discovering credentials from the host's environment. The AWS Security Token Service (STS) client also provides implementations of this interface for loading temporary, limited-privilege credentials from AWS STS.

Method Summary

Modifier and Type	Method and Description
default Class<AwsCredentialsIdentity>	identityType() Retrieve the class of identity this identity provider produces.
AwsCredentials	resolveCredentials() Returns AwsCredentials that can be used to authorize an AWS request.
default CompletableFuture<AwsCredentialsIdentity>	resolveIdentity(ResolveIdentityRequest request) Resolve the identity from this identity provider.

Methods inherited from interface com.ibm.cos.v2.identity.spi.IdentityProvider

resolveIdentity, resolveIdentity

Method Detail

resolveCredentials

AwsCredentials resolveCredentials()

Returns AwsCredentials that can be used to authorize an AWS request. Each implementation of AWSCredentialsProvider can choose 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.

If an error occurs during the loading of credentials or credentials could not be found, a runtime exception will be raised.

Returns:

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

identityType

default Class<AwsCredentialsIdentity> identityType()

Description copied from interface: IdentityProvider

Retrieve the class of identity this identity provider produces. This is necessary for the SDK core to determine which identity provider should be used to resolve a specific type of identity.

Specified by:

identityType in interface IdentityProvider<AwsCredentialsIdentity>

resolveIdentity

default CompletableFuture<AwsCredentialsIdentity> resolveIdentity(ResolveIdentityRequest request)

Description copied from interface: IdentityProvider

Resolve the identity from this identity provider.

Specified by:

resolveIdentity in interface IdentityProvider<AwsCredentialsIdentity>

Parameters:

request - The request to resolve an Identity