org.apache.hadoop.fs.s3native

Class S3xLoginHelper

java.lang.Object

org.apache.hadoop.fs.s3native.S3xLoginHelper

@InterfaceAudience.Private
 @InterfaceStability.Evolving
public final class S3xLoginHelper
extends Object

Class to aid logging in to S3 endpoints. It is in S3N so that it can be used across all S3 filesystems. The core function of this class was the extraction and decoding of user:secret information from filesystems URIs. As this is no longer supported, its role has been reduced to checking for secrets in the URI and rejecting them where found.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	S3xLoginHelper.Login Simple tuple of login details.

Field Summary

Fields

Modifier and Type	Field and Description
static String	LOGIN_WARNING

Method Summary

Modifier and Type	Method and Description
static URI	buildFSURI(URI uri) Build the filesystem URI.
static URI	canonicalizeUri(URI uri, int defaultPort) Canonicalize the given URI.
static void	checkPath(org.apache.hadoop.conf.Configuration conf, URI fsUri, org.apache.hadoop.fs.Path path, int defaultPort) Check the path, ignoring authentication details.
static void	rejectSecretsInURIs(URI name) Extract the login details from a URI, raising an exception if the URI contains them.
static String	toString(URI pathUri) Create a stripped down string value for error messages.

Methods inherited from class java.lang.Object

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

Field Detail

LOGIN_WARNING

public static final String LOGIN_WARNING

See Also:

Constant Field Values

Method Detail

buildFSURI

public static URI buildFSURI(URI uri)

Build the filesystem URI.

Parameters:

uri - filesystem uri

Returns:

the URI to use as the basis for FS operation and qualifying paths.

Throws:

IllegalArgumentException - if the URI is in some way invalid.

toString

public static String toString(URI pathUri)

Create a stripped down string value for error messages.

Parameters:

pathUri - URI

Returns:

a shortened schema://host/path value

rejectSecretsInURIs

public static void rejectSecretsInURIs(URI name)

Extract the login details from a URI, raising an exception if the URI contains them.

Parameters:

name - URI of the filesystem, can be null

Throws:

IllegalArgumentException - if there is a secret in the URI.

canonicalizeUri

public static URI canonicalizeUri(URI uri,
                                  int defaultPort)

Canonicalize the given URI.

Parameters:

uri - the URI to canonicalize

defaultPort - default port to use in canonicalized URI if the input URI has no port and this value is greater than 0

Returns:

a new, canonicalized URI.

checkPath

public static void checkPath(org.apache.hadoop.conf.Configuration conf,
                             URI fsUri,
                             org.apache.hadoop.fs.Path path,
                             int defaultPort)

Check the path, ignoring authentication details. See FileSystem.checkPath(Path) for the operation of this. Essentially

1. The URI is canonicalized.
2. If the schemas match, the hosts are compared.
3. If there is a mismatch between null/non-null host, the default FS values are used to patch in the host.

That all originates in the core FS; the sole change here being to use URI.getHost() over URI.getAuthority(). Some of that code looks a relic of the code anti-pattern of using "hdfs:file.txt" to define the path without declaring the hostname. It's retained for compatibility.

Parameters:

conf - FS configuration

fsUri - the FS URI

path - path to check

defaultPort - default port of FS