Devesh/sk 2814 java public interface cleanup

.cspell.json

@@ -92,7 +92,13 @@
     "behaviours",
     "sanitisation",
     "recognised",
-    "unrecognised"
+    "unrecognised",
+    "nocreds",
+    "nodir",
+    "detok",
+    "qhdmceurtnlz",
+    "ngrok",
+    "obac"
   ],
   "languageSettings": [
     {

docs/migrate_to_v2.md

@@ -277,6 +277,7 @@ The following instance methods have been renamed for consistency. The old names
 |---|---|
 | `skyflowClient.updateLogLevel(logLevel)` | `skyflowClient.setLogLevel(logLevel)` |
 | `TokenMode.getBYOT()` | `TokenMode.getByot()` |
+| `DetokenizeRequest.builder().downloadURL(b)` | `DetokenizeRequest.builder().downloadUrl(b)` |
 
 ---
 

pom.xml

@@ -184,6 +184,14 @@
                 <version>3.2.5</version>
                 <configuration>
                     <useModulePath>false</useModulePath>
+                    <argLine>
+                        @{argLine}
+                        --add-opens java.base/java.lang=ALL-UNNAMED
+                        --add-opens java.base/java.net=ALL-UNNAMED
+                        --add-opens java.base/java.util=ALL-UNNAMED
+                        --add-opens java.base/java.io=ALL-UNNAMED
+                        --add-opens java.base/sun.net.www.protocol.https=ALL-UNNAMED
+                    </argLine>
                     <includes>
                         <include>**/*Test.java</include>
                         <include>**/*Tests.java</include>

samples/src/main/java/com/example/vault/deprecated/DetokenizeExample.java

@@ -0,0 +1,69 @@
+package com.example.vault.deprecated;
+
+import com.skyflow.Skyflow;
+import com.skyflow.config.Credentials;
+import com.skyflow.config.VaultConfig;
+import com.skyflow.enums.Env;
+import com.skyflow.enums.LogLevel;
+import com.skyflow.enums.RedactionType;
+import com.skyflow.errors.SkyflowException;
+import com.skyflow.vault.tokens.DetokenizeData;
+import com.skyflow.vault.tokens.DetokenizeRequest;
+import com.skyflow.vault.tokens.DetokenizeResponse;
+
+import java.util.ArrayList;
+
+/**
+ * @deprecated Pre-v2.1 pattern. The {@code downloadURL()} builder method is deprecated.
+ * Use {@code downloadUrl()} instead (see {@link com.example.vault.DetokenizeExample}).
+ *
+ * This example is retained for reference during the deprecation window.
+ * {@code downloadURL()} still works but emits a runtime warning and will be removed in a future release.
+ */
+@Deprecated
+public class DetokenizeExample {
+    @SuppressWarnings("deprecation")
+    public static void main(String[] args) throws SkyflowException {
+        // Step 1: Set up Skyflow credentials
+        Credentials credentials = new Credentials();
+        credentials.setToken("<YOUR_BEARER_TOKEN>"); // Replace with the actual bearer token
+
+        // Step 2: Configure the vault
+        VaultConfig vaultConfig = new VaultConfig();
+        vaultConfig.setVaultId("<YOUR_VAULT_ID_1>");
+        vaultConfig.setClusterId("<YOUR_CLUSTER_ID_1>");
+        vaultConfig.setEnv(Env.PROD);
+        vaultConfig.setCredentials(credentials);
+
+        // Step 3: Set up credentials for the Skyflow client
+        Credentials skyflowCredentials = new Credentials();
+        skyflowCredentials.setCredentialsString("<YOUR_CREDENTIALS_STRING>");
+
+        // Step 4: Create a Skyflow client
+        Skyflow skyflowClient = Skyflow.builder()
+                .setLogLevel(LogLevel.ERROR)
+                .addVaultConfig(vaultConfig)
+                .addSkyflowCredentials(skyflowCredentials)
+                .build();
+
+        // Step 5: Detokenize with deprecated downloadURL()
+        // DEPRECATED: use downloadUrl(true) instead of downloadURL(true)
+        try {
+            ArrayList<DetokenizeData> detokenizeData = new ArrayList<>();
+            detokenizeData.add(new DetokenizeData("<YOUR_TOKEN_VALUE_1>", RedactionType.MASKED));
+            detokenizeData.add(new DetokenizeData("<YOUR_TOKEN_VALUE_2>"));
+
+            DetokenizeRequest request = DetokenizeRequest.builder()
+                    .detokenizeData(detokenizeData)
+                    .continueOnError(true)
+                    .downloadURL(true) // @deprecated — use downloadUrl(true)
+                    .build();
+
+            DetokenizeResponse response = skyflowClient.vault().detokenize(request);
+            System.out.println("Detokenize Response: " + response);
+        } catch (SkyflowException e) {
+            System.out.println("Error during detokenization:");
+            e.printStackTrace();
+        }
+    }
+}

samples/src/main/java/com/example/vault/deprecated/GetExample.java

@@ -0,0 +1,76 @@
+package com.example.vault.deprecated;
+
+import com.skyflow.Skyflow;
+import com.skyflow.config.Credentials;
+import com.skyflow.config.VaultConfig;
+import com.skyflow.enums.Env;
+import com.skyflow.enums.LogLevel;
+import com.skyflow.enums.RedactionType;
+import com.skyflow.errors.SkyflowException;
+import com.skyflow.vault.data.GetRequest;
+import com.skyflow.vault.data.GetResponse;
+
+import java.util.ArrayList;
+import java.util.HashMap;
+
+/**
+ * @deprecated Pre-v2.1 pattern. The {@code "skyflow_id"} key in the response record map is deprecated.
+ * Use {@code "skyflowId"} instead (see {@link com.example.vault.GetExample}).
+ *
+ * This example is retained for reference during the deprecation window.
+ * Both {@code "skyflow_id"} and {@code "skyflowId"} are present in the response map until
+ * {@code "skyflow_id"} is removed in a future release.
+ */
+@Deprecated
+public class GetExample {
+    public static void main(String[] args) throws SkyflowException {
+        // Step 1: Set up credentials
+        Credentials credentials = new Credentials();
+        credentials.setCredentialsString("<YOUR_CREDENTIALS_STRING_1>");
+
+        // Step 2: Configure the vault
+        VaultConfig vaultConfig = new VaultConfig();
+        vaultConfig.setVaultId("<YOUR_VAULT_ID_1>");
+        vaultConfig.setClusterId("<YOUR_CLUSTER_ID_1>");
+        vaultConfig.setEnv(Env.PROD);
+        vaultConfig.setCredentials(credentials);
+
+        // Step 3: Set up credentials for the Skyflow client
+        Credentials skyflowCredentials = new Credentials();
+        skyflowCredentials.setCredentialsString("<YOUR_CREDENTIALS_STRING_2>");
+
+        // Step 4: Create a Skyflow client
+        Skyflow skyflowClient = Skyflow.builder()
+                .setLogLevel(LogLevel.ERROR)
+                .addVaultConfig(vaultConfig)
+                .addSkyflowCredentials(skyflowCredentials)
+                .build();
+
+        // Example: Fetch records and read the Skyflow ID using the deprecated "skyflow_id" key
+        // DEPRECATED: the response map contains both "skyflow_id" and "skyflowId".
+        //             Access "skyflowId" instead — "skyflow_id" will be removed in a future release.
+        try {
+            ArrayList<String> ids = new ArrayList<>();
+            ids.add("<YOUR_SKYFLOW_ID>");
+
+            GetRequest request = GetRequest.builder()
+                    .ids(ids)
+                    .table("<TABLE_NAME>")
+                    .redactionType(RedactionType.PLAIN_TEXT)
+                    .build();
+
+            GetResponse response = skyflowClient.vault().get(request);
+
+            // DEPRECATED: reading "skyflow_id" from the response map
+            for (HashMap<String, Object> record : response.getData()) {
+                String deprecatedId = (String) record.get("skyflow_id"); // @deprecated — use "skyflowId"
+                String preferredId  = (String) record.get("skyflowId");  // preferred
+                System.out.println("skyflow_id (deprecated): " + deprecatedId);
+                System.out.println("skyflowId  (preferred) : " + preferredId);
+            }
+        } catch (SkyflowException e) {
+            System.out.println("Error during fetch:");
+            e.printStackTrace();
+        }
+    }
+}

samples/src/main/java/com/example/vault/deprecated/UpdateExample.java

@@ -13,14 +13,18 @@
 import java.util.HashMap;
 
 /**
- * @deprecated Pre-v2.1 pattern. The "skyflow_id" key in the data map is deprecated.
- * Use "skyflowId" instead (see {@link com.example.vault.UpdateExample}).
+ * @deprecated Pre-v2.1 pattern. Demonstrates two deprecated APIs:
+ * <ul>
+ *   <li>The {@code "skyflow_id"} key in the data map — use {@code "skyflowId"} instead.</li>
+ *   <li>{@code updateLogLevel()} on the Skyflow client — use {@code setLogLevel()} instead.</li>
+ * </ul>
+ * See {@link com.example.vault.UpdateExample} for the current pattern.
  *
- * This example is retained for reference during the deprecation window.
- * "skyflow_id" still works but emits a runtime warning and will be removed in a future release.
+ * Both still work but emit runtime warnings and will be removed in a future release.
  */
 @Deprecated
 public class UpdateExample {
+    @SuppressWarnings("deprecation")
     public static void main(String[] args) throws SkyflowException {
         // Step 1: Set up credentials for the first vault configuration
         Credentials credentials = new Credentials();
@@ -38,11 +42,12 @@ public static void main(String[] args) throws SkyflowException {
         skyflowCredentials.setCredentialsString("<YOUR_CREDENTIALS_STRING>"); // Replace with the actual credentials string
 
         // Step 4: Create a Skyflow client and add vault configurations
+        // DEPRECATED: use setLogLevel() instead of updateLogLevel()
         Skyflow skyflowClient = Skyflow.builder()
-                .setLogLevel(LogLevel.ERROR) // Enable debugging for detailed logs
-                .addVaultConfig(vaultConfig)      // Add the vault configuration
-                .addSkyflowCredentials(skyflowCredentials) // Add general Skyflow credentials
+                .addVaultConfig(vaultConfig)
+                .addSkyflowCredentials(skyflowCredentials)
                 .build();
+        skyflowClient.updateLogLevel(LogLevel.ERROR); // @deprecated — use setLogLevel(LogLevel.ERROR)
 
         // Step 5: Update records with TokenMode enabled
         // DEPRECATED: use "skyflowId" key instead of "skyflow_id"

src/main/java/com/skyflow/ConnectionClient.java

@@ -86,6 +86,8 @@ private void prioritiseCredentials() throws SkyflowException {
         } catch (DotenvException e) {
             throw new SkyflowException(ErrorCode.INVALID_INPUT.getCode(),
                     ErrorMessage.EmptyCredentials.getMessage());
+        } catch (SkyflowException e) {
+            throw e;
         } catch (Exception e) {
             throw new RuntimeException(e);
         }

src/main/java/com/skyflow/VaultClient.java

@@ -876,6 +876,8 @@ private void prioritiseCredentials() throws SkyflowException {
         } catch (DotenvException e) {
             throw new SkyflowException(ErrorCode.INVALID_INPUT.getCode(),
                     ErrorMessage.EmptyCredentials.getMessage());
+        } catch (SkyflowException e) {
+            throw e;
         } catch (Exception e) {
             throw new RuntimeException(e);
         }

src/main/java/com/skyflow/logs/InfoLogs.java

@@ -101,7 +101,10 @@ public enum InfoLogs {
     DEPRECATED_SKYFLOW_ID_REQUEST_KEY("[DEPRECATED] Request data key 'skyflow_id' is deprecated and will be removed in an upcoming release. Use 'skyflowId' instead."),
     DEPRECATED_DOWNLOAD_URL("[DEPRECATED] Method 'downloadURL()' is deprecated and will be removed in an upcoming release. Use 'downloadUrl()' instead."),
     DEPRECATED_GET_BYOT("[DEPRECATED] Method 'getBYOT()' is deprecated and will be removed in an upcoming release. Use 'getByot()' instead."),
-    DEPRECATED_UPDATE_LOG_LEVEL("[DEPRECATED] Method 'updateLogLevel()' is deprecated and will be removed in an upcoming release. Use 'setLogLevel()' instead.");
+    DEPRECATED_UPDATE_LOG_LEVEL("[DEPRECATED] Method 'updateLogLevel()' is deprecated and will be removed in an upcoming release. Use 'setLogLevel()' instead."),
+    DEPRECATED_CREDENTIAL_CLIENT_ID("[DEPRECATED] Credential field 'clientID' is deprecated and will be removed in an upcoming release. Use 'clientId' instead."),
+    DEPRECATED_CREDENTIAL_KEY_ID("[DEPRECATED] Credential field 'keyID' is deprecated and will be removed in an upcoming release. Use 'keyId' instead."),
+    DEPRECATED_CREDENTIAL_TOKEN_URI("[DEPRECATED] Credential field 'tokenURI' is deprecated and will be removed in an upcoming release. Use 'tokenUri' instead.");
 
 
 

src/main/java/com/skyflow/serviceaccount/util/BearerToken.java

@@ -108,6 +108,9 @@ private static V1GetAuthTokenResponse getBearerTokenFromCredentials(
             JsonElement clientId = credentials.get("clientId");
             if (clientId == null) {
                 clientId = credentials.get("clientID");
+                if (clientId != null) {
+                    LogUtil.printWarningLog(InfoLogs.DEPRECATED_CREDENTIAL_CLIENT_ID.getLog());
+                }
             }
             if (clientId == null) {
                 LogUtil.printErrorLog(ErrorLogs.CLIENT_ID_IS_REQUIRED.getLog());
@@ -117,6 +120,9 @@ private static V1GetAuthTokenResponse getBearerTokenFromCredentials(
             JsonElement keyId = credentials.get("keyId");
             if (keyId == null) {
                 keyId = credentials.get("keyID");
+                if (keyId != null) {
+                    LogUtil.printWarningLog(InfoLogs.DEPRECATED_CREDENTIAL_KEY_ID.getLog());
+                }
             }
             if (keyId == null) {
                 LogUtil.printErrorLog(ErrorLogs.KEY_ID_IS_REQUIRED.getLog());
@@ -126,6 +132,9 @@ private static V1GetAuthTokenResponse getBearerTokenFromCredentials(
             JsonElement tokenUri = credentials.get("tokenUri");
             if (tokenUri == null) {
                 tokenUri = credentials.get("tokenURI");
+                if (tokenUri != null) {
+                    LogUtil.printWarningLog(InfoLogs.DEPRECATED_CREDENTIAL_TOKEN_URI.getLog());
+                }
             }
             if (tokenUri == null) {
                 LogUtil.printErrorLog(ErrorLogs.TOKEN_URI_IS_REQUIRED.getLog());

src/main/java/com/skyflow/serviceaccount/util/SignedDataTokens.java

@@ -109,6 +109,9 @@ private static List<SignedDataTokenResponse> generateSignedTokensFromCredentials
             JsonElement clientId = credentials.get("clientId");
             if (clientId == null) {
                 clientId = credentials.get("clientID");
+                if (clientId != null) {
+                    LogUtil.printWarningLog(InfoLogs.DEPRECATED_CREDENTIAL_CLIENT_ID.getLog());
+                }
             }
             if (clientId == null) {
                 LogUtil.printErrorLog(ErrorLogs.CLIENT_ID_IS_REQUIRED.getLog());
@@ -118,6 +121,9 @@ private static List<SignedDataTokenResponse> generateSignedTokensFromCredentials
             JsonElement keyId = credentials.get("keyId");
             if (keyId == null) {
                 keyId = credentials.get("keyID");
+                if (keyId != null) {
+                    LogUtil.printWarningLog(InfoLogs.DEPRECATED_CREDENTIAL_KEY_ID.getLog());
+                }
             }
             if (keyId == null) {
                 LogUtil.printErrorLog(ErrorLogs.KEY_ID_IS_REQUIRED.getLog());

src/main/java/com/skyflow/utils/validations/Validations.java

@@ -968,7 +968,7 @@ public static void validateDeidentifyFileRequest(DeidentifyFileRequest request)
         if (request.getWaitTime() != null && request.getWaitTime() <= 0) {
             throw new SkyflowException(ErrorCode.INVALID_INPUT.getCode(), ErrorMessage.InvalidWaitTime.getMessage());
         }
-        if(request.getWaitTime() > 64) {
+        if(request.getWaitTime() != null && request.getWaitTime() > 64) {
             throw new SkyflowException(ErrorCode.INVALID_INPUT.getCode(), ErrorMessage.WaitTimeExceedsLimit.getMessage());
         }
     }

src/main/java/com/skyflow/vault/controller/VaultController.java

@@ -238,7 +238,7 @@ public InsertResponse insert(InsertRequest insertRequest) throws SkyflowExceptio
             return new InsertResponse(null, errorFields.isEmpty() ? null : errorFields);
         }
         if (errorFields.isEmpty()) {
-            return new InsertResponse(insertedFields.isEmpty() ? null : insertedFields, null);
+            return new InsertResponse(insertedFields, null);
         }
         return new InsertResponse(insertedFields, errorFields);
     }