Adding the ability to not treat 4xx response codes as errors that should be retried and converted into exceptions

Author: Barry Klawans

src/main/java/com/bettercloud/vault/VaultConfig.java

@@ -40,6 +40,7 @@ public class VaultConfig implements Serializable {
     private int retryIntervalMilliseconds;
     private Integer globalEngineVersion;
     private String nameSpace;
+    private Boolean treatInvalidRequestsAsErrors = true;
     private EnvironmentLoader environmentLoader;
 
     /**
@@ -207,6 +208,26 @@ public VaultConfig readTimeout(final Integer readTimeout) {
         return this;
     }
 
+    /**
+     * <p>Specifies whether 4xx class status codes should be treated as errors or invalid calls.</p>
+     *
+     * <p>If 4xx status codes are treated as errors, any call that returns them will retry (if specified)
+     * and will result in an exception being thrown.  If disabled, a 4xx return code does not retry, does
+     * not generate an exception, and instead returns the error in the response body</p>
+     *
+     * <p>If you set this to <code>false</code> you need to check the response code before using the data
+     * in a response</p>
+     *
+     * <p>The default behavior is to treat 4xx status codes as errors.</p>
+     *
+     * @param treatInvalidRequestsAsErrors Should 4xx class status codes be treated as errors.
+     * @return This object, with treatInvalidRequestsAsErrors populated, ready for additional builder-pattern method calls or else finalization with the build() method
+     */
+    public VaultConfig treatInvalidRequestsAsErrors(final Boolean treatInvalidRequestsAsErrors) {
+        this.treatInvalidRequestsAsErrors = treatInvalidRequestsAsErrors;
+        return this;
+    }
+
     /**
      * <p>Sets the maximum number of times that an API operation will retry upon failure.</p>
      *
@@ -314,6 +335,10 @@ public Integer getReadTimeout() {
         return readTimeout;
     }
 
+    public Boolean isTreatInvalidRequestsAsErrors() {
+        return treatInvalidRequestsAsErrors;
+    }
+
     public int getMaxRetries() {
         return maxRetries;
     }

src/main/java/com/bettercloud/vault/api/Logical.java

@@ -92,7 +92,7 @@ private LogicalResponse read(final String path, Boolean shouldRetry, final logic
                         .get();
 
                 // Validate response
-                if (restResponse.getStatus() != 200) {
+                if (restResponse.getStatus() != 200 && !(!config.isTreatInvalidRequestsAsErrors() && restResponse.getStatus() >= 400 && restResponse.getStatus() < 500)) {
                     throw new VaultException("Vault responded with HTTP status code: " + restResponse.getStatus()
                             + "\nResponse body: " + new String(restResponse.getBody(), StandardCharsets.UTF_8),
                             restResponse.getStatus());
@@ -161,7 +161,7 @@ public LogicalResponse read(final String path, Boolean shouldRetry, final Intege
                         .get();
 
                 // Validate response
-                if (restResponse.getStatus() != 200) {
+                if (restResponse.getStatus() != 200 && !(!config.isTreatInvalidRequestsAsErrors() && restResponse.getStatus() >= 400 && restResponse.getStatus() < 500)) {
                     throw new VaultException("Vault responded with HTTP status code: " + restResponse.getStatus()
                             + "\nResponse body: " + new String(restResponse.getBody(), StandardCharsets.UTF_8),
                             restResponse.getStatus());
@@ -261,7 +261,7 @@ private LogicalResponse write(final String path, final Map<String, Object> nameV
 
                 // HTTP Status should be either 200 (with content - e.g. PKI write) or 204 (no content)
                 final int restStatus = restResponse.getStatus();
-                if (restStatus == 200 || restStatus == 204) {
+                if (restStatus == 200 || restStatus == 204 || (!config.isTreatInvalidRequestsAsErrors() && restResponse.getStatus() >= 400 && restResponse.getStatus() < 500)) {
                     return new LogicalResponse(restResponse, retryCount, operation);
                 } else {
                     throw new VaultException("Expecting HTTP status 204 or 200, but instead receiving " + restStatus

src/test/java/com/bettercloud/vault/VaultConfigTests.java

@@ -256,4 +256,12 @@ public void testConfigBuilder_WithNamespace() throws VaultException {
         Assert.assertEquals(vaultConfig.getNameSpace(), "namespace");
     }
 
+    @Test
+    public void testConfigBuiler_WithInvalidRequestAsNonError() throws VaultException {
+        VaultConfig vaultConfig = new VaultConfig().address("address").token("token").treatInvalidRequestsAsErrors(false).build();
+        assertEquals("address", vaultConfig.getAddress());
+        assertEquals("token", vaultConfig.getToken());
+        assertEquals(Boolean.FALSE, vaultConfig.isTreatInvalidRequestsAsErrors());
+
+    }
 }