org.apache.hadoop.fs.s3a

Class AWSCredentialProviderList

java.lang.Object

org.apache.hadoop.fs.s3a.AWSCredentialProviderList

All Implemented Interfaces:

com.amazonaws.auth.AWSCredentialsProvider, AutoCloseable

@InterfaceAudience.Private
 @InterfaceStability.Evolving
public class AWSCredentialProviderList
extends Object
implements com.amazonaws.auth.AWSCredentialsProvider, AutoCloseable

A list of providers. This is similar to the AWS SDK AWSCredentialsProviderChain, except that:

1. Allows extra providers to be added dynamically.
2. If any provider in the chain throws an exception other than an AmazonClientException, that is rethrown, rather than swallowed.
3. Has some more diagnostics.
4. On failure, the last AmazonClientException raised is rethrown.
5. Special handling of AnonymousAWSCredentials.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NO_AWS_CREDENTIAL_PROVIDERS

Constructor Summary

Constructors

Constructor and Description
AWSCredentialProviderList() Empty instance.
AWSCredentialProviderList(Collection<com.amazonaws.auth.AWSCredentialsProvider> providers) Create with an initial list of providers.

Method Summary

Modifier and Type	Method and Description
void	add(com.amazonaws.auth.AWSCredentialsProvider p) Add a new provider.
void	checkNotEmpty() Verify that the provider list is not empty.
void	close() Close routine will close all providers in the list which implement Closeable.
com.amazonaws.auth.AWSCredentials	getCredentials() Iterate through the list of providers, to find one with credentials.
int	getRefCount() Get the current reference count.
boolean	isClosed() Get the closed flag.
String	listProviderNames() List all the providers' names.
void	refresh() Refresh all child entries.
AWSCredentialProviderList	share() Get a reference to this object with an updated reference count.
String	toString() The string value is this class name and the string values of nested providers.

Methods inherited from class java.lang.Object

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

Field Detail

NO_AWS_CREDENTIAL_PROVIDERS

public static final String NO_AWS_CREDENTIAL_PROVIDERS

See Also:

Constant Field Values

Constructor Detail

AWSCredentialProviderList

public AWSCredentialProviderList()

Empty instance. This is not ready to be used.

AWSCredentialProviderList

public AWSCredentialProviderList(Collection<com.amazonaws.auth.AWSCredentialsProvider> providers)

Create with an initial list of providers.

Parameters:

providers - provider list.

Method Detail

add

public void add(com.amazonaws.auth.AWSCredentialsProvider p)

Add a new provider.

Parameters:

p - provider

refresh

public void refresh()

Refresh all child entries.

Specified by:

refresh in interface com.amazonaws.auth.AWSCredentialsProvider

getCredentials

public com.amazonaws.auth.AWSCredentials getCredentials()

Iterate through the list of providers, to find one with credentials. If reuseLastProvider is true, then it is re-used.

Specified by:

getCredentials in interface com.amazonaws.auth.AWSCredentialsProvider

Returns:

a set of credentials (possibly anonymous), for authenticating.

checkNotEmpty

public void checkNotEmpty()

Verify that the provider list is not empty.

Throws:

com.amazonaws.AmazonClientException - if there are no providers.

listProviderNames

public String listProviderNames()

List all the providers' names.

Returns:

a list of names, separated by spaces (with a trailing one). If there are no providers, "" is returned.

toString

public String toString()

The string value is this class name and the string values of nested providers.

Overrides:

toString in class Object

Returns:

a string value for debugging.

share

public AWSCredentialProviderList share()

Get a reference to this object with an updated reference count.

Returns:

a reference to this

getRefCount

public int getRefCount()

Get the current reference count.

Returns:

the current ref count

isClosed

public boolean isClosed()

Get the closed flag.

Returns:

true iff the list is closed.

close

public void close()

Close routine will close all providers in the list which implement Closeable. This matters because some providers start a background thread to refresh their secrets.

Specified by:

close in interface AutoCloseable