Skip to content

Commit a35f7de

Browse files
authored
HADOOP-18016. Make certain methods LimitedPrivate in S3AUtils.java (#3685)
Contributed By: Mehakmeet Singh
1 parent d3f0b7e commit a35f7de

File tree

1 file changed

+13
-0
lines changed
  • hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a

1 file changed

+13
-0
lines changed

hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/S3AUtils.java

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,8 @@
9696

9797
/**
9898
* Utility methods for S3A code.
99+
* Some methods are marked LimitedPrivate since they are being used in an
100+
* external project.
99101
*/
100102
@InterfaceAudience.Private
101103
@InterfaceStability.Evolving
@@ -884,6 +886,8 @@ public static String lookupPassword(
884886
/**
885887
* Get a password from a configuration, including JCEKS files, handling both
886888
* the absolute key and bucket override.
889+
* <br>
890+
* <i>Note:</i> LimitedPrivate for ranger repository to get secrets.
887891
* @param bucket bucket or "" if none known
888892
* @param conf configuration
889893
* @param baseKey base key to look up, e.g "fs.s3a.secret.key"
@@ -894,6 +898,7 @@ public static String lookupPassword(
894898
* @throws IOException on any IO problem
895899
* @throws IllegalArgumentException bad arguments
896900
*/
901+
@InterfaceAudience.LimitedPrivate("Ranger")
897902
public static String lookupPassword(
898903
String bucket,
899904
Configuration conf,
@@ -1152,10 +1157,15 @@ private static Method getFactoryMethod(Class<?> cl, Class<?> returnType,
11521157
* This method does not propagate security provider path information from
11531158
* the S3A property into the Hadoop common provider: callers must call
11541159
* {@link #patchSecurityCredentialProviders(Configuration)} explicitly.
1160+
*
1161+
* <br>
1162+
* <i>Note:</i> LimitedPrivate for ranger repository to set up
1163+
* per-bucket configurations.
11551164
* @param source Source Configuration object.
11561165
* @param bucket bucket name. Must not be empty.
11571166
* @return a (potentially) patched clone of the original.
11581167
*/
1168+
@InterfaceAudience.LimitedPrivate("Ranger")
11591169
public static Configuration propagateBucketOptions(Configuration source,
11601170
String bucket) {
11611171

@@ -1351,13 +1361,16 @@ private static void initProtocolSettings(Configuration conf,
13511361
/**
13521362
* Initializes AWS SDK proxy support in the AWS client configuration
13531363
* if the S3A settings enable it.
1364+
* <br>
1365+
* <i>Note:</i> LimitedPrivate to provide proxy support in ranger repository.
13541366
*
13551367
* @param conf Hadoop configuration
13561368
* @param bucket Optional bucket to use to look up per-bucket proxy secrets
13571369
* @param awsConf AWS SDK configuration to update
13581370
* @throws IllegalArgumentException if misconfigured
13591371
* @throws IOException problem getting username/secret from password source.
13601372
*/
1373+
@InterfaceAudience.LimitedPrivate("Ranger")
13611374
public static void initProxySupport(Configuration conf,
13621375
String bucket,
13631376
ClientConfiguration awsConf) throws IllegalArgumentException,

0 commit comments

Comments
 (0)