org.apache.hadoop.fs.s3a.auth

Class MarshalledCredentialProvider

java.lang.Object

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

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

org.apache.hadoop.fs.s3a.auth.MarshalledCredentialProvider

All Implemented Interfaces:

software.amazon.awssdk.auth.credentials.AwsCredentialsProvider, software.amazon.awssdk.identity.spi.IdentityProvider<software.amazon.awssdk.identity.spi.AwsCredentialsIdentity>

@InterfaceAudience.Private
 @InterfaceStability.Unstable
public class MarshalledCredentialProvider
extends AbstractSessionCredentialsProvider

AWS credential provider driven from marshalled session/full credentials (full, simple session or role). This is not intended for explicit use in job/app configurations, instead it is returned by Delegation Token Bindings, as needed. The constructor implicitly prevents explicit use.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.fs.s3a.auth.AbstractSessionCredentialsProvider

AbstractSessionCredentialsProvider.NoCredentials

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME Name: "org.apache.hadoop.fs.s3a.auth.MarshalledCredentialProvider".

Constructor Summary

Constructors

Constructor and Description
MarshalledCredentialProvider(String component, URI uri, org.apache.hadoop.conf.Configuration conf, MarshalledCredentials credentials, MarshalledCredentials.CredentialTypeRequired typeRequired) Constructor.

Method Summary

Modifier and Type	Method and Description
protected software.amazon.awssdk.auth.credentials.AwsCredentials	createCredentials(org.apache.hadoop.conf.Configuration config) Perform the binding, looking up the DT and parsing it.

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

getInitializationException, hasCredentials, init, isInitialized, resolveCredentials, toString

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

getConf, getUri

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.auth.credentials.AwsCredentialsProvider

identityType, resolveIdentity

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

resolveIdentity, resolveIdentity

Field Detail

NAME

public static final String NAME

Name: "org.apache.hadoop.fs.s3a.auth.MarshalledCredentialProvider".

See Also:

Constant Field Values

Constructor Detail

MarshalledCredentialProvider

public MarshalledCredentialProvider(String component,
                                    URI uri,
                                    org.apache.hadoop.conf.Configuration conf,
                                    MarshalledCredentials credentials,
                                    MarshalledCredentials.CredentialTypeRequired typeRequired)
                             throws IOException

Constructor.

Parameters:

component - component name for exception messages.

uri - filesystem URI: must not be null.

conf - configuration.

credentials - marshalled credentials.

typeRequired - credential type required.

Throws:

CredentialInitializationException - validation failure

IOException - failure

Method Detail

createCredentials

protected software.amazon.awssdk.auth.credentials.AwsCredentials createCredentials(org.apache.hadoop.conf.Configuration config)
                                                                            throws IOException

Perform the binding, looking up the DT and parsing it.

Specified by:

createCredentials in class AbstractSessionCredentialsProvider

Parameters:

config - the configuration

Returns:

true if there were some credentials

Throws:

CredentialInitializationException - validation failure

IOException - on a failure