From a35f7dec255e3487bb0aaae0d54665216717cf77 Mon Sep 17 00:00:00 2001 From: Mehakmeet Singh Date: Wed, 24 Nov 2021 13:32:59 +0530 Subject: [PATCH] HADOOP-18016. Make certain methods LimitedPrivate in S3AUtils.java (#3685) Contributed By: Mehakmeet Singh --- .../java/org/apache/hadoop/fs/s3a/S3AUtils.java | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/S3AUtils.java b/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/S3AUtils.java index b495d50564..4828340e38 100644 --- a/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/S3AUtils.java +++ b/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/S3AUtils.java @@ -96,6 +96,8 @@ /** * Utility methods for S3A code. + * Some methods are marked LimitedPrivate since they are being used in an + * external project. */ @InterfaceAudience.Private @InterfaceStability.Evolving @@ -884,6 +886,8 @@ public static String lookupPassword( /** * Get a password from a configuration, including JCEKS files, handling both * the absolute key and bucket override. + *
+ * Note: LimitedPrivate for ranger repository to get secrets. * @param bucket bucket or "" if none known * @param conf configuration * @param baseKey base key to look up, e.g "fs.s3a.secret.key" @@ -894,6 +898,7 @@ public static String lookupPassword( * @throws IOException on any IO problem * @throws IllegalArgumentException bad arguments */ + @InterfaceAudience.LimitedPrivate("Ranger") public static String lookupPassword( String bucket, Configuration conf, @@ -1152,10 +1157,15 @@ private static Method getFactoryMethod(Class cl, Class returnType, * This method does not propagate security provider path information from * the S3A property into the Hadoop common provider: callers must call * {@link #patchSecurityCredentialProviders(Configuration)} explicitly. + * + *
+ * Note: LimitedPrivate for ranger repository to set up + * per-bucket configurations. * @param source Source Configuration object. * @param bucket bucket name. Must not be empty. * @return a (potentially) patched clone of the original. */ + @InterfaceAudience.LimitedPrivate("Ranger") public static Configuration propagateBucketOptions(Configuration source, String bucket) { @@ -1351,6 +1361,8 @@ private static void initProtocolSettings(Configuration conf, /** * Initializes AWS SDK proxy support in the AWS client configuration * if the S3A settings enable it. + *
+ * Note: LimitedPrivate to provide proxy support in ranger repository. * * @param conf Hadoop configuration * @param bucket Optional bucket to use to look up per-bucket proxy secrets @@ -1358,6 +1370,7 @@ private static void initProtocolSettings(Configuration conf, * @throws IllegalArgumentException if misconfigured * @throws IOException problem getting username/secret from password source. */ + @InterfaceAudience.LimitedPrivate("Ranger") public static void initProxySupport(Configuration conf, String bucket, ClientConfiguration awsConf) throws IllegalArgumentException,