Add "dry run" parameter to validate (#16)

Author: kkorotkov

NetLicensingClient/src/main/java/com/labs64/netlicensing/domain/Constants.java

@@ -207,6 +207,10 @@ public static final class Shop {
         public static final String PROP_SHOPPING_CART = "shopping-cart";
     }
 
+    public static final class Validation {
+        public static final String DRY_RUN = "dryRun";
+    }
+
     public static final class ValidationResult {
         public static final String VALIDATION_RESULT_TYPE = "ProductModuleValidation";
         public static final int DEFAULT_TTL_MINUTES = 60 * 24; // 1 day

NetLicensingClient/src/main/java/com/labs64/netlicensing/domain/vo/ValidationParameters.java

@@ -8,6 +8,7 @@ public class ValidationParameters {
     private String productNumber;
     private String licenseeName;
     private String licenseeSecret;
+    private Boolean dryRun;
     private Map<String, Map<String, String>> parameters;
 
     /**
@@ -26,7 +27,7 @@ public String getProductNumber() {
 
     /**
      * Sets the name for the new licensee
-     * 
+     *
      * @param licenseeName
      *            optional human-readable licensee name in case licensee will be auto-created. This parameter must not
      *            be the name, but can be used to store any other useful string information with new licensees, up to
@@ -42,7 +43,7 @@ public String getLicenseeName() {
 
     /**
      * Sets the licensee secret
-     * 
+     *
      * @param licenseeSecret
      *            licensee secret stored on the client side. Refer to Licensee Secret documentation for details.
      */
@@ -54,6 +55,20 @@ public String getLicenseeSecret() {
         return licenseeSecret;
     }
 
+    /**
+     * Sets the "dry run" mode
+     *
+     * @param dryRun
+     *            if "true", validation will be executed in "dry run" mode, i.e. no modifications to any licenses.
+     */
+    public void setDryRun(final Boolean dryRun) {
+        this.dryRun = dryRun;
+    }
+
+    public Boolean isDryRun() {
+        return dryRun;
+    }
+
     public Map<String, Map<String, String>> getParameters() {
         if (parameters == null) {
             parameters = new HashMap<>();

NetLicensingClient/src/main/java/com/labs64/netlicensing/service/ValidationService.java

@@ -76,7 +76,7 @@ public static ValidationResult validate(final Context context, final String numb
     public static Netlicensing retrieveValidationFile(final Context context, final String number,
             final ValidationParameters validationParameters) throws NetLicensingException {
         CheckUtils.paramNotEmpty(number, "number");
-        Form form = convertValidationParameters(validationParameters);
+        final Form form = convertValidationParameters(validationParameters);
         final NetLicensingService service = NetLicensingService.getInstance();
         return service.request(context, HttpMethod.POST,
                 Constants.Licensee.ENDPOINT_PATH + "/" + number + "/" + Constants.Licensee.ENDPOINT_PATH_VALIDATE, form,
@@ -113,6 +113,9 @@ private static Form convertValidationParameters(final ValidationParameters valid
             if (StringUtils.isNotBlank(validationParameters.getLicenseeSecret())) {
                 form.param(Constants.Licensee.PROP_LICENSEE_SECRET, validationParameters.getLicenseeSecret());
             }
+            if (Boolean.TRUE.equals(validationParameters.isDryRun())) {
+                form.param(Constants.Validation.DRY_RUN, Boolean.TRUE.toString());
+            }
             int pmIndex = 0;
             for (final Entry<String, Map<String, String>> productModuleValidationParams : validationParameters
                     .getParameters().entrySet()) {