org.apache.hadoop.fs.s3a.auth

Class AbstractSessionCredentialsProvider

java.lang.Object

org.apache.hadoop.fs.s3a.auth.AbstractAWSCredentialProvider

org.apache.hadoop.fs.s3a.auth.AbstractSessionCredentialsProvider

All Implemented Interfaces:

com.amazonaws.auth.AWSCredentialsProvider

Direct Known Subclasses:

MarshalledCredentialProvider, TemporaryAWSCredentialsProvider

@InterfaceAudience.Private
public abstract class AbstractSessionCredentialsProvider
extends AbstractAWSCredentialProvider

Base class for session credential support.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractSessionCredentialsProvider.NoCredentials A special set of null credentials which are not the anonymous class.

Constructor Summary

Constructors

Constructor and Description
AbstractSessionCredentialsProvider(URI uri, org.apache.hadoop.conf.Configuration conf) Constructor.

Method Summary

Modifier and Type	Method and Description
protected abstract com.amazonaws.auth.AWSCredentials	createCredentials(org.apache.hadoop.conf.Configuration config) Implementation point: whatever the subclass must do to load credentials.
com.amazonaws.auth.AWSCredentials	getCredentials() Get the credentials.
IOException	getInitializationException() Get any IOE raised during initialization.
boolean	hasCredentials()
protected void	init() Initialize the credentials by calling createCredentials(Configuration) with the current config.
boolean	isInitialized() Has an attempt to initialize the credentials been attempted?
String	toString()

Methods inherited from class org.apache.hadoop.fs.s3a.auth.AbstractAWSCredentialProvider

getConf, getUri, refresh

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSessionCredentialsProvider

public AbstractSessionCredentialsProvider(@Nullable
                                          URI uri,
                                          org.apache.hadoop.conf.Configuration conf)

Constructor.

Parameters:

uri - possibly null filesystem URI.

conf - configuration.

Method Detail

init

@Retries.OnceTranslated
protected void init()
                                     throws IOException

Initialize the credentials by calling createCredentials(Configuration) with the current config.

Throws:

IOException - on any failure.

isInitialized

public boolean isInitialized()

Has an attempt to initialize the credentials been attempted?

Returns:

true if init() was called.

createCredentials

protected abstract com.amazonaws.auth.AWSCredentials createCredentials(org.apache.hadoop.conf.Configuration config)
                                                                throws IOException

Implementation point: whatever the subclass must do to load credentials. This is called from init() and then the credentials are cached, along with any exception.

Parameters:

config - the configuration

Returns:

the credentials

Throws:

IOException - on any failure.

getCredentials

public com.amazonaws.auth.AWSCredentials getCredentials()
                                                 throws com.amazonaws.SdkBaseException

Get the credentials. Any exception raised in createCredentials(Configuration) is thrown here before any attempt to return the credentials is made.

Returns:

credentials, if set.

Throws:

com.amazonaws.SdkBaseException - if one was raised during init

CredentialInitializationException - on other failures.

hasCredentials

public final boolean hasCredentials()

toString

public String toString()

Overrides:

toString in class Object

getInitializationException

public IOException getInitializationException()

Get any IOE raised during initialization. Null if init() hasn't been called, or it actually worked.

Returns:

an exception or null.