HADOOP-18889. checkstyles.

the javadoc warning is (a) mistaken (b) complaining about an existing
entry

Change-Id: Ifbbf486cc58d5f896fa8f4a5a38889351bd8fcbe

Author: steveloughran

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

@@ -76,18 +76,18 @@
  * Because the {@link #shouldRetry(Exception, int, int, boolean)} method
  * does this translation if an {@code SdkException} is processed,
  * the policy defined for the IOEs also applies to the original exceptions.
- *
+ * <p>
  * Put differently: this retry policy aims to work for handlers of the
  * untranslated exceptions, as well as the translated ones.
  * @see <a href="http://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html">S3 Error responses</a>
- * @see <a href="http://docs.aws.amazon.com/AmazonS3/latest/dev/ErrorBestPractices.html">Amazon S3 Error Best Practices</a>
- *
+ * @see <a href="http://docs.aws.amazon.com/AmazonS3/latest/dev/ErrorBestPractices.html"> Amazon S3 Error Best Practices </a>
+ * <p>
  * Note that because delete is considered idempotent, all s3a operations currently
  * declare themselves idempotent.
  * This means the retry policy here is more complex than it needs to be -but it
  * does force us to consider when retrying operations would not be safe.
  */
-@SuppressWarnings("visibilitymodifier")  // I want a struct of finals, for real.
+@SuppressWarnings("visibilitymodifier")  // we want a struct of finals, for real.
 public class S3ARetryPolicy implements RetryPolicy {
 
   private static final Logger LOG = LoggerFactory.getLogger(

hadoop-tools/hadoop-aws/src/site/markdown/tools/hadoop-aws/assumed_roles.md

@@ -499,7 +499,6 @@ Instantiate org.apache.hadoop.fs.s3a.auth.AssumedRoleCredentialProvider on :
   MalformedPolicyDocument: Syntax errors in policy.
   (Service: AWSSecurityTokenService; Status Code: 400; Error Code: MalformedPolicyDocument;
   Request ID: 24a281e8-f553-11e7-aa91-a96becfb4d45)
-  
 ```
 
 ### <a name="recursive_auth"></a> `IOException`: "AssumedRoleCredentialProvider cannot be in fs.s3a.assumed.role.credentials.provider"
@@ -591,7 +590,6 @@ the permission for the S3 Operation invoked during the call.
 java.nio.file.AccessDeniedException: a: Writing Object on a:
  software.amazon.awssdk.services.s3.model.S3Exception: Access Denied
  (Service: S3, Status Code: 403, Request ID: F08EV50F85AYKF1V, Extended Request ID: 75vMz9xWNP5/lYplPSZfm/i4yQ5q0G32SIwOwfaj6a8gNCRj9tLBAqcLaaexT/aNg2DhWZQPvDU=):AccessDenied
-
 ```
 
 This is the policy restriction behaving as intended: the caller is trying to
@@ -626,7 +624,7 @@ If the client does have write access to the bucket, verify that the caller has
 
 ```
 java.nio.file.AccessDeniedException: test/testDTFileSystemClient: Writing Object on test/testDTFileSystemClient:
-  software.amazon.awssdk.services.s3.model.S3Exception: Access Denied (Service: Amazon S3; Status Code: 403; 
+  software.amazon.awssdk.services.s3.model.S3Exception: Access Denied (Service: Amazon S3; Status Code: 403;
   Error Code: AccessDenied; Request ID: E86544FF1D029857)
 
 ```

hadoop-tools/hadoop-aws/src/site/markdown/tools/hadoop-aws/third_party_stores.md

@@ -341,7 +341,7 @@ this makes renaming and deleting significantly slower.
     <name>fs.s3a.bucket.gcs-container.access.key</name>
     <value>GOOG1EZ....</value>
   </property>
-  
+
   <property>
     <name>fs.s3a.bucket.gcs-container.secret.key</name>
     <value>SECRETS</value>
@@ -408,7 +408,6 @@ It is also a way to regression test foundational S3A third-party store compatibi
     <name>test.fs.s3a.content.encoding.enabled</name>
     <value>false</value>
   </property>
-  
 </configuration>
 ```
 

hadoop-tools/hadoop-aws/src/site/markdown/tools/hadoop-aws/troubleshooting_s3a.md

@@ -104,9 +104,6 @@ Fix: add it to classpath.
 Maven/Ivy/SBT/Gradle builds which import `hadoop-aws` or
 `hadoop-cloud-storage` artifacts should get the artifact automatically.
 
-However, it may 
-
-
 ### `ClassNotFoundException: com.amazonaws.auth.AWSCredentials`
 
 (or other `com.amazonaws` class.)
@@ -434,7 +431,7 @@ directory will _only_ be in the destination. And files for which the rename oper
 had yet to commence -they will only be in the source tree.
 
 The user has to recover from this themselves. Be assured: no data will have been deleted, it
-is just that the data may now be scattered across two directories. 
+is just that the data may now be scattered across two directories.
 Note: this is one reason why any application which tries to atomically commit work
 via rename (classic Hadoop output committers, distcp with the `-atomic` option) are
 not safe to use with S3. It is not a file system.
@@ -927,7 +924,6 @@ Possible causes:
 * the KMS key referenced by the ARN is in a different region than the S3 bucket
 being used.
 
-
 ### Using SSE-C "Bad Request"
 
 When performing file operations the user may run into an unexpected 400/403
@@ -1072,8 +1068,8 @@ If the value in `fs.s3a.encryption.key` property, does not exist
 
 ```
 Caused by: software.amazon.awssdk.services.kms.model.NotFoundException: Invalid keyId abc
-(Service: AWSKMS; Status Code: 400; Error Code: NotFoundException; Request ID: 9d53552a-3d1b-47c8-984c-9a599d5c2391; Proxy: null)
-
+(Service: AWSKMS; Status Code: 400; Error Code: NotFoundException; Request ID:
+ 9d53552a-3d1b-47c8-984c-9a599d5c2391; Proxy: null)
 ```
 
 Check if `fs.s3a.encryption.key` is set correctly and matches the
@@ -1084,9 +1080,10 @@ same on AWS console.
 User doesn't have authorization to the specific AWS KMS Key ID.
 ```
 Caused by: software.amazon.awssdk.services.kms.model.KmsException:
-User: arn:aws:iam::152813717728:user/<user> is not authorized to perform: kms:GenerateDataKey on resource: <key_ID>
-(Service: AWSKMS; Status Code: 400; Error Code: AccessDeniedException; Request ID: 4ded9f1f-b245-4213-87fc-16cba7a1c4b9; Proxy: null)
- 
+User: arn:aws:iam::152813717728:user/<user> is not authorized to perform:
+ kms:GenerateDataKey on resource: <key_ID>
+(Service: AWSKMS; Status Code: 400; Error Code: AccessDeniedException;
+  Request ID: 4ded9f1f-b245-4213-87fc-16cba7a1c4b9; Proxy: null)
 ```
 
 The user trying to use the KMS Key ID should have the right permissions to access
@@ -1490,7 +1487,7 @@ The number of retries and interval between each retry can be configured:
 ```
 
 Not all failures are retried *in the S3A Code* -though some may be retried within the
-AWS SDK. 
+AWS SDK.
 Specifically excluded are those considered unrecoverable:
 
 * Low-level networking: `UnknownHostException`, `NoRouteToHostException`.