software.amazon.awssdk.auth.credentials

Class HttpCredentialsProvider

java.lang.Object

software.amazon.awssdk.auth.credentials.HttpCredentialsProvider

All Implemented Interfaces:

AutoCloseable, AwsCredentialsProvider, SdkAutoCloseable

Direct Known Subclasses:

ContainerCredentialsProvider, InstanceProfileCredentialsProvider

public abstract class HttpCredentialsProvider
extends Object
implements AwsCredentialsProvider, SdkAutoCloseable

Helper class that contains the common behavior of the CredentialsProviders that loads the credentials from a local endpoint on a container (e.g. an EC2 instance).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HttpCredentialsProvider.Builder<TypeToBuildT extends HttpCredentialsProvider,BuilderT extends HttpCredentialsProvider.Builder>
protected static class	HttpCredentialsProvider.BuilderImpl<TypeToBuildT extends HttpCredentialsProvider,BuilderT extends HttpCredentialsProvider.Builder> A builder for creating a custom a InstanceProfileCredentialsProvider.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HttpCredentialsProvider(HttpCredentialsProvider.BuilderImpl<?,?> builder)

Method Summary

Modifier and Type	Method and Description
void	close()
protected abstract ResourcesEndpointProvider	getCredentialsEndpointProvider()
protected boolean	isLocalCredentialLoadingDisabled() Can be overridden by subclass to decide whether loading credential is disabled or not.
AwsCredentials	resolveCredentials() Returns AwsCredentials that can be used to authorize an AWS request.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpCredentialsProvider

protected HttpCredentialsProvider(HttpCredentialsProvider.BuilderImpl<?,?> builder)

Method Detail

getCredentialsEndpointProvider

protected abstract ResourcesEndpointProvider getCredentialsEndpointProvider()

isLocalCredentialLoadingDisabled

protected boolean isLocalCredentialLoadingDisabled()

Can be overridden by subclass to decide whether loading credential is disabled or not.

Returns:

whether loading credential from local endpoint is disabled.

resolveCredentials

public AwsCredentials resolveCredentials()

Description copied from interface: AwsCredentialsProvider

Returns AwsCredentials that can be used 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.

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

Specified by:

resolveCredentials in interface AwsCredentialsProvider

Returns:

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

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface SdkAutoCloseable