Package software.amazon.awssdk.auth.token.credentials

Interface SdkTokenProvider

All Superinterfaces:

IdentityProvider<TokenIdentity>

All Known Implementing Classes:

DefaultAwsTokenProvider, LazyTokenProvider, ProfileTokenProvider, SdkTokenProviderChain, StaticTokenProvider

Functional Interface:

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

@FunctionalInterface
@SdkPublicApi
public interface SdkTokenProvider
extends IdentityProvider<TokenIdentity>

Interface for loading SdkToken that are used for authentication.

Method Summary

Modifier and Type	Method	Description
default Class<TokenIdentity>	identityType()
default CompletableFuture<TokenIdentity>	resolveIdentity(ResolveIdentityRequest request)
SdkToken	resolveToken()	Returns an SdkToken that can be used to authorize a request.

Methods inherited from interface software.amazon.awssdk.identity.spi.IdentityProvider

resolveIdentity, resolveIdentity

Method Details

resolveToken

SdkToken resolveToken()

Returns an SdkToken that can be used to authorize a request. Each implementation of SdkTokenProvider can choose its own strategy for loading token. For example, an implementation might load token from an existing key management system, or load new token when token is refreshed.

Returns:

AwsToken which the caller can use to authorize an AWS request using token authorization for a request.

identityType

default Class<TokenIdentity> identityType()

Specified by:

identityType in interface IdentityProvider<TokenIdentity>

resolveIdentity

default CompletableFuture<TokenIdentity> resolveIdentity(ResolveIdentityRequest request)

Specified by:

resolveIdentity in interface IdentityProvider<TokenIdentity>