Applied code style format (#19)

Author: henryx

.github/workflows/gradle.yml

@@ -12,12 +12,12 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        java: [11]
-        os: [ubuntu-latest, windows-latest]
+        java: [ 11 ]
+        os: [ ubuntu-latest, windows-latest ]
         include:
           # TODO(casz) remove once https://github.com/testcontainers/testcontainers-java/pull/1780 is available
-        - os: 'ubuntu-latest'
-          tasks: 'integrationTest'
+          - os: 'ubuntu-latest'
+            tasks: 'integrationTest'
 
     steps:
       - uses: actions/checkout@v1

.github/workflows/test-report.yml

@@ -1,7 +1,7 @@
 name: 'Test Report'
 on:
   workflow_run:
-    workflows: ['CI']                     # runs after CI workflow
+    workflows: [ 'CI' ]                     # runs after CI workflow
     types:
       - completed
 jobs:

README.md

@@ -114,7 +114,7 @@ task unitTest(type: Test) {
 }
 
 task integrationTest(type: Test) {
-    testClassesDirs= sourceSets.integrationTests.output.classesDirs
+    testClassesDirs = sourceSets.integrationTests.output.classesDirs
     classpath = sourceSets.integrationTests.runtimeClasspath
     testLogging {
         events "passed", "skipped", "failed"

build.gradle

@@ -7,8 +7,8 @@
 import java.nio.file.Paths;
 
 /**
- * The code used to load environment variables is encapsulated within an inner class,
- * so that a mock version of that environment loader can be used by unit tests.
+ * The code used to load environment variables is encapsulated within an inner class, so that a mock
+ * version of that environment loader can be used by unit tests.
  */
 public class EnvironmentLoader implements Serializable {
 

src/main/java/io/github/jopenlibs/vault/EnvironmentLoader.java

@@ -20,10 +20,12 @@
 import java.util.logging.Logger;
 
 /**
- * <p>The Vault driver class, the primary interface through which dependent applications will access Vault.</p>
+ * <p>The Vault driver class, the primary interface through which dependent applications will
+ * access Vault.</p>
  *
- * <p>This driver exposes a DSL, compartmentalizing the various endpoints of the HTTP API (e.g. "/", "sys/init",
- * "sys/seal") into separate implementation classes (e.g. <code>Logical</code>, <code>Init</code>, etc).</p>
+ * <p>This driver exposes a DSL, compartmentalizing the various endpoints of the HTTP API (e.g.
+ * "/", "sys/init", "sys/seal") into separate implementation classes (e.g. <code>Logical</code>,
+ * <code>Init</code>, etc).</p>
  *
  * <p>Example usage:</p>
  *
@@ -57,74 +59,90 @@
 public class Vault {
 
     private final VaultConfig vaultConfig;
-    private Logger logger =  Logger.getLogger(Vault.class.getCanonicalName());
+    private Logger logger = Logger.getLogger(Vault.class.getCanonicalName());
 
     /**
      * Construct a Vault driver instance with the provided config settings.
      *
-     * @param vaultConfig Configuration settings for Vault interaction (e.g. server address, token, etc)
-     *                    If the VaultConfig Engine version path map is not supplied in the config, default to global KV
-     *                    engine version 2.
+     * @param vaultConfig Configuration settings for Vault interaction (e.g. server address, token,
+     * etc) If the VaultConfig Engine version path map is not supplied in the config, default to
+     * global KV engine version 2.
      */
     public Vault(final VaultConfig vaultConfig) {
         this.vaultConfig = vaultConfig;
         if (this.vaultConfig.getNameSpace() != null && !this.vaultConfig.getNameSpace().isEmpty()) {
-            logger.info(String.format("The NameSpace %s has been bound to this Vault instance. Please keep this in mind when running operations.", this.vaultConfig.getNameSpace()));
+            logger.info(String.format(
+                    "The NameSpace %s has been bound to this Vault instance. Please keep this in mind when running operations.",
+                    this.vaultConfig.getNameSpace()));
         }
-        if (this.vaultConfig.getSecretsEnginePathMap().isEmpty() && this.vaultConfig.getGlobalEngineVersion() == null) {
-            logger.info("Constructing a Vault instance with no provided Engine version, defaulting to version 2.");
+        if (this.vaultConfig.getSecretsEnginePathMap().isEmpty()
+                && this.vaultConfig.getGlobalEngineVersion() == null) {
+            logger.info(
+                    "Constructing a Vault instance with no provided Engine version, defaulting to version 2.");
             this.vaultConfig.setEngineVersion(2);
         }
     }
 
     /**
-     * Construct a Vault driver instance with the provided config settings, and use the provided global KV Engine version for all secrets.
+     * Construct a Vault driver instance with the provided config settings, and use the provided
+     * global KV Engine version for all secrets.
      *
-     * @param vaultConfig             Configuration settings for Vault interaction (e.g. server address, token, etc)
-     * @param engineVersion           Which version of the Key/Value Secret Engine to use globally (i.e. 1 or 2)
+     * @param vaultConfig Configuration settings for Vault interaction (e.g. server address, token,
+     * etc)
+     * @param engineVersion Which version of the Key/Value Secret Engine to use globally (i.e. 1 or
+     * 2)
      */
     public Vault(final VaultConfig vaultConfig, final Integer engineVersion) {
         if (engineVersion < 1 || engineVersion > 2) {
-            throw new IllegalArgumentException("The Engine version must be '1' or '2', the version supplied was: '"
-                    + engineVersion + "'.");
+            throw new IllegalArgumentException(
+                    "The Engine version must be '1' or '2', the version supplied was: '"
+                            + engineVersion + "'.");
         }
         vaultConfig.setEngineVersion(engineVersion);
         this.vaultConfig = vaultConfig;
         if (this.vaultConfig.getNameSpace() != null && !this.vaultConfig.getNameSpace().isEmpty()) {
-            logger.info(String.format("The Namespace %s has been bound to this Vault instance. Please keep this in mind when running operations.", this.vaultConfig.getNameSpace()));
+            logger.info(String.format(
+                    "The Namespace %s has been bound to this Vault instance. Please keep this in mind when running operations.",
+                    this.vaultConfig.getNameSpace()));
         }
     }
 
     /**
      * Construct a Vault driver instance with the provided config settings.
      *
-     * @param vaultConfig             Configuration settings for Vault interaction (e.g. server address, token, etc)
-     *                                If the Secrets engine version path map is not provided, or does not contain the
-     *                                requested secret, fall back to the global version supplied.
-     * @param useSecretsEnginePathMap Whether to use a provided KV Engine version map from the Vault config, or generate one.
-     *                                If a secrets KV Engine version map is not supplied, use Vault APIs to determine the
-     *                                KV Engine version for each secret. This call requires admin rights.
-     * @param globalFallbackVersion   The Integer version of the KV Engine to use as a global fallback.
-     *
-     * @throws VaultException         If any error occurs
+     * @param vaultConfig Configuration settings for Vault interaction (e.g. server address, token,
+     * etc) If the Secrets engine version path map is not provided, or does not contain the
+     * requested secret, fall back to the global version supplied.
+     * @param useSecretsEnginePathMap Whether to use a provided KV Engine version map from the Vault
+     * config, or generate one. If a secrets KV Engine version map is not supplied, use Vault APIs
+     * to determine the KV Engine version for each secret. This call requires admin rights.
+     * @param globalFallbackVersion The Integer version of the KV Engine to use as a global
+     * fallback.
+     * @throws VaultException If any error occurs
      */
-    public Vault(final VaultConfig vaultConfig, final Boolean useSecretsEnginePathMap, final Integer globalFallbackVersion)
+    public Vault(final VaultConfig vaultConfig, final Boolean useSecretsEnginePathMap,
+            final Integer globalFallbackVersion)
             throws VaultException {
         this.vaultConfig = vaultConfig;
         if (this.vaultConfig.getNameSpace() != null && !this.vaultConfig.getNameSpace().isEmpty()) {
-            logger.info(String.format("The Namespace %s has been bound to this Vault instance. Please keep this in mind when running operations.", this.vaultConfig.getNameSpace()));
+            logger.info(String.format(
+                    "The Namespace %s has been bound to this Vault instance. Please keep this in mind when running operations.",
+                    this.vaultConfig.getNameSpace()));
         }
         this.vaultConfig.setEngineVersion(globalFallbackVersion);
         if (useSecretsEnginePathMap && this.vaultConfig.getSecretsEnginePathMap().isEmpty()) {
             try {
-                logger.info("No secrets Engine version map was supplied, attempting to generate one.");
+                logger.info(
+                        "No secrets Engine version map was supplied, attempting to generate one.");
                 final Map<String, String> secretsEnginePathMap = collectSecretEngineVersions();
                 assert secretsEnginePathMap != null;
                 this.vaultConfig.getSecretsEnginePathMap().putAll(secretsEnginePathMap);
             } catch (Exception e) {
-                throw new VaultException(String.format("An Engine KV version map was not supplied, and unable to determine " +
-                        "KV Engine " +
-                        "version, " + "due to exception: %s", e.getMessage() + ". Do you have admin rights?"));
+                throw new VaultException(String.format(
+                        "An Engine KV version map was not supplied, and unable to determine " +
+                                "KV Engine " +
+                                "version, " + "due to exception: %s",
+                        e.getMessage() + ". Do you have admin rights?"));
             }
         }
     }
@@ -133,8 +151,10 @@ public Vault(final VaultConfig vaultConfig, final Boolean useSecretsEnginePathMa
      * This method is chained ahead of endpoints (e.g. <code>logical()</code>, <code>auth()</code>,
      * etc... to specify retry rules for any API operations invoked on that endpoint.
      *
-     * @param maxRetries                The number of times that API operations will be retried when a failure occurs
-     * @param retryIntervalMilliseconds The number of milliseconds that the driver will wait in between retries
+     * @param maxRetries The number of times that API operations will be retried when a failure
+     * occurs
+     * @param retryIntervalMilliseconds The number of milliseconds that the driver will wait in
+     * between retries
      * @return This object, with maxRetries and retryIntervalMilliseconds populated
      */
     public Vault withRetries(final int maxRetries, final int retryIntervalMilliseconds) {
@@ -153,7 +173,8 @@ public Logical logical() {
     }
 
     /**
-     * Returns the implementing class for operations on Vault's <code>/v1/auth/*</code> REST endpoints
+     * Returns the implementing class for operations on Vault's <code>/v1/auth/*</code> REST
+     * endpoints
      *
      * @return The implementing class for Vault's auth operations.
      */
@@ -162,7 +183,8 @@ public Auth auth() {
     }
 
     /**
-     * Returns the implementing class for Vault's PKI secret backend (i.e. <code>/v1/pki/*</code> REST endpoints).
+     * Returns the implementing class for Vault's PKI secret backend (i.e. <code>/v1/pki/*</code>
+     * REST endpoints).
      *
      * @return The implementing class for Vault's PKI secret backend.
      */
@@ -171,10 +193,11 @@ public Pki pki() {
     }
 
     /**
-     * <p>Returns the implementing class for Vault's PKI secret backend, using a custom path when that backend is
-     * mounted on something other than the default (i.e. <code>/v1/pki</code>).</p>
+     * <p>Returns the implementing class for Vault's PKI secret backend, using a custom path when
+     * that backend is mounted on something other than the default (i.e. <code>/v1/pki</code>).</p>
      *
-     * <p>For instance, if your PKI backend is instead mounted on <code>/v1/root-ca</code>, then <code>"root-ca"</code>
+     * <p>For instance, if your PKI backend is instead mounted on <code>/v1/root-ca</code>, then
+     * <code>"root-ca"</code>
      * would be passed via the <code>mountPath</code> parameter.  Example usage:</p>
      *
      * <blockquote>
@@ -187,16 +210,21 @@ public Pki pki() {
      * }</pre>
      * </blockquote>
      *
-     * @param mountPath The path on which your Vault PKI backend is mounted, without the <code>/v1/</code> prefix
+     * @param mountPath The path on which your Vault PKI backend is mounted, without the
+     * <code>/v1/</code> prefix
      * @return The implementing class for Vault's PKI secret backend.
      */
     public Pki pki(final String mountPath) {
         return new Pki(vaultConfig, mountPath);
     }
 
-    public Database database() { return new Database(vaultConfig); }
+    public Database database() {
+        return new Database(vaultConfig);
+    }
 
-    public Database database(final String mountPath) { return new Database(vaultConfig, mountPath); }
+    public Database database(final String mountPath) {
+        return new Database(vaultConfig, mountPath);
+    }
 
     /**
      * Returns the implementing class for Vault's lease operations (e.g. revoke, revoke-prefix).
@@ -217,7 +245,8 @@ public Debug debug() {
     }
 
     /**
-     * Returns the implementing class for Vault's sys mounts operations (i.e. <code>/v1/sys/mounts/*</code> REST endpoints).
+     * Returns the implementing class for Vault's sys mounts operations (i.e.
+     * <code>/v1/sys/mounts/*</code> REST endpoints).
      *
      * @return the implementing class for Vault's sys mounts operations
      */
@@ -235,17 +264,21 @@ public Seal seal() {
     }
 
     /**
-     * Makes a REST call to Vault, to collect information on which secret engine version (if any) is used by each available
-     * mount point.  Possibilities are:
+     * Makes a REST call to Vault, to collect information on which secret engine version (if any) is
+     * used by each available mount point.  Possibilities are:
      *
      * <ul>
-     * <li>"2" - A mount point running on Vault 0.10 or higher, configured to use the engine 2 API</li>
-     * <li>"1" - A mount point running on Vault 0.10 or higher, configured to use the engine 1 API</li>
-     * <li>"unknown" - A mount point running on an older version of Vault.  Can more or less be treated as "1".</li>
+     *     <li>"2" - A mount point running on Vault 0.10 or higher, configured to use the engine 2
+     *     API</li>
+     *     <li>"1" - A mount point running on Vault 0.10 or higher, configured to use the engine 1
+     *     API</li>
+     *     <li>"unknown" - A mount point running on an older version of Vault.  Can more or less be
+     *     treated as "1".</li>
      * </ul>
      * <p>
-     * IMPORTANT:  Whichever authentication mechanism is being used with the <code>VaultConfig</code> object, that principal
-     * needs permission to access the <code>/v1/sys/mounts</code> REST endpoint.
+     * IMPORTANT:  Whichever authentication mechanism is being used with the
+     * <code>VaultConfig</code> object, that principal needs permission to access the
+     * <code>/v1/sys/mounts</code> REST endpoint.
      *
      * @return A map of mount points (e.g. "/secret") to secret engine version numbers (e.g. "2")
      */
@@ -283,7 +316,9 @@ private Map<String, String> collectSecretEngineVersions() {
             }
             return data;
         } catch (RestException e) {
-            System.err.print(String.format("Unable to retrieve the KV Engine secrets, due to exception: %s", e.getMessage()));
+            System.err.print(
+                    String.format("Unable to retrieve the KV Engine secrets, due to exception: %s",
+                            e.getMessage()));
             return null;
         }
     }