From 5691dd678745c3abbf3bf5e79145b6fd0801fe8d Mon Sep 17 00:00:00 2001
From: Szabolcs Vasas <vasas@apache.org>
Date: Mon, 14 Jan 2019 12:00:07 +0100
Subject: [PATCH] Class documentation is added to CloudCredentialsRule.

---
 .../sqoop/cloud/tools/CloudCredentialsRule.java      | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/src/test/org/apache/sqoop/cloud/tools/CloudCredentialsRule.java b/src/test/org/apache/sqoop/cloud/tools/CloudCredentialsRule.java
index e47c135b..49a51334 100644
--- a/src/test/org/apache/sqoop/cloud/tools/CloudCredentialsRule.java
+++ b/src/test/org/apache/sqoop/cloud/tools/CloudCredentialsRule.java
@@ -33,6 +33,18 @@
 import java.util.HashMap;
 import java.util.Map;
 
+/**
+ * The task of this rule is to execute the credential generator command for the given cloud storage
+ * and store its output for later use.
+ * If the credential generator command is not provided the tests using this rule will be skipped.
+ *
+ * The subclasses of this rule have to define:
+ *  <ul>
+ *    <li>what is the credential generator command</li>
+ *    <li>how to use its output to create the credentials map</li>
+ *    <li>how apply the credentials to the Hadoop configurations and Sqoop arguments for the tests</li>
+ *  </ul>
+ */
 public abstract class CloudCredentialsRule implements TestRule {
 
   protected final Map<String, String> credentialsMap;